graph » scale-v

scale-v, scaleV

[ root » graph » scale-v ]

Radar Charts Only: The scaleV object is similar to the scaleY object on x/y-axis charts. (The scaleK object is the radar chart’s scaleX equivalent.) Vertically oriented, it is called the value scale and generally displays quantitative values. Refer to the Radar Charts Tutorial for more information.




AttributeTypeDescription
blendedBooleanTo 'blend' or 'stick' secondary scales to the primary one. Use with the 'placement' attribute (set the value to 'default') and 'offset-start' and 'offset-end' attributes.
Default Value: false
Introduced in: v2.3.0
borderRadius
border-radius
NumberSets the object's border radius for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A single value will affect all 4 corners; multiple values will have separate effects on each corner, with the first value affecting the top-left corner, the second value affecting the top-right corner, and so on, in a clockwise direction. A negative value will cut a corner off without rounding.
Default Value: 0
borderRadiusBottomLeft
border-radius-bottom-left
NumberSets the object's bottom-left border radius for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding.
Default Value: 0
borderRadiusBottomRight
border-radius-bottom-right
NumberSets the object's bottom-right border radius for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding.
Default Value: 0
borderRadiusTopLeft
border-radius-top-left
NumberSets the object's top-left border radius for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding.
Default Value: 0
borderRadiusTopRight
border-radius-top-right
NumberSets the object's top-right border radius for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding.
Default Value: 0
classStringSets a class value on the object.
Default Value: null
dataN
data-n
AnyPrefix attribute or array using "data-" to define a custom token.
decimalsNumberSets the number of decimal places displayed for each value.
Default Value: -1
Chart types: Gauge
decimalsSeparator
decimals-separator
StringSets the separator to be used in place of the default decimal point. Any string or character can be used to replace the decimal.
Default Value: '.'
Chart types: Gauge
defaultValue
default-value
StringSets the default value token values to display until the value is available.
Default Value: null
Chart types: Gauge
exponentBooleanSets whether the scale values will be displayed in scientific notation. Particularly useful when dealing with large numbers.
Default Value: false
Chart types: Gauge
exponentDecimals
exponent-decimals
NumberSets the number of decimals that will be displayed when using scientific notation. Use with the 'exponent' attribute.
Default Value: 2
Chart types: Gauge
formatStringTo format the appearance of the scale values. Use with the %scale-value (%v) token.
Default Value: null
Chart types: Gauge
guideObjectUsed to style the lines and backgrounds behind the plotted data.
Default Value: null
idStringSets the id of the object.
Default Value: ''
itemObject, StringSets the id or style of the item. Sets the item id of the map on which the object/shape is being added (ScaleItem,String). For scales, styles the individual scale labels (ScaleItem).
Default Value: ''
itemsOverlap
items-overlap
BooleanTo force all of the scale items to display. It is generally used with the 'max-items' attribute.
Default Value: false
logBase
log-base
NumberLogarithmic Scales only: To set the base value, which defaults to Math.E (Euler's number, the base of natural logarithms).
Default Value: 10
masterStringSets a master scale. The current scale will always be in sync with it's master scale.
Default Value: ''
maxDecimals
max-decimals
NumberSets the max number of decimals that will be used to format the values.
Default Value: -1
Chart types: Gauge
maxItems
max-items
NumberSets the maximum number of items displayed.
Chart types: Gauge
maxTicks
max-ticks
NumberSets the maximum number of ticks to display on the scale.
Chart types: Gauge
maxValue
max-value
NumberSets the maximum scale value.
mediaRules
media-rules
Array.<Object>Configure media rules.
minValue
min-value
NumberSets the minimum scale value.
Default Value: -1
multiplierBooleanEnables abbreviating large numbers with short units, such as K, M, B, etc..
Default Value: null
negationStringThis attribute will determine how negative values are handled. When using "format":"$%v" setting "negation":"currency" will move the - symbol to the outside of the $ sign. When using "negation" within the "plot": { } object you will see changes in things such as tooltips or anywhere else series data is used to populate values. You need to set "negation" in things such as "scale-y": { } separately.
Accepted Values: ['standard', 'currency']
Default Value: 'standard'
normalizeBooleanApplies roundings to scale boundaries in order to get nicer min/max/step values.
Default Value: true
Chart types: Gauge
offsetNumberSets an offset at the start and end of the plotted data. This will cause the data to appear as if it were 'squeezed'.
Default Value: 0
offsetEnd
offset-end
NumberSets an offset from the end of the plotted data. This will cause the data to appear as if it were 'squeezed' from the right side.
Default Value: 0
offsetStart
offset-start
NumberSets an offset at the start of the plotted data. This will cause the data to appear as if it were 'squeezed' from the left side.
Default Value: 0
offsetX
offset-x
NumberSets an x-offset to apply when positioning the object.
offsetY
offset-y
NumberSets an y-offset to apply when positioning the object.
paddingNumberSets the object's padding around the text. Up to four values can be entered to set the padding for all four sides, with the first value affecting the top padding, the second value affecting the right padding, and so on, in a clockwise direction.
Default Value: null
progressionStringTo change the scale type from linear (default) to logarithmic.
Accepted Values: ['lin', 'linear', 'log']
Default Value: 'lin'
rectShortcut
rect-shortcut
BooleanUsed to force the library to create rectangles using a faster drawing API (instead of painting them like a closed polygon). However, using this would disable effects like rounded borders. It is a performance setting for edge cases.
Default Value: false
refLine
ref-line
ObjectTo style the reference line.
Default Value: null
Chart types: Gauge
refValue
ref-value
NumberTo set the value the reference line is drawn at.
Default Value: 0
Chart types: Gauge
scaleFactor
scale-factor
NumberParameter used to control the range (min/max values) of the scale without forcing fixed values. The parameter will be applied on the pre-calculated min/max values and the result forced on the scale.
Default Value: 1
shortBooleanAutomatically shortens large units (e.g. 1000000 -> 1M)
Default Value: false
Chart types: Gauge
shortUnit
short-unit
StringSpecifies which unit of measure to use when `short` is set to true.
Accepted Values: ['k', 'K', 'm', 'M', 'b', 'B']
Default Value: ''
Chart types: Gauge
stepNumberThe 'step': attribute sets the value of each step along an axis. When using numeric values along the axis, a numeric value for 'step': will incrementally increase the value of each tick along the axis by the specified step value. When the transform attribute is set to 'type':'date', a number of different step values can then be used to modify the step increments.
Accepted Values: [`${number}`, `${number|''}second`, `${number|''}minute`, `${number|''}hour`, `${number|''}day`, `${number|''}week`, `${number|''}month`, `${number|''}year`]
Default Value: 1
Chart types: Gauge
thousandsSeparator
thousands-separator
StringSets the character used to separate thousands.
Default Value: ''
tickObjectUsed to style the scale tick marks.
Default Value: null
tooltipObjectConfigures the tooltip element, which appears when hovering over an object.
Chart types: Gauge
tooltipText
tooltip-text
Array.<String>Sets the tooltip text.
transformObjectTransforms data to specified format. For example, if data is coded as date and time, `type: 'date'` is specifed in this object, and `scaleX.transform: '%D, %d %M %h:%i %A'` is set, then '1311261385209' will display 'Wed, 19 of May 05:00 PM'.
Default Value: null
Chart types: Gauge
usedBooleanForces the display of the scale, even if its not used on any plot.
Default Value: false
valuesArray.<Number,String>, Number, StringSets the scale values.
Default Value: []
visibleBooleanSets the visibility of the object. Allows you to turn off the object without removing lines of JSON.
Default Value: true
zIndex
z-index
NumberSets the z position of the object. Objects with higher z indexes will appear "above" those with lower z index values.
Default Value: 1
zoomSnap
zoom-snap
BooleanWhen zooming is enabled, setting zoom-snap to true snaps the zoom area to the nearest data node as a zoom area is selected. By default, zoom-snap is set to false.
Default Value: false
zoomTo
zoom-to
Array.<Number>To specify the node indices the chart will zoom to by default at chart render. This is best used with linear data (or simple array data) with scrollbars or preview charts
Default Value: null
Chart types: Gauge
zoomingBooleanTo turn on chart zooming on the scale.
Default Value: false
Chart types: Gauge