126 lines
6.0 KiB
JSON
126 lines
6.0 KiB
JSON
{
|
|
"type": "Tutorial Step",
|
|
"definition": {
|
|
"text": "A tutorial step is a type of node within a tutorial that may not have offspring. As such, it is the smallest unit of information in the hierarchy."
|
|
},
|
|
"paragraphs": [
|
|
{
|
|
"style": "Block",
|
|
"text": "Configuring"
|
|
},
|
|
{
|
|
"style": "Title",
|
|
"text": "Tutorial Step Configuration",
|
|
"updated": 1609706397520
|
|
},
|
|
{
|
|
"style": "Note",
|
|
"text": "The basic configuration of the tutorial step node is the same as the Tutorial node. Refer to the latter, please.",
|
|
"updated": 1613846300336
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "In addition to the basic configuration, tutorial step nodes feature a large collection of resources that allows you to manipulate the user interface and actual nodes in many ways."
|
|
},
|
|
{
|
|
"style": "Subtitle",
|
|
"text": "Navigation",
|
|
"updated": 1609706308531
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "Setting up a reference to any node in the workspace and using the below parameter makes the step load next to the referenced node."
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": " \"positionAtReferenceParent\": true,"
|
|
},
|
|
{
|
|
"style": "Subtitle",
|
|
"text": "Messages",
|
|
"updated": 1613846598199
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "Setting up a reference to any node in the workspace and using the below parameters allows placing different types of messages on the referenced node."
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": "\"setErrorMessageReferenceParent\": \"This is a simulated error message!\"\n\"setInfoMessageReferenceParent\": \"This is a simulated info message!\"\n\"setValueReferenceParent\": \"This is a simulated value message!\"\n\"setPercentageReferenceParent\": \"This is a simulated progress message!\"\n\"setStatusReferenceParent\": \"This is a simulated status message!\"",
|
|
"updated": 1609706430970
|
|
},
|
|
{
|
|
"style": "Subtitle",
|
|
"text": "Centering and Zooming Into a Time Machine",
|
|
"updated": 1609706456866
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "Setting up a reference to a time machine node in the Charting Space hierarchy while using the below parameter causes the following:",
|
|
"updated": 1617706853889
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "The charting space viewport is centered on the referenced time machine."
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "The time machine is adjusted to fit the aspect ratio of the screen."
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "The viewport zooms into the time machine."
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": " \"repositionAtTimeMachineReferenceParent\": true,"
|
|
},
|
|
{
|
|
"style": "Subtitle",
|
|
"text": "Pressing Keys When on a Time Machine",
|
|
"updated": 1609706492050
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "Setting up a reference to a time machine node in the charting space hierarchy and using the below parameters allows replicating the pressing of relevant key combinations when on a time machine.",
|
|
"updated": 1617706916777
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": "\"keyPressedTimeMachineReferenceParent\": {\n\"shiftKey\": true,\n\"ctrlKey\": true,\n\"metaKey\": true,\n\"key\": \"A\"\n}",
|
|
"updated": 1609706515897
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "shiftKey, ctrlKey, and metaKey (Mac OS equivalent to Control) may be true or false."
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "key may be any letter or number."
|
|
},
|
|
{
|
|
"style": "Subtitle",
|
|
"text": "Changing Node's Configurations",
|
|
"updated": 1613846731449
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "The batchConfigChangesReferenceParent property allows you to edit the configuration of a referenced node and their offspring.",
|
|
"updated": 1617707009812
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "The example below changes the configuration of the three different scale nodes under a time machine. In this case, the time machine is the node referenced, the nodePath is the path of the node whose configuration must be changed relative to the referenceParent, and the properties parameter is the actual configuration to be set."
|
|
},
|
|
{
|
|
"style": "Json",
|
|
"text": "\"batchConfigChangesReferenceParent\": [\n {\n \"nodePath\": \"referenceParent.timeScale\",\n \"properties\": {\n \"autoMinScale\": false,\n \"autoMaxScale\": false,\n \"fromDate\": \"2020-08-31T23:40:00.000Z\",\n \"toDate\": \"2020-09-01T01:00:00.000Z\"\n }\n },\n {\n \"nodePath\": \"referenceParent.rateScale\",\n \"properties\": {\n \"autoMinScale\": false,\n \"autoMaxScale\": false,\n \"minValue\": 11400,\n \"maxValue\": 11800\n }\n },\n {\n \"nodePath\": \"referenceParent.timeFrameScale\",\n \"properties\": {\n \"value\": \"01-min\"\n }\n }\n ]",
|
|
"updated": 1617707082553
|
|
},
|
|
{
|
|
"style": "Success",
|
|
"text": "A typical use case for this resource is when you wish to bring to user to a specific point in a chart, but it may be used for any other case that requires manipulating node's configurations.",
|
|
"updated": 1617707174287
|
|
}
|
|
]
|
|
} |