graph » scale-x » rules

rules

[ root » graph » scale-x » rules ]

Use the rules array of objects to change the appearance of scaleX items, tick marks, guides, minor tick marks, and minor guides based on specified rules. Refer to the Logic Rules Tutorial for more information.




AttributeTypeDescription
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
fixedStep
fixed-step
BooleanUsed in pair with a step:1 and discrete values for scales, forces proper behavior on scale zooming/scrolling.
Default Value: false
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: ''
itemsOverlap
items-overlap
BooleanTo force all of the scale items to display. It is generally used with the 'max-items' attribute.
Default Value: false
labelsArray.<Number,String>Sets the labels.
Chart types: Gauge
lineColor
line-color
StringSets the line color of the object, applicable on non-closed shapes. See also border-color for closed shapes.
Default Value: '#000'
lineGapSize
line-gap-size
NumberCan be used to create custom dashed or dotted lines when used with line-segment-size. This will control the size of the gaps between each line segment.
Default Value: 0
lineSegmentSize
line-segment-size
NumberCan be used to create custom dashed or dotted lines when used with line-gap-size. This will control the size of the visible segment of line.
Default Value: 0
lineStyle
line-style
StringSets the line style of the object.
Accepted Values: ['dashdot', 'dashed', 'dotted', 'solid']
Default Value: ''
lineWidth
line-width
NumberSets the line width of the object, applicable on non-closed shapes. See also border-width for closed shapes.
Default Value: 0
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
markersArray.<Object>To create and style the scale markers, which can appear as areas or lines.
Default Value: []
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
maxLabels
max-labels
NumberSets the maximum number of labels to display along the axis.
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.
minValue
min-value
NumberSets the minimum scale value.
Default Value: -1
minorGuide
minor-guide
ObjectTo style the minor grid lines, which appear between the major grid lines.
Default Value: null
Chart types: Gauge
minorTick
minor-tick
ObjectTo style the minor tick marks, which appear between the major tick marks. Note that the 'minor-ticks' attribute must be included in your scale object to set the number of minor tick marks displayed.
Default Value: null
Chart types: Gauge
minorTicks
minor-ticks
NumberSets the number of minor tick marks displayed between the major tick marks. Note that this attribute is required to style the minor tick marks and/or guides.
Default Value: 0
Chart types: Gauge
mirroredBooleanSetting 'mirrored': true will reverse/mirror the x axis values. 'scale-x': {} values will read right to left.
Default Value: false
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
placementStringSets the placement of the object.
Accepted Values: ['cross', 'default', 'opposite']
Default Value: 'default'
progressionStringTo change the scale type from linear (default) to logarithmic.
Accepted Values: ['lin', 'linear', 'log']
Default Value: 'lin'
rangedBooleanSets the scale as "ranged", basically the node is placed in the middle of the interval between two scale values.
Default Value: false
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
ruleStringThe criteria to check for to apply the corresponding styling.
shadowBooleanSets whether the object's shadow is visible or not. Has limited effect on HTML5 implementation.
Default Value: false
shadowAlpha
shadow-alpha
NumberSets the transparency of the shadow of the object. The higher the value, the less transparent the shadow will be.
Default Value: 0.75
shadowAngle
shadow-angle
NumberSets the angle of the shadow underneath the object.
Default Value: 45
shadowBlur
shadow-blur
NumberSets the blur effect size for the shadow of the object. Has limited effect on HTML5 implementation.
Default Value: 0
shadowColor
shadow-color
StringSets the color of the shadow of the object.
Default Value: '#999'
shadowDistance
shadow-distance
NumberSets the distance between the shadow and the object.
Default Value: 2
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
showLabels
show-labels
Array.<String>Sets a filter to show only specific items on a scale. It does NOT force the display of the specified items if those are not already generated by the scale.
Default Value: null
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
stepMultiplier
step-multiplier
NumberApplies a multiplier to the interval used to show ticks/items on scale. The multiplier is not applied only if the number of items currently active is greater than the multiplier value. Otherwise, all items are being displayed.
Introduced in: v2.9.1
thousandsSeparator
thousands-separator
StringSets the character used to separate thousands.
Default Value: ''
tickObjectUsed to style the scale tick marks.
Default Value: null
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
zoomToValues
zoom-to-values
Array.<Number>To specify the node values the chart will zoom to by default at chart render. This is best used with non-linear data (or array of array data) with scrollbars or preview charts.
Default Value: null
zoomingBooleanTo turn on chart zooming on the scale.
Default Value: false
Chart types: Gauge