Hierarchical Value Service API  future
api index

ScaleBreak Object

since: future
A scale break consisting of a threshold value and a matching offset to apply when scaling a value according to a scale structure.

Fields

threshold
futureoptional
decimal
The threshold value for this scale break. The value is stored as a scalar value, and any units or currency associated with it is stored in the scale structure itself in ScaleStructure.currency or ScaleStructure.units. The type of threshold value is determined by the ScaleStructure.type of the scale structure.
future default value: 0
offset
futureoptional
decimal
The offset value for this scale break. The value is stored as a scalar value, and any currency associated with it is stored in the scale structure itself in ScaleStructure.offsetCurrency. The type of offset is determined by the ScaleStructure.offsetType of the scale structure.
future default value: 0

Related API Objects

Example - Example scale break

    {
        "threshold": 10,
        "offset": -1.25
    }