graph » scale

scale

[ root » graph » scale]

Pie and Gauge Charts Only: This object is used to adjust the size (and layout, for pie chart small multiples only) of the charts. Note that this object is distinct from the scale-r object. Refer to the Pie Charts Tutorial and the Angular Gauge Charts Tutorial for more information.




AttributeTypeDescription
alphaNumberSets the transparency level of the object. Values must range between 0.0 and 1.0, with 0.0 being completely transparent and 1.0 being completely opaque. Note that values require the leading 0 before the decimal point.
Default Value: 1
anchorStringAllows you to set an object's anchor position
Accepted Values: ['tl', 'tr', 'bl', 'br', 'c', 't', 'r', 'b', 'l']
Default Value: 'tl'
angleNumberSets the rotation angle of the object/shape.
Default Value: 0
angleEnd
angle-end
NumberSets the end angle of a pie shape.
Default Value: 360
angleStart
angle-start
NumberSets the beginning angle of a pie shape.
Default Value: 0
autoFit
auto-fit
Boolean,Array.Sets whether the scale boundaries are recalculated on zoom to the "local" min/max values or are always fixed to the initial min/max values.
Default Value: [false, false]
backgroundClip
background-clip
BooleanClips the background image to the margins of the shape/box.
Default Value: true
backgroundColor
background-color
StringSets the background color of the object. Colors can be entered by name (e.g., "purple", "blue"), hexadecimal notation (e.g., "#666699", #33ccff"), or RGB notation (e.g., "rgb(255,0,0)", "rgb(0,0,255)")
Default Value: null
backgroundColor1
background-color-1
StringSets the first color of a 2 color background gradient of the object. To be used with background-color-2.
Default Value: null
backgroundColor2
background-color-2
StringSets the second color of a 2 color background gradient of the object. To be used with background-color-1.
Default Value: null
backgroundFit
background-fit
StringSets the direction/s on which the background image is being "stretched".
Default Value: ''
backgroundImage
background-image
StringSets a background image for the object. Value can be a local file or a web image's location.
Default Value: ''
backgroundPosition
background-position
StringSets the position of the background when the background-repeat value is no-repeat.
Default Value: '50% 50%'
backgroundRepeat
background-repeat
StringSets the repeating mode for the background image.
Default Value: 'repeat'
backgroundScale
background-scale
NumberScales the background image using the specified ratio.
Default Value: 1
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
borderString,NumberSets the border width of the object. Can be a single value or a string of values, setting the values in the order "top right bottom left"
borderAlpha
border-alpha
NumberSets the transparency level of the border on the object. Values must range between 0.0 and 1.0, with 0.0 being completely transparent and 1.0 being completely opaque. Note that values require the leading 0 before the decimal point.
Default Value: 1
Introduced in: v2.1.1
borderBottom
border-bottom
StringSets the object's bottom border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderColor
border-color
StringSets the border color of the object.
Default Value: '#000'
borderLeft
border-left
StringSets the object's left border style. Accepts solid, dashed, and dotted styles.
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
borderRight
border-right
StringSets the object's right border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderTop
border-top
StringSets the object's top border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderWidth
border-width
NumberSets the border width of the object.
Default Value: 0
bottomState
bottom-state
ObjectSets the style for a copy of the object which is placed below the object itself.
Introduced in: v1.14.0
calloutBooleanSets whether an object will have a callout arrow or not.
Default Value: false
calloutExtension
callout-extension
NumberSets the length of the extension that extends beyond the tip of the callout arrow.
Default Value: 0
calloutHeight
callout-height
NumberSets the height of the object's callout arrow. A larger value will create a taller callout arrow.
Default Value: 8
calloutHook
callout-hook
Array.Sets the point of the tip of the callout arrow to a specified coordinate on the chart, with the starting point of [0,0] being the top left corner of the chart.
Default Value: null
calloutOffset
callout-offset
NumberSets the offset along the callout direction of the arrow's base. Positive and negative values can be used to offset the callout arrow up, down, left, or right depending on the callout-position.
Default Value: 0
calloutPosition
callout-position
StringSets the position for the object's callout arrow. The position is "bottom" by default.
Default Value: 'bottom'
calloutRatio
callout-ratio
Array.Sets how much to stretch/squeeze the callout arrow on its two sides. A zero value for example on one side would create like a half callout arrow. Negative values can also be set, in order to create various aspects.
Default Value: [1, 1]
calloutTip
callout-tip
ZCStyleTo style the tip of the callout. You can modify the shape with a "type" attribute. Value options include "circle", "diamond", "cross", and "arrow". For styling, use attributes such as "background-color", "border-color", "border-width", "line-color", "line-width", and so on.
Default Value: null
calloutWidth
callout-width
NumberSets the width of the object's callout arrow. A larger value will create a wider callout arrow.
Default Value: 8
centerRef
center-ref
BooleanSets the (0,0) x/y coordinates as the center of the box (instead of the top-left corner).
Default Value: false
classStringSets a class value on the object.
Default Value: null
cursorStringSets the cursor shape when hovering over the object.
Default Value: 'auto'
Introduced in: v1.9.0
decimalsNumberSets the number of decimals which will be displayed as scale-x values. Note this attribute does round the values to fit within the defined number of decimals.
Default Value: -1
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: '.'
exponentBooleanSets whether the scale values will be displayed in scientific notation. Particularly useful when dealing with large numbers.
Default Value: false
exponentDecimals
exponent-decimals
NumberSets the number of decimals that will be displayed when using scientific notation. Use with the 'exponent' attribute.
Default Value: 2
factorNumberApplies a multiplication factor to all scale items.
Default Value: 1
fillAngle
fill-angle
NumberSets the angle of the axis along which the linear gradient is drawn.
Default Value: 90
fillOffsetX
fill-offset-x
NumberSets an X offset to apply to the fill.
Default Value: 0
fillOffsetY
fill-offset-y
NumberSets a Y offset to apply to the fill.
Default Value: 0
fillType
fill-type
String,NumberSets the background gradient fill type to either linear or radial.
Default Value: 'linear'
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
flatBooleanDisables the active area (used for tooltip) for the object.
Default Value: false
formatStringTo format the appearance of the scale values. Use with the %scale-value (%v) token.
Default Value: null
gradientColors
gradient-colors
StringSets a set of colors for a complex background gradient consisting of 2 or more colors. To be used with gradient-stops.
Default Value: ''
gradientStops
gradient-stops
StringSets the gradient stops for a complex background gradient consisting of 2 or more colors. To be used with gradient-colors.
Default Value: ''
guideObjectUsed to style the lines and backgrounds behind the plotted data.
Default Value: null
heightNumberSet the object's height.
Default Value: 0
idStringID of the shape
Default Value: ''
idStringSets the id of the object.
Default Value: ''
itemObjectUsed to style the individual scale labels.
Default Value: null
itemStringSets the item id of the map on which the object/shape is being added.
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
labelObjectTo create and style the scale title.
Default Value: null
labelsArray.Allows you to set custom labels that correspond to each of the ticks on a scale. If there are more ticks than labels, the default values will be used for the remaining labels.
lineCap
line-cap
StringSets the stroke-linecap attribute on SVGs
Accepted Values: ['butt', 'round', 'square']
Default Value: 'butt'
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
String,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
lineJoin
line-join
StringSets the stroke-linejoin attribute on SVGs
Accepted Values: ['round', 'miter']
Default Value: 'round'
lineSegmentSize
line-segment-size
String,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.
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
mapStringSets the map id of the map on which the object/shape is being added.
marginNumberSets the object's margin/s from the top-left of the chart.
Default Value: 0
marginBottom
margin-bottom
NumberSets the object's bottom margin.
Default Value: -1
marginLeft
margin-left
NumberSets the object's left margin.
Default Value: -1
marginRight
margin-right
NumberSets the object's right margin.
Default Value: -1
marginTop
margin-top
NumberSets the object's top margin.
Default Value: -1
markersArrayTo 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: ''
maxNumberSets the maximum scale value.
maxDecimals
max-decimals
NumberThe maximum number of decimal places displayed on the scale labels. Values will be rounded to the set precision level.
Default Value: -1
maxItems
max-items
NumberTo set the maximum number of scale items displayed. It is generally used with the 'items-overlap' attribute.
maxTicks
max-ticks
NumberSets the maximum number of ticks to display on the scale.
minNumberSets the minimum scale value.
Default Value: -1
minorGuide
minor-guide
ObjectTo style the minor guides, which appear between the major guides.
Default Value: null
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
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
mirroredBooleanSetting 'mirrored': true will reverse/mirror the x axis values. 'scale-x': {} values will read right to left.
Default Value: false
negationStringSets the negative symbol just outside of the formatted value.
Accepted Values: ['standard', 'currency']
Default Value: 'standard'
normalizeBooleanApplies roundings to scale boundaries in order to get nicer min/max/step values.
Default Value: true
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
offsetR
offset-r
NumberSets an R offset to apply when positioning the object/shape.
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/shape.
Default Value: 0
offsetY
offset-y
NumberSets a Y offset to apply when positioning the object/shape.
Default Value: 0
offsetZ
offset-z
NumberSets a Z offset to apply when positioning the object/shape.
Default Value: 0
placementStringSets the placement of the scale object.
Default Value: 'default'
pointsArray.Sets the coordinates of the object/shape points.
Default Value: []
positionStringSets the object's position relative to its container. Similar results can be obtained by setting [margin] and [margin-...] attributes. Uses x,y coordinates originating from the top left of the chart.
Default Value: ''
progressionStringTo change the scale type from linear (default) to logarithmic.
Default Value: 'lin'
rangedBooleanSets the scale as "ranged", forcing the node point to be placed between two scale ticks. By default, bar charts use a ranged scale as the key scale.
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
refValue
ref-value
NumberTo set the value the reference line is drawn at.
Default Value: 0
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
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
String,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
String,NumberSets the distance between the shadow and the object.
Default Value: 2
shortBooleanSetting to true will cause the values on the x axis to use an abbreviated notation with a short unit such as K,M,B, etc.
Default Value: false
shortUnit
short-unit
StringSpecifies which unit of measure to use when short is set to true.
Default Value: ''
showLabels
show-labels
Array.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
sizeNumberSets the size of the object/shape.
Default Value: 0
size2
size-2
NumberSets the secondary size of the object/shape. Used on ellipses or rectangle shapes.
Default Value: 0
sliceNumberSets the radius of the inner ring of a pie shape.
Default Value: 0
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.
Default Value: 1
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
targetStringSets the target for the URL. Depending on its value, it either opens the URL or uses the content fetched from the URL (when target is graph=ID).
Accepted Values: _blank, _top, _parent, _window=NAME, graph=ID
Default Value: null
thousandsSeparator
thousands-separator
StringInserts punctuation to separate numbers in values over 999.
Default Value: ''
tickObjectUsed to style the scale tick marks.
Default Value: null
tooltipObjectConfigures the scale tooltips
tooltipText
tooltip-text
Array.Sets an array of text elements which will be displayed on the scale items tooltips (provided %tooltip-text token is used)
topState
top-state
ZCShapeSets the style for a copy of the object which is placed above the object itself.
Introduced in: v1.14.0
transformObjectSets the transformation of the scale values, currently only transform : { type : 'date' } is implemented.
Default Value: null
typeStringSets the type of the object/shape.
Accepted Values: ['arc', 'arrow', 'circle', 'cross', 'diamond', 'ellipse','gear3', 'gear4', 'gear5', 'gear6', 'gear7', 'gear8', 'gear9', 'hamburger', 'line', 'parallelogram', 'pie','plus', 'poly', 'rect', 'rpoly3', 'rpoly4', 'rpoly5', 'rpoly6', 'rpoly7', 'rpoly8', 'rpoly9', 'square', 'star3', 'star4', 'star5', 'star6', 'star7', 'star8', 'star9', 'trapezoid', 'triangle']
Default Value: 'poly'
urlStringSets an URL associated with this object. Used mostly on nodes/labels/shapes with their associated click events.
Default Value: null
usedBooleanForces the display of the scale, even if its not used on any plot.
Default Value: false
valuesArray.An alternative way to create category scale labels. Similar to a 'labels' array, the 'values' array also acts as a maximum scale value.
Default Value: []
visibleBooleanSets the visibility of the object. Allows you to turn off the object without removing lines of JSON.
Default Value: true
widthNumberSets the object's width.
Default Value: 0
xNumberSets the X position of the object.
Default Value: -1
yNumberSets the Y position of the object.
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
zSort
z-sort
NumberUsed to force the sorting of the active areas (which trigger the tooltip) of two shapes in case they overlap.
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.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
zoomToValues
zoom-to-values
Array.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