legend
Specifies the options of a chart's legend.
The Chart widget can include a legend - an explanatory component that helps you identify a series. Each series is represented by an item on a Legend. An item marker identifies the series color. An item label displays the series title. To set the required position for a legend and its items, to customize the font settings for item labels, and to specify the size of item markers, use the properties of the legend configuration object. To learn more on the legend and its options, refer to the Legend topic.
border
Specifies legend border options.
Use this object to make a legend's border visible/invisible and set up such border options as color, width etc.
columnCount
Specifies how many columns it takes to arrange legend items.
To arrange legend items, specify how many rows and columns they must occupy. To do this, use the rowCount and columnCount properties.
customizeHint
Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item.
Information on the series.
The series' name. To get the Series object by this name, call the getSeriesByName(seriesName) method.
The index of the series in the series array. To get the Series object by this index, call the getSeriesByPos(seriesIndex) method.
The series' color.
The text for the hint to display.
This option accepts a function that must return the required text. When implementing this function, use its parameter to access the information on the series that corresponds to the legend item.
customizeText
Specifies a callback function that returns the text to be displayed by a legend item.
The text for the legend item to display.
By default, legend items identify series by color and name. You can also provide other information instead of the series name. To do this, implement a callback function for this property, and return the required text. Use the fields of the object passed as the function's parameter in the returned text. For instance, you can use the series name or index if it is more appropriate in your case.
Alternatively, you can use the this object within the function. This object has the same structure as the object passed as a parameter.
horizontalAlignment
Specifies a legend's position on the chart.
When using the widget as an ASP.NET MVC Control, specify this option using the HorizontalAlignment enum. This enum accepts the following values: Left, Center and Right.
hoverMode
Specifies what series elements to highlight when a corresponding item in the legend is hovered over.
In the Chart widget, legend items represent series. When a legend item is hovered over, the corresponding series is highlighted. To prevent this behavior, set the hoverMode property to 'none'.
You can set a custom 'hover' style for a series and/or its points. To do this, use the series' hoverStyle configuration object and/or the point.hoverStyle configuration object.
When using the widget as an ASP.NET MVC Control, specify this option using the ChartLegendHoverMode enum. This enum accepts the following values: IncludePoints, ExcludePoints and None.
itemsAlignment
Specifies the alignment of legend items.
This option is useful when there is an odd count of items in the legend and they are placed in several columns.
When using the widget as an ASP.NET MVC Control, specify this option using the HorizontalAlignment enum. This enum accepts the following values: Left, Center and Right.
itemTextPosition
Specifies the position of text relative to the item marker.
A legend item consists of a marker that indicates the series (for the Chart widget) / point (for the PieChart widget) color and text that specifies the name of the series/point. Use the itemTextPosition property to specify the position of the text relative to the item marker.
margin
Specifies the distance between the legend and surrounding widget elements or container borders in pixels.
When this option is set to a number, the specified margin applies to all the sides of the legend. Alternatively, the margin option can be set to an object. This object specifies margins for each side of the legend separately.
Whether or not the specified margin is applied to a particular side of the legend depends on the legend's location. The location is determined by the horizontalAlignment and verticalAlignment options. Refer to the top, bottom, left and right options' description to discover when the margin applies to the corresponding side of the legend.
orientation
Specifies whether to place legend items horizontally or vertically.
When this option is set to 'vertical', legend items are displayed vertically (i.e., in a column). When this option is set to 'horizontal', legend items are displayed horizontally (i.e, in a row). When this option is not defined, the legend orientation is chosen automatically.
When using the widget as an ASP.NET MVC Control, specify this option using the Orientation enum. This enum accepts the following values: Horizontal and Vertical.
paddingLeftRight
Specifies a blank space between a legend's left/right boundaries and the inner item boundaries in pixels.
paddingTopBottom
Specifies a blank space between a legend's top/bottom boundaries and the inner item boundaries in pixels.
position
Specifies whether the legend is located outside or inside the chart's plot.
In addition to this option, use the legend's horizontalAlignment, verticalAlignment and orientation options to specify the legend layout.
When using the widget as an ASP.NET MVC Control, specify this option using the RelativePosition enum. This enum accepts the following values: Inside and Outside.
rowCount
Specifies how many rows it takes to arrange legend items.
To arrange legend items, specify how many rows and columns they must occupy. To do this, use the rowCount and columnCount properties.
verticalAlignment
Specifies a legend's position on the chart.
When using the widget as an ASP.NET MVC Control, specify this option using the VerticalEdge enum. This enum accepts the following values: Top and Bottom.