Interface LegendOptions

Whether legend entries should be automatically added and displayed.

Defaults to true for default legend and false for manually added legends (chart.addLegend).

The maximum allowed proportion of the viewport that the legend can occupy before it is automatically hidden. For example, a value of 0.75 means the legend will be hidden if it covers more than 75% of the viewport.

Background FillStyle of the legend.

Background LineStyle of the legend.

Whether the legend background should be visible.

Default LegendEntryOptions for the entries.

Margin between legend entries.

Margin from the main chart element to the legend.

Margin from the legend to the edge of the chart area.

Legend orientation. By default, this is automatically dictated by configured position But it can be forced to a specific value, which can be useful when positioning legends at arbitrary locations.

 // Example syntax, arbitrary location
 chart.legend.setOptions({
     position: {
         x: 0,
         y: 0,
         origin: UIOrigins.UIOrigins.LeftBottom
     },
     orientation: LegendOrientation.Horizontal
 })

Legend content padding.

Position of the legend.

 // Example syntax, choose from preset options
 const chart = lc.ChartXY({
     legend: {
         position: LegendPosition.RightCenter
     }
 })

Alternatively, arbitrary location as pixels relative to container bottom left corner can be specified:

 // Example syntax, arbitrary location
 chart.legend.setOptions({
     position: {
         x: 0,
         y: 0,
         origin: UIOrigins.UIOrigins.LeftBottom
     }
 })

These coordinates are defined in coordsRelative coordinate system.

Whether the legend should be rendered on top of the chart.

Title of the legend.

FillStyle of the legend title.

FontSettings of the legend title.

Whether the legend should be visible.