LegendSettings

Type class

Defines a class that carries legend settings.

A legend might change its settings dynamically. Legend can also be shared by several elements, requiring different settings.

Having legend's settings in a separate object is a good way to "hot swap" a set of settings for the legend.

Sources

LegendSettings can be used (imported) via one of the following packages.

// LegendSettings is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Import from: "charts.ts"
 * Use like: am4charts.LegendSettings
 * --------------------------------------------------------
 */
import * as am4charts from "@amcharts/amcharts4/charts";

/**
 * --------------------------------------------------------
 * Import from: "maps.ts"
 * Use like: am4maps.LegendSettings
 * --------------------------------------------------------
 */
import * as am4maps from "@amcharts/amcharts4/maps";

// LegendSettings is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Include via: <script src="charts.js"></script>
 * Access items like: am4charts.LegendSettings
 * --------------------------------------------------------
 */

/**
 * --------------------------------------------------------
 * Include via: <script src="maps.js"></script>
 * Access items like: am4maps.LegendSettings
 * --------------------------------------------------------
 */

Inheritance

LegendSettings does not extend any other symbol.

LegendSettings is not extended by any other symbol.

Properties

createMarker
#

Type boolean

Default true

Should marker be created for each legend item.

itemLabelText
#

Type string

A text template for the label part of the legend item.

itemValueText
#

Type string

A text template for the value part of the legend item.

labelText
#

Type string

[labelText description]

@todo Description

valueText
#

Type string

[valueText description]

@todo Description

Methods

LegendSettings does not have any methods.

Events

LegendSettings does not have any events.

Adapters

LegendSettings does not have any adapters.