Available translations

Rate Scale

foundations.png
rate-scale.png
The rate scale controls the scale of the vertical axis, that is, the scale of the quoted asset, either of the time machine or of the timeline chart, depending on where the node is located.
Content
Rate scales may exist both at the level of a time machine and at the level of a timeline chart, each affecting the corresponding concept.
When set at the level of the time machine, the scale settings affect all charts within the time machine. When set at the level of the timeline chart, the settings override the rate scale at the time machine level.
Scale Minimum and Maximum Values
A rate scale has a minimum and a maximum value. The minimum value is the value at bottom of the chart. The maximum, is the value at the top of the chart.
In technical terms, the minimum and maximum scale values are constantly changing as, whenever you pan the charts vertically, you are directly affecting the minimum and maximum scale values. That said, the actual scale may change dynamically or not, depending on the scale-automation settings.
Automatic Scale
The system features an automatic adjustment of the scale, which is turned on by default in some of the Native Workspaces. The scale may be automatic in its minimum value, in its maximum value, on both, or on none (manual mode).
  • When the scale is automatic in the minimum value, the scale is adjusted so that no piece of information in the span of the chart ever remains below the bottom of the chart. As a result, the lowest data point aligns with the bottom of the chart.
  • When the scale is automatic in the maximum value, the scale is adjusted so that no piece of information in the span of the chart ever remains above the top of the chart. As a result, the highest data point aligns with the top of the chart.
  • The scale may be automated on either, or both minimum and maximum values at the same time. In the later case, no data point in the span of the chart ever remains out of the visible area of the chart, as the lowest data point aligns with the bottom of the chart and the highest aligns with the top.
Manual Scale
The system also features a manual mode. When in manual mode the scale does not change, even if the minimum and maximum values change while panning across a chart. This design feature allows comparing different periods using the same scale, which may be valuable in many cases.
Scale Offset
The offset is a feature of the rate scale by which the scale may be shifted upwards or downwards. As a result, charts aligned on the vertical axis—synchronized in datetime by a shared time machine—may be put one above the other. In technical terms, what happens is that the scale is shifted upwards or downwards.
Charts
Rate Scale at the Charts
Automatic Scale
To change the automatic scale settings, place the mouse pointer over the corresponding time machine or timeline chart rate box, press the Shift key and slowly scroll the wheel of the mouse. The action cycles through different possible scale automation settings.
You may also place the mouse pointer on the scale box and use the side arrows ← → to toggle through the different automation settings.
  • A triangle pointing up means that the maximum value of the scale is automatic.
  • A triangle pointing down 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 corresponding time machine or timeline chart rate box and scroll the wheel of the mouse. The scale will increase or decrease accordingly, depending on which values are set to manual.
Alternatively, you may also place the mouse pointer on the scale box and use the vertical arrows ↑ ↓ to affect the scale.
Notice that, while changing the scale, a number is displayed replacing the actual rate. This is a reference value of the scale, that may serve for comparison purposes, with scales in other charts.
Scale Offset
To shift or offset a timeline chart on the vertical axis, place the mouse pointer on the rate box, left-click and drag upwards or downwards, as desired. The timeline chart will shift in the specified direction while the remaining charts stay in the same position.
Configuring
Rate Scale Configuration
Properties
  • minValue is a numerical value that represents the value of the scale at the bottom of the chart.
  • maxValue is a numerical value that represents the value of the scale at the top 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 Rate Scale configuration: 
 {
    "autoMinScale": true,
    "autoMaxScale": true,
    "minValue": 0,
    "maxValue": 25000
}
Examples
This is a list of properties featured by the Rate Scale configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
Rate Scale Menu
The Rate 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
Rate Scale Attaching Rules
The following are the Node Attaching Rules that govern the attachment of Rate Scale with other nodes:
Compatible Types: