graph » legend
legend
[ root » graph » legend ]
Create a legend object to add a legend to your chart. Refer to the Legend Tutorial for more information.
| Attribute | Type | Description |
|---|---|---|
| align | String | Automatically aligns the legend and adjusts "plotarea" margins accordingly. Accepted Values: defaultValue |
| alpha | Number | Sets 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 |
| anchor | String | Allows you to set an object's anchor position Accepted Values: ['tl', 'tr', 'bl', 'br', 'c', 't', 'r', 'b', 'l'] Default Value: 'tl' |
| angle | Number | Sets the rotation angle of the object/shape. Default Value: 0 |
| angleEnd angle-end | Number | Sets the end angle of a pie shape. Default Value: 360 |
| angleStart angle-start | Number | Sets the beginning angle of a pie shape. Default Value: 0 |
| backgroundClip background-clip | Boolean | Clips the background image to the margins of the shape/box. Default Value: true |
| 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 |
| backgroundFit background-fit | String | Sets the direction/s on which the background image is being "stretched". Default Value: '' |
| backgroundImage background-image | String | Sets a background image for the object. Value can be a local file or a web image's location. Default Value: '' |
| backgroundPosition background-position | String | Sets the position of the background when the background-repeat value is no-repeat. Default Value: '50% 50%' |
| backgroundRepeat background-repeat | String | Sets the repeating mode for the background image. Default Value: 'repeat' |
| backgroundScale background-scale | Number | Scales the background image using the specified ratio. Default Value: 1 |
| bold | Boolean | Sets whether the text is displayed with bold characters or not. Default Value: false |
| border | String,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 | String | 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 | String | 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 | String | Sets the object's right border style. Accepts solid, dashed, and dotted styles. Default Value: '' |
| borderTop border-top | String | 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 |
| bottomState bottom-state | Object | Sets the style for a copy of the object which is placed below the object itself. Introduced in: v1.14.0 |
| callout | Boolean | Sets whether an object will have a callout arrow or not. Default Value: false |
| calloutExtension callout-extension | Number | Sets the length of the extension that extends beyond the tip of the callout arrow. Default Value: 0 |
| calloutHeight callout-height | Number | Sets 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 | Number | Sets 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 | String | Sets 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 | ZCStyle | To 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 | Number | Sets the width of the object's callout arrow. A larger value will create a wider callout arrow. Default Value: 8 |
| 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 |
| clipText clip-text | Boolean | Truncates text based on the setting of width. Default Value: false |
| collapse | Boolean | Sets legend to be collapsed by default Accepted Values: defaultValue Introduced in: v2.6.2 |
| color | String | Sets the object's font color. Similar to font-color. Default Value: '#000' |
| cursor | String | Sets the cursor shape when hovering over the object. Default Value: 'auto' Introduced in: v1.9.0 |
| dragHandler drag-handler | String | Sets 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: defaultValue |
| draggable | Boolean | Sets whether the legend can be dragged or not. Accepted Values: defaultValue |
| 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,Number | Sets the background gradient fill type to either linear or radial. Default Value: 'linear' |
| flat | Boolean | Disables the active area (used for tooltip) for the object. Default Value: false |
| 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'] |
| fontWeight font-weight | String | Sets the text's font weight. Similar to bold. Default Value: 'normal' |
| footer | Object | Sets the styling for the legend footer. Accepted Values: defaultValue |
| 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: '' |
| group | Number | Sets a group id for the shared legends. In case one legend item is toggled, the similar items on shared legend with same group id will be toggled. Accepted Values: defaultValue |
| header | Object | Sets the styling for the legend header. Accepted Values: defaultValue |
| height | Number | Set the object's height. Default Value: 0 |
| highlightLegend highlight-legend | Boolean | Highlights legend elements (item and marker) whenever a plot is being hovered. Accepted Values: defaultValue |
| highlightPlot highlight-plot | Boolean | An alias for the "highlight" attribute in the "plot" object. Highlights the corresponding plot when the legend item is moused over. Accepted Values: defaultValue |
| icon | Object | When 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. Accepted Values: defaultValue |
| id | String | Sets the id of the object. Default Value: '' |
| id | String | ID of the shape Default Value: '' |
| italic | Boolean | Sets whether the text is displayed with italicized characters or not. Default Value: false |
| item | Object | Sets the styling for the active legend items. Accepted Values: defaultValue |
| item | String | Sets the item id of the map on which the object/shape is being added. Default Value: '' |
| itemOff item-off | Object | Sets the styling for the inactive legend items. Accepted Values: defaultValue |
| itemToggleAction item-toggle-action | String | Similar to toggleAction, except that it applies on clicks on legend items. Accepted Values: defaultValue |
| layout | String | Sets the layout for the legend items. Accepted Values: ['horizontal', 'h', 'vertical', 'v', 'row x col', 'x col', 'row x', 'float'] defaultValue |
| lineCap line-cap | String | Sets the stroke-linecap attribute on SVGs Accepted Values: ['butt', 'round', 'square'] Default Value: 'butt' |
| lineColor line-color | String | Sets 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,Number | Can 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 | Number | Sets the height of a line box. Default Value: -1 |
| lineJoin line-join | String | Sets the stroke-linejoin attribute on SVGs Accepted Values: ['round', 'miter'] Default Value: 'round' |
| lineSegmentSize line-segment-size | String,Number | Can 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 | String | Sets the line style of the object. Default Value: '' |
| lineWidth line-width | Number | Sets the line width of the object, applicable on non-closed shapes. See also border-width for closed shapes. Default Value: 0 |
| map | String | Sets the map id of the map on which the object/shape is being added. |
| margin | Number | Sets the object's margin/s from the top-left of the chart. Default Value: 0 |
| marginBottom margin-bottom | Number | Sets the object's bottom margin. Default Value: -1 |
| marginLeft margin-left | Number | Sets the object's left margin. Default Value: -1 |
| marginRight margin-right | Number | Sets the object's right margin. Default Value: -1 |
| marginTop margin-top | Number | Sets the object's top margin. Default Value: -1 |
| marker | Object | Sets the styling for the legend markers. Accepted Values: defaultValue |
| markerOff marker-off | Object | Sets the styling for the inactive legend markers. Accepted Values: defaultValue |
| markerToggleAction marker-toggle-action | String | Similar to toggleAction, except that it applies on clicks on legend markers. Accepted Values: defaultValue |
| 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 |
| maxItems max-items | Number | Sets the maximum number of items displayed on the legend. To be used with overflow. Accepted Values: defaultValue |
| maxWidth max-width | Number | Sets a maximum width of the object. |
| minimize | Boolean | Sets whether the legend can be minimized or not. Accepted Values: defaultValue |
| offsetR offset-r | Number | Sets an R offset to apply when positioning the object/shape. Default Value: 0 |
| offsetX offset-x | Number | Sets an X offset to apply when positioning the object/shape. Default Value: 0 |
| offsetY offset-y | Number | Sets a Y offset to apply when positioning the object/shape. Default Value: 0 |
| offsetZ offset-z | Number | Sets a Z offset to apply when positioning the object/shape. Default Value: 0 |
| overflow | String | Sets 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: defaultValue |
| 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 |
| pageOff page-off | Object | When 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. Accepted Values: defaultValue |
| pageOn page-on | Object | When using pagination in a legend, the page-on item is an arrow that is still able to be clicked. Accepted Values: defaultValue |
| pageStatus page-status | Object | Allows 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. Accepted Values: defaultValue |
| points | Array. | Sets the coordinates of the object/shape points. Default Value: [] |
| position | String | Sets 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: '' |
| 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 |
| scroll | Object | Configures the scroll bar and handle. Accepted Values: defaultValue |
| scroll | Object | To enable legend scrolling. Accepted Values: defaultValue |
| shadow | Boolean | Sets whether the object's shadow is visible or not. Has limited effect on HTML5 implementation. Default Value: false |
| shadowAlpha shadow-alpha | Number | Sets 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 | Number | Sets the angle of the shadow underneath the object. Default Value: 45 |
| shadowBlur shadow-blur | String,Number | Sets the blur effect size for the shadow of the object. Has limited effect on HTML5 implementation. Default Value: 0 |
| shadowColor shadow-color | String | Sets the color of the shadow of the object. Default Value: '#999' |
| shadowDistance shadow-distance | String,Number | Sets the distance between the shadow and the object. Default Value: 2 |
| shared | Boolean | For graphsets with multiple chart objects, setting this attribute to true within the legend object of each chart will allow you to use one legend to toggle data on or off for each chart simultaneously. It should be noted that while each chart must have a legend object, the visible attribute can be set to false to hide a legend. Accepted Values: defaultValue |
| size | Number | Sets the size of the object/shape. Default Value: 0 |
| size2 size-2 | Number | Sets the secondary size of the object/shape. Used on ellipses or rectangle shapes. Default Value: 0 |
| slice | Number | Sets the radius of the inner ring of a pie shape. Default Value: 0 |
| target | String | Sets 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 |
| text | String | Sets the text content of the object. Default Value: null |
| textAlign text-align | String | Sets the text's horizontal alignment relative to the object's box. Default Value: 'center' |
| 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' |
| textHeight text-height | Number | Sets the height of the text Default Value: 0 |
| textWidth text-width | Number | Sets the width of the text Default Value: 0 |
| toggleAction toggle-action | String | Sets 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: defaultValue |
| tooltip | Object | Legend tooltips appear when users hover over the items in the legend. Accepted Values: defaultValue |
| topState top-state | ZCShape | Sets the style for a copy of the object which is placed above the object itself. Introduced in: v1.14.0 |
| type | String | Sets 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' |
| underline | Boolean | Sets whether the text is displayed with underlined characters or not. Default Value: false |
| url | String | Sets an URL associated with this object. Used mostly on nodes/labels/shapes with their associated click events. Default Value: null |
| verticalAlign vertical-align | String | Automatically aligns the legend and adjusts "plotarea" margins accordingly. Accepted Values: defaultValue |
| verticalAlign vertical-align | String | Sets the text's vertical alignment to one of the three applicable values, relative to the object's box. 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. Default Value: 0 |
| wrapText wrap-text | Boolean | Sets whether the text will wrap, depending on the width of the object. Default Value: false |
| x | Number | Sets the X position of the object. Default Value: -1 |
| y | Number | Sets the Y position of the object. |
| 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 |
| zSort z-sort | Number | Used to force the sorting of the active areas (which trigger the tooltip) of two shapes in case they overlap. Default Value: 1 |