Native Components
    Wrapper Components
      Introduction
    • Barcodes
    • Buttons
    • Charts
    • Chat
    • DataSource
    • Date Inputs
    • Diagram
    • Dialog
    • Dropdowns
    • DropDownTree
    • Editor
    • Gantt
    • Gauges
    • Grid (wrapper)
    • Inputs
    • Layout
    • List Views
    • ListBox
    • Map
    • MediaPlayer
    • PivotGrid
    • Popups
    • Scheduler
    • ScrollView
    • Spreadsheet
    • TreeList
    • TreeMap
    • TreeView
    • Upload
    • Validator
    • Window
    • Framework & Features
    • Globalization
    • Accessibility
    • Troubleshooting
    Styling & Themes
    Common Features
    Changelog

LegendProps

legend-background String

The background color of the legend. Accepts any valid CSS color string, including hex and rgb.

legend-border-color String

The color of the border.

legend-border-dash-type String

The dash type of the border.

legend-border-width Number

The width of the border.

legend-item-cursor String

The cursor style of the legend item.

legend-item-visual Function

A function for creating a custom visual for the legend items.

The available argument fields are:

  • optionsThe item options.
  • createVisualA function for getting the default visual.

legend-labels-color String

The color of the labels. Accepts any valid CSS color string, including hex and rgb.

legend-labels-font String

The font style of the labels.

legend-labels-template String

The template which renders the labels.

The template supports the following fields:

  • textThe text of the legend item.
  • seriesThe data series.
  • valueThe point value. Available for the Donut and Pie Charts.
  • percentageThe point value represented as a percentage value. Available only for the 100% Stacked charts.
  • dataItemThe original data item that is used to construct the point.

legend-margin Number | Object

The margin of the legend.

legend-offset-x Number

The X offset from its position. The offset is relative to the current position of the legend. For example, a value of 20 will move the legend 20 pixels to the right of its initial position. A negative value will move the legend to the left of the current position.

legend-offset-y Number

The Y offset from its position. The offset is relative to the current position of the legend. For example, a value of 20 will move the legend 20 pixels down from its initial position. A negative value will move the legend upwards from the current position.

legend-padding Number | Object

The padding of the legend.

legend-position String

The positions of the legend.

legend-reverse Boolean

If legend-reverse is set to true, the legend items will be reversed. Available as of version 2013.3.1306 and later.

legend-visible Boolean

The visibility of the legend.

legend-inactive-items-labels-color String

The color of the labels. Accepts any valid CSS color string, including hex and rgb.

legend-inactive-items-labels-font String

The font style of the labels.

legend-inactive-items-labels-template String

The template which renders the labels.

The template supports the following fields:

  • textThe text of the legend item.
  • seriesThe data series.
  • valueThe point value. Available for the Donut and Pie Charts.
  • percentageThe point value represented as a percentage value. Available only for the 100% Stacked charts.
  • dataItemThe original data item that is used to construct the point.

legend-inactive-items-markers-color String

The color of the markers. Accepts any valid CSS color string, including hex and rgb.