Docs Back to Docs

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.

AttributeTypeInfo
adjust-layout
adjustLayout		Boolean

Forces the plotarea to consider the legend positioning and prevent overlapping with it.

true | false | 1 | 0

alignString

Automatically aligns the legend and adjusts "plotarea" margins accordingly.

"left" | "center" | "right"

alphaNumeric

Sets the transparency of the object. The higher the value, the less transparent the object appears. Requires the formatting 0.x.

0.3 | 0.9 | ...

background-color
backgroundColor		String

Sets the background color of the object. Colors can be entered by name (e.g., "red", "blue", "yellow"), in hexadecimal notation (e.g., "#FF0000", "#0000FF", "#FFFF00"), or in RGB notation (e.g., "rgb(255,0,0)", "rgb(0,0,255)", "rgb(255,255,0)").

One color will set a solid background color; two colors will, by default, create a horizontal gradient. For more complex gradients, use gradient-colors and gradient-stops.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

background-color-1
backgroundColor1		String

Sets the first color of a 2 color background gradient of the object. To be used with background-color-2.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

background-color-2
backgroundColor2		String

Sets the second color of a 2 color background gradient of the object. To be used with background-color-1.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

background-fit
backgroundFit		String

Sets the direction/s on which the background image is being "stretched".

"x" | "y" | "xy"

background-image
backgroundImage		String

Sets a background image for the object. Value can be a local file or a web image's location.

"image.png" | ...

background-position
backgroundPosition		String

Sets the position of the background when the background-repeat value is no-repeat.

"0 0" | "50 100" | "80% 60%" | ...

background-repeat
backgroundRepeat		String

Sets the repeating mode for the background image.

"no-repeat" | "repeat" | "repeat-x" | "repeat-y"

border-bottom
borderBottom		String

Sets the object's bottom border style. Accepts solid, dotted, and dashed. Also accepts named colors. If color is not set properly, will default to black.

"2px solid #f00" | ...

border-color
borderColor		String

Sets the border color of the object, applicable on closed shapes. See also line-color for closed shapes.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

border-left
borderLeft		String

Sets the object's left border style. Accepts solid, dashed, and dotted styles.

"2px solid #f00" | ...

border-radius
borderRadius		Mixed

Sets the object's border radius for rounded corners. The higher the value, the more rounded the corners appear.

4 | "6px" | "6px 10px 3px 5px" | "-10px" | ...

border-radius-bottom-left
borderRadiusBottomLeft		Mixed

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.

4 | "6px" | "-6px" | -4 | ...

border-radius-bottom-right
borderRadiusBottomRight		Mixed

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.

4 | "6px" | "-6px" | -4 | ...

border-radius-top-left
borderRadiusTopLeft		Mixed

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.

4 | "6px" | "-6px" | -4 | ...

border-radius-top-right
borderRadiusTopRight		Mixed

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.

4 | "6px" | "-6px" | -4 | ...

border-right
borderRight		String

Sets the object's right border style. Accepts solid, dashed, and dotted styles.

"2px solid #f00" | ...

border-top
borderTop		String

Sets the object's top border style. Values must include the border width, style, and color. Accepts solid, dashed, and dotted styles.

"2px solid #f00" | ...

border-width
borderWidth		Mixed

Sets the border width of the object, applicable on closed shapes. See also line-width for closed shapes.

4 | "6px" | ...

calloutBoolean

Sets whether an object will have a callout arrow or not.

true | false | 1 | 0

callout-extension
calloutExtension		Mixed

Sets the length for an extension line off the tip of the callout arrow.

4 | "6px" | ...

callout-height
calloutHeight		Mixed

Sets the height of the object's callout arrow. A larger value will create a taller callout arrow.

4 | "6px" | ...

callout-hook
calloutHook		Array

Sets a location for the point of the tip of the callout arrow. Uses XY coordinates.

[200, 50] | ...

callout-offset
calloutOffset		Mixed

Sets the offset for the origin of the callout arrow. Uses positive or negative values to move the arrow right/left/up/down.

4 | "6px" | ...

callout-position
calloutPosition		String

Sets the position for the object's callout arrow. The position is "bottom" by default.

"top" | "right" | "bottom" | "left"

callout-width
calloutWidth		Mixed

Sets which edge will be the location for the object's callout arrow.

4 | "6px" | ...

collapseBoolean

Sets legend to be collapsed by default

true | false | 1 | 0

drag-handler
dragHandler		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.

"header" | "icon"

draggableBoolean

Sets whether the legend can be dragged or not.

true | false | 1 | 0

fill-angle
fillAngle		Numeric

Sets the angle of the axis along which the linear gradient is drawn.

-45 | 115 | ...

fill-offset-x
fillOffsetX		Mixed

