graph » bubble-legend » item
item
[ root » graph » bubble-legend » item]
Use the item object to customize the legend bubble items.
| Attribute | Type | Description |
|---|---|---|
| align | String | Sets the alignment of the object. Accepted Values: ['left', 'center', 'right'] |
| alpha | Number | Sets the opacity on the marker, with 0 being fully transparent and 1 being fully opaque. Note that decimal value requires the leading 0. |
| angle | Number | Sets the rotation angle of the object. Default Value: 0 |
| autoAlign auto-align | Boolean | Auto aligns the scale item label |
| backgroundColor background-color | String | Sets 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 | String | Sets 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 | String | Sets the second color of a 2 color background gradient of the object. To be used with background-color-1. Default Value: null |
| bold | Boolean | Sets whether the text is displayed with bold characters or not. Default Value: false |
| border | Number | Sets 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 | Number | Sets 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 | Number | Sets the object's bottom border style. Accepts solid, dashed, and dotted styles. Default Value: '' |
| borderColor border-color | String | Sets the border color of the object. Default Value: '#000' |
| borderLeft border-left | Number | Sets the object's left border style. Accepts solid, dashed, and dotted styles. |
| borderRadius border-radius | Number | Sets 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 | Number | Sets 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 | Number | Sets 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 | Number | Sets 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 | Number | Sets 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 | Number | Sets the object's right border style. Accepts solid, dashed, and dotted styles. Default Value: '' |
| borderTop border-top | Number | Sets the object's top border style. Accepts solid, dashed, and dotted styles. Default Value: '' |
| borderWidth border-width | Number | Sets the border width of the object. Default Value: 0 |
| centerRef center-ref | Boolean | Sets the (0,0) x/y coordinates as the center of the box (instead of the top-left corner). Default Value: false |
| class | String | Sets a class value on the object. Default Value: null |
| color | String | Sets the object's font color. Similar to font-color. Default Value: '#000' |
| dataN data-n | Any | Prefix attribute or array using "data-" to define a custom token. |
| decimals | Number | Sets the number of decimal places displayed for each value. Default Value: 0 Introduced in: v2.8.4 |
| decimalsSeparator decimals-separator | String | Sets 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: '.' Introduced in: v2.8.4 |
| fillAngle fill-angle | Number | Sets the angle of the axis along which the linear gradient is drawn. Default Value: 90 |
| fillOffsetX fill-offset-x | Number | Sets an X offset to apply to the fill. Default Value: 0 |
| fillOffsetY fill-offset-y | Number | Sets a Y offset to apply to the fill. Default Value: 0 |
| fillType fill-type | String | Sets the background gradient fill type to either linear or radial. Accepted Values: ['linear', 'none', 'radial'] Default Value: 'linear' |
| fontAngle font-angle | Number | Sets the text's angle. A positive value will rotate the object by that number of degrees clockwise, while a negative value. |
| fontColor font-color | String | Sets the font color of the text. |
| fontFamily font-family | String | Sets the text's font family. |
| fontSize font-size | Number | Sets the text's font size. |
| fontStyle font-style | String | Sets the text's font style. Accepted Values: ['normal', 'italic', 'oblique', 'none'] |
| fontWeight font-weight | Number, String | Sets the text's font weight. Similar to bold. Accepted Values: ['bold', 'none', 'normal', `${string}`] Default Value: 'normal' |
| gradientColors gradient-colors | String | Sets 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 | String | Sets the gradient stops for a complex background gradient consisting of 2 or more colors. To be used with gradient-colors. Default Value: '' |
| height | Number | Sets the object's height. |
| id | String | Sets the id of the object. Default Value: '' |
| italic | Boolean | Sets whether the text is displayed with italicized characters or not. Default Value: false |
| jsRule js-rule | String | Set a window.functionName to call dynamically.
Example: `jsRule: "window.functionName()"`. Default Value: null |
| lineHeight line-height | Number | Sets the height of a line box. Default Value: -1 |
| lockRotation lock-rotation | Boolean | Set to lock scale labels in place and not rotate with viewing angle in 3D charts. Chart types: 3D Charts |
| maxChars max-chars | Number | Sets the maximum numbers of characters displayed in the object. The value determines how many characters will be displayed before the text is cut and appended with "..." Default Value: 0 |
| overlap | Boolean | Sets whether the object allows overlapping with other labels. If false, and two objects overlap, only one will be displayed. Default Value: true |
| padding | Number | Sets 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 | Number | Sets the object's bottom padding around the text. Default Value: 2 |
| paddingLeft padding-left | Number | Sets the object's left padding around the text. Default Value: 2 |
| paddingRight padding-right | Number | Sets the object's right padding around the text. Default Value: 2 |
| paddingTop padding-top | Number | Sets the object's top padding around the text. Default Value: 2 |
| rectShortcut rect-shortcut | Boolean | Used 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 |
| rtl | Boolean | Renders text right-to-left. Default value is false. Default Value: false |
| short | Boolean | Automatically shortens large units (e.g. 1000000 -> 1M). Default Value: true Introduced in: v2.8.4 |
| text | String | Sets the text content of the object. Default Value: null |
| textAlpha text-alpha | Number | Sets the opacity on the text, with 0 being fully transparent and 1 being fully opaque. Note that decimal value requires the leading 0. Default Value: true |
| textDecoration text-decoration | String | Sets the text's decoration to use underlined characters. Similar to underline. May not display properly in Mozilla Firefox when charts are rendered using SVG. Default Value: 'none' |
| thousandsSeparator thousands-separator | String | Sets the character used to separate thousands. Default Value: ',' Introduced in: v2.8.4 |
| underline | Boolean | Sets whether the text is displayed with underlined characters or not. Default Value: false |
| verticalAlign vertical-align | String | Sets vertical alignment of the object. Accepted Values: ['top', 'middle', 'bottom'] Default Value: 'middle' |
| visible | Boolean | Sets the visibility of the object. Allows you to turn off the object without removing lines of JSON. Default Value: true |
| width | Number | Sets the object's width. |
| zIndex z-index | Number | Sets the z position of the object. Objects with higher z indexes will appear "above" those with lower z index values. Default Value: 1 |