graph » zoom » label

zoom label

[ root » graph » zoom » label ]

Zooming labels allow users to select their zoom area more precisely. To display them, make sure to set the visible attribute to true in the label object. The zooming labels display the selected area's node indexes and values, and you can style the background, borders, padding, and font. Refer to the Zooming, Scrollbar, and Preview Chart Tutorial for more information.




AttributeTypeDescription
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
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
borderColor
border-color
StringSets the border color of the object.
Default Value: '#000'
borderWidth
border-width
NumberSets the border width of the object.
Default Value: 0
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
dataN
data-n
AnyPrefix attribute or array using "data-" to define a custom token.
fontAngle
font-angle
NumberSets the text's angle. A positive value will rotate the object by that number of degrees clockwise, while a negative value.
fontColor
font-color
StringSets the font color of the text.
fontFamily
font-family
StringSets the text's font family.
fontSize
font-size
NumberSets the text's font size.
fontStyle
font-style
StringSets the text's font style.
Accepted Values: ['normal', 'italic', 'oblique', 'none']
fontWeight
font-weight
Number, StringSets the text's font weight. Similar to bold.
Accepted Values: ['bold', 'none', 'normal', `${string}`]
Default Value: 'normal'
idStringSets the id of the object.
Default Value: ''
lineHeight
line-height
NumberSets the height of a line box.
Default Value: -1
mediaRules
media-rules
Array.<Object>Configure media rules.
overlapBooleanSets whether the object allows overlapping with other labels. If false, and two objects overlap, only one will be displayed.
Default Value: true
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
paddingBottom
padding-bottom
NumberSets the object's bottom padding around the text.
Default Value: 2
paddingLeft
padding-left
NumberSets the object's left padding around the text.
Default Value: 2
paddingRight
padding-right
NumberSets the object's right padding around the text.
Default Value: 2
paddingTop
padding-top
NumberSets the object's top padding around the text.
Default Value: 2
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
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