Sets an X offset to apply to the fill.

4 | "6px" | ...

fill-offset-y
fillOffsetY		Mixed

Sets a Y offset to apply to the fill.

4 | "6px" | ...

fill-type
fillType		String

Sets the background gradient fill type to either linear or radial.

"linear" | "radial"

footerObject

Sets the styling for the legend footer.

{...}

gradient-colors
gradientColors		String

Sets a set of colors for a complex background gradient (more than 2 colors). To be used with gradient-stops.

"#f00 #0f0 #00f" | ...

gradient-stops
gradientStops		String

Sets the position for the introduction of each color for a complex background gradient (more than 2 colors). To be used with gradient-colors.

"0.1 0.5 0.9" | ...

headerObject

Sets the styling for the legend header.

{...}

heightMixed

Sets the object's height.

10 | "20px" | 0.3 | "30%" | ...

highlight-plot
highlightPlot		Boolean

An alias for the "highlight" attribute in the "plot" object. Highlights the corresponding plot when the legend item is moused over.

true | false | 1 | 0

iconObject

Sets the styling for the legend icons (minimize/maximize and drag). Style applies to all icons (minimize/maximize and drag)

{...}

itemObject

Sets the styling for the active legend items.

{...}

item-off
itemOff		Object

Sets the styling for the inactive legend items.

{...}

layoutString

Sets the layout for the legend items.

"horizontal" | "h" | "vertical" | "v" | "row x col" | "x col" | "row x" | "float"

marginMixed

Sets the object's margin/s from the top-left of the chart.

10 | "5px" | "10 20" | "5px 10px 15px 20px" | ...

margin-bottom
marginBottom		Mixed

Sets the object's bottom margin.

4 | "6px" | ...

margin-left
marginLeft		Mixed

Sets the object's left margin.

4 | "6px" | ...

margin-right
marginRight		Mixed

Sets the object's right margin.

4 | "6px" | ...

margin-top
marginTop		Mixed

Sets the object's top margin.

4 | "6px" | ...

markerObject

Sets the styling for the legend markers.

{...}

max-items
maxItems		Numeric

Sets the maximum number of items displayed on the legend. To be used with overflow.

5 | 10 | ...

minimizeBoolean

Sets whether the legend can be minimized or not.

offset-x
offsetX		Mixed

Sets an X offset to apply when positioning the legend. A positive value moves the legend to the right. A negative value moves the legend to the left.

4 | "6px" | ...

offset-y
offsetY		Mixed

Sets a Y offset to apply when positioning the legend. A positive value moves the legend down. A negative value moves the legend up.

4 | "6px" | ...

overflowString

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; scrollwill enable legend scrolling, with top max-items items per page. To be used with max-item.

"none" | "hidden" | "page" | "scroll"

page-off
pageOff		Object

Sets the styling for the inactive page navigation object (previous and next arrows).

{...}

page-on
pageOn		Object

Sets the styling for the active page navigation object (previous and next arrows).

{...}

page-status
pageStatus		Object

Sets the styling for the page status text.

{...}

reverse-series
reverseSeries		BooleanReverses the items in the legend
positionString

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.

scrollObject

To enable legend scrolling.

{...}

shadowBoolean

Sets whether the object's shadow is visible or not.

Has limited effect on HTML5 implementation.

true | false | 1 | 0

shadow-alpha
shadowAlpha		Numeric

Sets the transparency of the shadow of the object. The higher the value, the less transparent the shadow will be.

0.3 | 0.9 | ...

shadow-angle
shadowAngle		Numeric

Sets the angle of the shadow underneath the object.

-45 | 115 | ...

shadow-blur
shadowBlur		Mixed

Sets the blur effect size for the shadow of the object.

Has limited effect on HTML5 implementation.

4 | "6px" | ...

shadow-color
shadowColor		String

Sets the color of the shadow of the object.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

shadow-distance
shadowDistance		Mixed

Sets the distance between the shadow and the object.

4 | "6px" | ...

sharedboolean

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.

true | false | 1 | 0

toggle-action
toggleAction		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.

"hide" | "remove" | "disabled"

tooltipObject

To create and style legend tooltips.

{...}

vertical-align
verticalAlign		String

Automatically aligns the legend and adjusts "plotarea" margins accordingly.

"top" | "middle" | "bottom"

visibleBoolean

Sets the visibility of the object. Allows you to turn off the object without removing lines of JSON.

true | false | 1 | 0

widthMixed

Sets the object's width.

10 | "20px" | 0.3 | "30%" | ...

xMixed

Sets the X position of the object.

10 | "20px" | 0.3 | "30%" | ...

yMixed

Sets the Y position of the object.

10 | "20px" | 0.3 | "30%" | ...