Available translations

Time Scale

foundations.png
time-scale.png
The time scale controls the scale of the horizontal axis, that is, the timeline of the corresponding time machine, and of all of the timeline charts within it.
Content
Scale Minimum and Maximum Values
A time scale has a minimum and a maximum value. The minimum value is the value at the left border of the chart. The maximum, is the value at the right border of the chart.
In technical terms, the minimum and maximum scale values are constantly changing as, whenever you pan across the charts, you are directly affecting the minimum and maximum scale values. That said, the actual scale doesn't change when panning across a chart.
Automatic Scale
The system features an automatic adjustment of the scale, which is turned on by default in some of the Plugin Workspaces. The scale may be automatic in its minimum value, in its maximum value, in both, or none (manual mode).
  • When the scale is automatic in the minimum value, the scale is adjusted so that the chart shows all data from the beginning of the market. Panning the charts under such setting has the effect of compressing and decompressing the data against the left border of the chart.
  • When the scale is automatic in the maximum value, the scale is adjusted so that the chart shows all data until the end of the market. In such case, panning the charts has the effect of compressing and decompressing the data against the right border of the chart.
  • When the scale is automatic in both the minimum and maximum value, the scale is adjusted so that the chart shows the whole market. In such case, when you click and drag to pan the charts, the settings turns back to manual on both ends of the chart.
Manual Scale
The scale features a manual mode. When in manual mode the scale does not change, even if the minimum and maximum values change while panning through a chart. This is the natural state of the time scale.
Charts
Time Scale at the Charts
Automatic Scale
To change the automatic scale settings, place the mouse pointer over the corresponding time box, press the Shift key and slowly scroll the wheel of the mouse.
If you run into issues using the mouse wheel (certain OS + browser + mouse combinations may not work as expected), you may also point the mouse at the scale box and use to toggle through the different automatic modes.
  • A triangle pointing right means that the maximum value of the scale is automatic.
  • A triangle pointing left means that the minimum value of the scale is automatic.
  • Both triangles present at the same time means that both minimum and maximum values are automatic.
  • No triangle means that both minimum and maximum values are in manual mode.
Manual Scale
To adjust the scale, make sure either or both minimum and maximum values are in manual mode. Place the mouse pointer over the time box and scroll the wheel of the mouse. The scale will increase or decrease accordingly, depending on which values are set to manual.
Notice that, while changing the scale, a number is displayed replacing the actual datetime. This is a reference value of the scale, that may serve for comparison purposes, with scales in other charts.
Configuring
Time Scale Configuration
Properties
  • minValue is a date in the Epoch time format that represents the value of the scale at the left border of the chart.
  • maxValue is a date in the Epoch time format that represents the value of the scale at the right border of the chart.
  • autoMinScale sets the mode of the scale for the minimum value; true sets the value to automatic, false sets the value to manual.
  • autoMaxScale sets the mode of the scale for the maximum value; true sets the value to automatic, false sets the value to manual.
Initial Values
These are the Initial Values for Time Scale configuration:
 {
    "autoMinScale": true,
    "autoMaxScale": true,
    "fromDate": "2018-01-01",
    "toDate": "2020-12-31"
}
Examples
This is a list of properties featured by the Time Scale configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
Time Scale Menu
The Time Scale node has the following Node Menu items:
The Configure menu item has the following properties:
  • action: Configure
  • label: Configure
  • iconPathOn: configuration
  • iconPathOff: configuration
  • dontShowAtFullscreen: true
  • actionFunction: uiObject.configEditor.activate
The Delete menu item has the following properties:
  • action: Delete UI Object
  • actionProject: Visual-Scripting
  • askConfirmation: true
  • confirmationLabel: Confirm to Delete
  • label: Delete
  • iconPathOn: delete-entity
  • iconPathOff: delete-entity
  • actionFunction: payload.executeAction
Time Scale Attaching Rules
The following are the Node Attaching Rules that govern the attachment of Time Scale with other nodes:
Compatible Types: