graph » legend » bottom-state

bottom-state

[ root » graph » legend » item-off ]

Use the bottomState object to customize the legend bottom copy.




AttributeTypeDescription
adjustLayout
adjust-layout
BooleanSet to prevent plotarea from overlapping with legend.
Default Value: null
alignStringSets the alignment of the object. For legends, automatically aligns the legend and adjusts "plotarea" margins accordingly ['left', 'center', 'right'].
Accepted Values: ['center', 'left', 'right']
alphaNumberSets the opacity on the marker, with 0 being fully transparent and 1 being fully opaque. Note that decimal value requires the leading 0.
angleNumberSets the rotation angle of the object.
Default Value: 0
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. For patterns, the available patterns are: [`${string}`, 'PATTERN_BACKWARD_DIAGONAL', 'PATTERN_DARK_DOWNWARD_DIAGONAL', 'PATTERN_DARK_HORIZONTAL', 'PATTERN_DARK_UPWARD_DIAGONAL', 'PATTERN_DARK_VERTICAL', 'PATTERN_DASHED_DOWNWARD_DIAGONAL', 'PATTERN_DASHED_HORIZONTAL', 'PATTERN_DASHED_UPWARD_DIAGONAL', 'PATTERN_DASHED_VERTICAL', 'PATTERN_DIAGONAL_BRICK', 'PATTERN_DIAGONAL_CROSS', 'PATTERN_DIVOT', 'PATTERN_DOTTED_DIAMOND', 'PATTERN_DOTTED_GRID', 'PATTERN_FORWARD_DIAGONAL', 'PATTERN_HORIZONTAL', 'PATTERN_HORIZONTAL_BRICK', 'PATTERN_LARGE_CHECKER_BOARD', 'PATTERN_LARGE_GRID', 'PATTERN_LIGHT_DOWNWARD_DIAGONAL', 'PATTERN_LIGHT_HORIZONTAL', 'PATTERN_LIGHT_UPWARD_DIAGONAL', 'PATTERN_LIGHT_VERTICAL', 'PATTERN_NARROW_HORIZONTAL', 'PATTERN_NARROW_VERTICAL', 'PATTERN_OUTLINED_DIAMOND', 'PATTERN_PLAID', 'PATTERN_SHADE_25', 'PATTERN_SHADE_50', 'PATTERN_SHADE_75', 'PATTERN_SHINGLE', 'PATTERN_SMALL_CHECKER_BOARD', 'PATTERN_SMALL_GRID', 'PATTERN_SOLID_DIAMOND', 'PATTERN_SPHERE', 'PATTERN_TRELLIS', 'PATTERN_VERTICAL', 'PATTERN_WAVE', 'PATTERN_WEAVE', 'PATTERN_WIDE_DOWNWARD_DIAGONAL', 'PATTERN_WIDE_UPWARD_DIAGONAL', 'PATTERN_ZIGZAG'].
Accepted Values: ['PATTERN_BACKWARD_DIAGONAL', 'PATTERN_DARK_DOWNWARD_DIAGONAL', 'PATTERN_DARK_HORIZONTAL', 'PATTERN_DARK_UPWARD_DIAGONAL', 'PATTERN_DARK_VERTICAL', 'PATTERN_DASHED_DOWNWARD_DIAGONAL', 'PATTERN_DASHED_HORIZONTAL', 'PATTERN_DASHED_UPWARD_DIAGONAL', 'PATTERN_DASHED_VERTICAL', 'PATTERN_DIAGONAL_BRICK', 'PATTERN_DIAGONAL_CROSS', 'PATTERN_DIVOT', 'PATTERN_DOTTED_DIAMOND', 'PATTERN_DOTTED_GRID', 'PATTERN_FORWARD_DIAGONAL', 'PATTERN_HORIZONTAL', 'PATTERN_HORIZONTAL_BRICK', 'PATTERN_LARGE_CHECKER_BOARD', 'PATTERN_LARGE_GRID', 'PATTERN_LIGHT_DOWNWARD_DIAGONAL', 'PATTERN_LIGHT_HORIZONTAL', 'PATTERN_LIGHT_UPWARD_DIAGONAL', 'PATTERN_LIGHT_VERTICAL', 'PATTERN_NARROW_HORIZONTAL', 'PATTERN_NARROW_VERTICAL', 'PATTERN_OUTLINED_DIAMOND', 'PATTERN_PLAID', 'PATTERN_SHADE_25', 'PATTERN_SHADE_50', 'PATTERN_SHADE_75', 'PATTERN_SHINGLE', 'PATTERN_SMALL_CHECKER_BOARD', 'PATTERN_SMALL_GRID', 'PATTERN_SOLID_DIAMOND', 'PATTERN_SPHERE', 'PATTERN_TRELLIS', 'PATTERN_VERTICAL', 'PATTERN_WAVE', 'PATTERN_WEAVE', 'PATTERN_WIDE_DOWNWARD_DIAGONAL', 'PATTERN_WIDE_UPWARD_DIAGONAL', 'PATTERN_ZIGZAG', `${string}`]
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
Boolean, 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
borderNumberSets 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
NumberSets 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
NumberSets 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
NumberSets the object's right border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderTop
border-top
NumberSets 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
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.<Number>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.<Number>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]
calloutWidth
callout-width
NumberSets the width of the object's callout arrow. A larger value will create a wider callout arrow.
Default Value: 8
collapseBooleanSets legend to be collapsed by default
Introduced in: v2.6.2
dragHandler
drag-handler
StringSets the handler used to drag the legend: icon will create a dragging icon on the legend header, which will be the only area on which you can click and drag; header will make the whole header object active for dragging the legend.
Accepted Values: ['header', 'icon']
Default Value: 'header'
draggableBooleanSets whether the legend can be dragged or not.
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
StringSets the background gradient fill type to either linear or radial.
Accepted Values: ['linear', 'none', 'radial']
Default Value: 'linear'
footerObjectSets the styling for the legend footer.
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: ''
headerObjectSets the styling for the legend header.
heightNumberSets the object's height.
highlightPlot
highlight-plot
BooleanAn alias for the "highlight" attribute in the "plot" object. Highlights the corresponding plot when the legend item is moused over.
iconObjectWhen a legend is set to draggable with an icon drag-handler, the icon object allows you to customize the appearance of the drag-handler icon.
itemOff
item-off
ObjectSets the styling for the inactive legend items.
itemToggleAction
item-toggle-action
StringSimilar to toggleAction, except that it applies on clicks on legend items.
Accepted Values: ['disabled', 'hide', 'none', 'remove']
layoutStringDefines the layout of the items of the object.
Accepted Values: ['horizontal', 'h', 'vertical', 'v', `${number}x${number}`, `x${number}`, `${number}x`, 'float']
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
lineHeight
line-height
NumberSets the height of a line box.
Default Value: -1
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: ''
marginNumber, StringSets the object's margin/s from the top-left of the chart.
Accepted Values: ['dynamic']
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
markerOff
marker-off
ObjectSets the styling for the inactive legend markers.
markerToggleAction
marker-toggle-action
StringSimilar to toggleAction, except that it applies on clicks on legend markers.
Accepted Values: ['disabled', 'hide', 'none', 'remove']
maxItems
max-items
NumberSets the maximum number of items displayed.
minimizeBooleanSets whether the legend can be minimized or not.
offsetX
offset-x
NumberSets an x-offset to apply when positioning the object.
Default Value: 0
offsetY
offset-y
NumberSets an y-offset to apply when positioning the object.
Default Value: 0
overflowStringSets the display mode for legend items beyond max-items setting: none will display all items; hidden will display just top max-items items; page will enable the pagination module; scroll will enable legend scrolling, with top max-items items per page. To be used with max-item.
Accepted Values: ['hidden', 'none', 'page', 'scroll']
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
pageOff
page-off
ObjectWhen using pagination in a legend, the page-off item is an arrow that is no longer able to be clicked because the legend is displaying either the first or the last page.
pageOn
page-on
ObjectWhen using pagination in a legend, the page-on item is an arrow that is still able to be clicked.
pageStatus
page-status
ObjectAllows you to style the page-status object, which appears in a legend when pagination is being used. The page-status indicator generally displays the current legend page.
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: ''
reserveSeries
reserve-series
BooleanReverses the order of the legend items.
Default Value: null
scrollObjectPresence of object enables legend. Configures the scroll bar and handle.
shadowBooleanSets whether the object's shadow is visible or not. Has limited effect on HTML5 implementation.
Default Value: false
shadowAngle
shadow-angle
NumberSets the angle of the shadow underneath the object.
Default Value: false
sharedBooleanShares a single legend to simutaniously apply toggle to multiple charts within a graphset. Note, set this attribute to true within each `legend` object of each chart. The `visible` attribute can be set to false to hide a legend.
toggleAction
toggle-action
StringSets the action performed on legend item toggle: hide will simply hide the respective plot; remove will repaint the chart without considering the respective plot; disabled will not generate any action for the legend items/markers.
Accepted Values: ['disabled', 'hide', 'none', 'remove']
Default Value: 'remove'
verticalAlign
vertical-align
StringSets vertical alignment of the object. For textboxes, aligns relative to object's box. Accepted values: ['top', 'middle', 'bottom']. For legend, automatically aligns and adjusts `plotarea` margins accordingly. Accepted values: ['top', 'middle', 'bottom'].
Accepted Values: ['bottom', 'middle', 'top']
Default Value: 'middle'
widthNumberSets the object's width.
xNumberSets the X position of the object.
Default Value: -1
yNumberSets the Y position of the object.