Legend

Type class

A universal legend control.

Click here for more info

Data item

Legend uses data items of type ILegendDataItem.

Sources

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

// Import Legend
import * as am5 from "@amcharts/amcharts5";

// Create Legend
am5.Legend.new(root, {
  // ... config if applicable
});
<!-- Load Legend -->
<script src="index.js"></script>

<script>
// Create Legend
am5.Legend.new(root, {
  // ... config if applicable
});
</script>

Inheritance

Legend extends Series.

Legend is extended by StockLegend.

Settings

Set these settings on a Legend object using its set() and setAll() methods.

Read about settings concept.

active
#

Type undefined | false | true

Inherited from ISpriteSettings

Indicates if element is currently active.

background
#

Type Graphics

Inherited from IContainerSettings

Background element.

Click here for more info

blur
#

Type undefined | number

Inherited from ISpriteSettings

Apply blur filter.

Ranges of values in pixels: 0 to X.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

brightness
#

Type undefined | number

Inherited from ISpriteSettings

Modifty visual brightness.

Range of values: 0 to 1.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

calculateAggregates
#

Type undefined | false | true

Inherited from ISeriesSettings

If set to true, series will calculate aggregate values, e.g. change percent, high, low, etc.

Do not enable unless you are using such aggregate values in tooltips, display data fields, heat rules, or similar.

centerX
#

Type number | Percent

Inherited from ISpriteSettings

X coordinate of the center of the element relative to itself.

Center coordinates will affect placement as well as rotation pivot point.

centerY
#

Type number | Percent

Inherited from ISpriteSettings

Y coordinate of the center of the element relative to itself.

Center coordinates will affect placement as well as rotation pivot point.

clickTarget
#

Type "itemContainer" | "marker" | "none"

Default "itemContainer"

Which legend item element will be clickable to toggle related chart item:

  • "itemContainer" - the whole legend item (default).
  • "marker" - legend item marker.
  • "none" - disables toggling of legend item.

@since 5.0.13

contrast
#

Type undefined | number

Inherited from ISpriteSettings

Modify contrast.

Range of values: 0 to 1.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

crisp
#

Type undefined | false | true

Default false

Inherited from ISpriteSettings

If set to true, an element will try to draw itself in such way, that it looks crisp on screen, with minimal anti-aliasing.

It will round x/y position so it is positioned fine "on pixel".

It will also adjust strokeWidth based on device pixel ratio or zoom, so the line might look thinner than expected.

NOTE: this is might not universally work, especially when set on several objects that are supposed to fit perfectly with each other.

@since 5.3.0

cursorOverStyle
#

Type undefined | string

Inherited from ISpriteSettings

A named mouse cursor style to show when hovering this element.

Click here for more info

customValueField
#

Type undefined | string

Inherited from ISeriesSettings

A key to look up in data for a numeric customValue of the data item.

Usually used for storing additional numeric information and heat rules.

dateFormatter
#

Type DateFormatter | undefined

Inherited from ISpriteSettings

An instance of DateFormatter that should be used instead of global formatter object.

Click here for more info

disabled
#

Type undefined | false | true

Inherited from ISpriteSettings

Indicates if element is disabled.

draggable
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true, user will be able to drag this element. It will also disable default drag events over the area of this element.

durationFormatter
#

Type DurationFormatter | undefined

Inherited from ISpriteSettings

An instance of DurationFormatter that should be used instead of global formatter object.

Click here for more info

dx
#

Type undefined | number

Inherited from ISpriteSettings

Horizontal shift in pixels. Can be negative to shift leftward.

dy
#

Type undefined | number

Inherited from ISpriteSettings

Vertical shift in pixels. Can be negative to shift upward.

exportable
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to false this element will not appear in exported snapshots of the chart.

fill
#

Type Color

Inherited from ISeriesSettings

Series fill color.

Click here for more info

fillField
#

Type undefined | string

A key to look up in data for a fill of the data item.

fillPattern
#

Type Pattern

Inherited from ISeriesSettings

Series fill pattern.

Click here for more info
@since 5.10.0

forceHidden
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true the element will be hidden regardless of visible or even if show() is called.

forceInactive
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true the element will be inactive - absolutely oblivious to all interactions, even if there are related events set, or the interactive: true is set.

@since 5.0.21

heatRules
#

Type IHeatRule[]

Inherited from ISeriesSettings

A list of heat rules to apply on series elements.

Click here for more info

height
#

Type number | Percent | null

Inherited from ISpriteSettings

Element's absolute height in pixels (numeric value) or relative height to parent (Percent);

html
#

Type undefined | string

Inherited from IContainerSettings

HTML content of the container.

Click here for more info
@since 5.2.11

hue
#

Type undefined | number

Inherited from ISpriteSettings

Rotate HUE colors in degrees.

Range of values: 0 to 360.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

id
#

Type undefined | string

Inherited from IEntitySettings

A custom string ID for the element.

If set, element can be looked up via am5.registry.entitiesById.

Will raise error if an element with the same ID already exists.

idField
#

Type undefined | string

Inherited from ISeriesSettings

A key to look up in data for an id of the data item.

interactive
#

Type undefined | false | true

Inherited from ISpriteSettings

Should this element accept user interaction events?

interactiveChildren
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true all descendants - not just direct children, but every element in it - will become "interactive".

interpolationDuration
#

Type undefined | number

Inherited from IComponentSettings

A duration of the animation from one setting value to another, in milliseconds.

Click here for more info

interpolationEasing
#

Type $ease.Easing

Inherited from IComponentSettings

Easing function to use for cross setting value animations.

Click here for more info

invert
#

Type undefined | number

Inherited from ISpriteSettings

Invert colors.

Range of values: 0 (no changes) to 1 (completely inverted colors).

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

isMeasured
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to false element will not be measured and cannot participate in layout schemes.

layer
#

Type undefined | number

Inherited from ISpriteSettings

Numeric layer to put element in.

Elements with higher number will appear in front of the ones with lower numer.

If not set, will inherit layer from its ascendants.

layerMargin
#

Type IMargin

Inherited from ISpriteSettings

Margins for the layer.

Can be used to make the layer larger/or smaller than default chart size.

@since @5.2.39

layout
#

Type Layout | null

Inherited from IContainerSettings

A method to layout

Click here for more info

legendDataItem
#

Type DataItem

Inherited from ISeriesSettings

A data item representing series in a Legend.

@readonly

legendLabelText
#

Type undefined | string

Inherited from ISeriesSettings

A text template to be used for label in legend.

legendValueText
#

Type undefined | string

Inherited from ISeriesSettings

A text template to be used for value label in legend.

marginBottom
#

Type undefined | number

Inherited from ISpriteSettings

Bottom margin in pixels.

marginLeft
#

Type undefined | number

Inherited from ISpriteSettings

Left margin in pixels.

marginRight
#

Type undefined | number

Inherited from ISpriteSettings

Right margin in pixels.

marginTop
#

Type undefined | number

Inherited from ISpriteSettings

Top margin in pixels.

mask
#

Type Graphics | null

Inherited from IContainerSettings

An element to use as a container's mask (clipping region).

Click here for more info

maskContent
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true all content going outside the bounds of the container will be clipped.

maxHeight
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed height in pixels.

maxWidth
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed width in pixels.

minHeight
#

Type number | null

Inherited from ISpriteSettings

Minimum allowed height in pixels.

minWidth
#

Type number | null

Inherited from ISpriteSettings

Minimum allowed width in pixels.

name
#

Type undefined | string

Inherited from ISeriesSettings

Name of the series.

nameField
#

Type undefined | string

A key to look up in data for a name of the data item.

numberFormatter
#

Type NumberFormatter | undefined

Inherited from ISpriteSettings

An instance of NumberFormatter that should be used instead of global formatter object.

Click here for more info

opacity
#

Type undefined | number

Inherited from ISpriteSettings

Opacity. 0 - fully transparent; 1 - fully opaque.

paddingBottom
#

Type undefined | number

Inherited from IContainerSettings

Bottom padding in pixels.

paddingLeft
#

Type undefined | number

Inherited from IContainerSettings

Left padding in pixels.

paddingRight
#

Type undefined | number

Inherited from IContainerSettings

Right padding in pixels.

paddingTop
#

Type undefined | number

Inherited from IContainerSettings

Top padding in pixels.

position
#

Type "absolute" | "relative"

Inherited from ISpriteSettings

Positioning of the element.

"absolute" means element will not participate in parent layout scheme, and will be positioned solely accoridng its x and y settings.

reverseChildren
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true its children will be laid out in opposite order.

@since 5.1.1

rotation
#

Type undefined | number

Inherited from ISpriteSettings

Rotation in degrees.

saturate
#

Type undefined | number

Inherited from ISpriteSettings

Modify saturation.

Range of values in pixels: 0 to X.

  • 0 - grayscale
  • 1 - no changes
  • >1 - more saturated IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

scale
#

Type undefined | number

Inherited from ISpriteSettings

Scale.

Setting to a value less than 1 will shrink object.

sepia
#

Type undefined | number

Inherited from ISpriteSettings

Apply sepia filter.

Range of values: 0 (no changes) to 1 (complete sepia).

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

sequencedDelay
#

Type undefined | number

Inherited from ISeriesSettings

A delay in milliseconds to wait before starting animation of next data item.

Click here for more info

sequencedInterpolation
#

Type undefined | false | true

Inherited from ISeriesSettings

If set to true the series initial animation will be played item by item rather than all at once.

Click here for more info

setStateOnChildren
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true, applying a state on a container will also apply the same state on its children.

Click here for more info

showTooltipOn
#

Type "hover" | "always" | "click"

Default "hover"

Inherited from ISpriteSettings

Defines when tooltip is shown over the element.

Available options:

  • "hover" (default) - tooltip is shown when element is hovered by a pointer or touched. It is hidden as soon as element is not hovered anymore, or touch occurs outside it.
  • "always" - a tooltip will always be shown over the element, without any interactions. Please note that if you need to show tooltips for multiple elements at the same time, you need to explicitly create a Tooltip instance and set element's tooltip setting with it.
  • '"click"' - a tooltip will only appear when target element is clicked/tapped. Tooltip will hide when clicking anywhere else on the page.

Click here for more info
@since 5.0.16

stateAnimationDuration
#

Type undefined | number

Inherited from IEntitySettings

Duration of transition from one state to another.

stateAnimationEasing
#

Type $ease.Easing

Inherited from IEntitySettings

Easing of transition from one state to another.

stroke
#

Type Color

Inherited from ISeriesSettings

Series stroke color.

Click here for more info

strokeField
#

Type undefined | string

A key to look up in data for a stroke of the data item.

templateField
#

Type undefined | string

Inherited from ISpriteSettings

Allows binding element's settings to data.

Click here for more info

themeTags
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

These tags only apply to this object, not any children.

Click here for more info

themes
#

Type Array

Inherited from IEntitySettings

A list of themes applied to the element.

toggleKey
#

Type "disabled" | "active" | "none" | undefined

Inherited from ISpriteSettings

If set, element will toggle specified boolean setting between true and false when clicked/touched.

tooltip
#

Type Tooltip

Inherited from ISpriteSettings

Tooltip instance.

tooltipHTML
#

Type undefined | string

Inherited from ISpriteSettings

HTML content to show in a tooltip when hovered.

@since 5.2.11

tooltipPosition
#

Type "fixed" | "pointer"

Inherited from ISpriteSettings

Tooltip position.

tooltipText
#

Type undefined | string

Inherited from ISpriteSettings

Text to show in a tooltip when hovered.

tooltipX
#

Type number | Percent

Inherited from ISpriteSettings

Tooltip pointer X coordinate relative to the element itself.

tooltipY
#

Type number | Percent

Inherited from ISpriteSettings

Tooltip pointer Y coordinate relative to the element itself.

useDefaultMarker
#

Type undefined | false | true

Default false

If set to true the legend will not try to mimic appearance of the actual item but rather show default square marker.

userData
#

Type any

Inherited from IEntitySettings

A storage for any custom user data that needs to be associated with the element.

valueField
#

Type undefined | string

Inherited from ISeriesSettings

A key to look up in data for a numeric value of the data item.

Some series use it to display its elements. It can also be used in heat rules.

verticalScrollbar
#

Type Scrollbar

Inherited from IContainerSettings

Setting this to an instance of Scrollbar will enable vertical scrolling of content if it does not fit into the Container.

Click here for more info

visible
#

Type undefined | false | true

Inherited from ISpriteSettings

Is element visible?

wheelable
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true, mouse wheel events will be triggered over the element. It will also disable page scrolling using mouse wheel when pointer is over the element.

width
#

Type number | Percent | null

Inherited from ISpriteSettings

Element's absolute width in pixels (numeric value) or relative width to parent (Percent);

x
#

Type number | Percent | null

Inherited from ISpriteSettings

X position relative to parent.

y
#

Type number | Percent | null

Inherited from ISpriteSettings

Y position relative to parent.

There are 89 inherited items currently hidden from this list.

Private settings

These are read-only settings accessible from a Legend object using its getPrivate() method.

Read about private settings.

adjustedStartIndex
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

baseValueSeries
#

Read only

Type Series

Inherited from ISeriesPrivate

customValueAbsoluteSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueAverage
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueClose
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueCount
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueHigh
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueLow
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueOpen
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

endIndex
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

focusable
#

Read only

Type undefined | false | true

Inherited from ISpritePrivate

If set to false, its tabindex will be set to -1, so it does not get focused with TAB, regardless whether its public setting focusable is set to true.

@since 5.3.16

htmlElement
#

Read only

Type HTMLDivElement

Inherited from IContainerPrivate

A <div> element used for HTML content of the Container.

showingTooltip
#

Read only

Type undefined | false | true

Inherited from ISpritePrivate

Is element currently showing a tooltip?

startIndex
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

tooltipTarget
#

Read only

Type Graphics

Inherited from ISpritePrivate

An element tooltip should inherit its colors from.

trustBounds
#

Read only

Type undefined | false | true

Inherited from ISpritePrivate

If set to true, the sprite will check if a mouse pointer is within its bounds before dispatching pointer events.

This helps to solve ghost tooltips problem that sometimes appear while moving the pointer over interactive objects.

This is set to true by default on Rectangle and Circle.

@since 5.5.0

valueAbsoluteSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueAverage
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueClose
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueCount
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueHigh
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueLow
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueOpen
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

There are 25 inherited items currently hidden from this list.

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity

bullets
#

Type List

Default new List()

Inherited from Series

List of bullets to use for the series.

Click here for more info

bulletsContainer
#

Type Container

Default Container.new()

Inherited from Series

A Container series' bullets are stored in.

chart
#

Type Chart | undefined

Inherited from Series

A chart series belongs to.

children
#

Type Children

Default new Children(this)

Inherited from Container

List of Container's child elements.

className
#

Static

Type string

Default "Legend"

classNames
#

Static

Type Array

Default "Legend", "Series", "Component", "Container", "Sprite", "Entity"

data
#

Type ListData

Inherited from Component

Component's data.

Click here for more info

dataItem
#

Type DataItem | undefined

Inherited from Sprite

A DataItem used for this element.

NOTE: data item is being assigned automatically in most cases where it matters. Use this accessor to set data item only if you know what you're doing.

dataItems
#

Type Array

Inherited from Component

A list of component's data items.

enableDispose
#

Type boolean

Default true

Inherited from Settings

If this is set to false then disposing does nothing, it's a no-op.

events
#

Type SpriteEventDispatcher

Inherited from Sprite

inited
#

Type boolean

Default false

Inherited from Component

Indicates if the component has already been initialized.

itemContainers
#

Type ListTemplate

Default new ListTemplate<Container>

List of all Container elements for legend items.

labels
#

Type ListTemplate

Default new ListTemplate<Label>

List of legend label elements.

markerRectangles
#

Type ListTemplate

Default new ListTemplate<RoundedRectangle>

List of rectangle elements used for default legend markers.

markers
#

Type ListTemplate

Default new ListTemplate<Container>

List of legend marker elements.

parent
#

Type Container | undefined

Inherited from Sprite

Parent Container of this element.

root
#

Type Root

Inherited from Entity

An instance of Root object.

@readonly
@since 5.0.6

states
#

Type States

Default new States(this)

Inherited from Entity

template
#

Type Template | undefined

Inherited from Entity

@todo needs description

uid
#

Type number

Default ++counter

Inherited from Settings

Unique ID.

valueLabels
#

Type ListTemplate

Default new ListTemplate<label>

List of legend value label elements.

There are 16 inherited items currently hidden from this list.

Methods

addBullet(

dataItem: DataItem,
bullet: Bullet

)

#

Returns void

Inherited from Series

Adds bullet directly to a data item.

Please note: method accepts Bullet instance as a paramter, not a reference to a function.

You should add Bullet instance, not a method like you do it on series.

Click here for more info
@since 5.6.0

allChildren()

#

Returns Array

Inherited from Container

animate(

options: AnimationOptions

)

#

Returns Animation

Inherited from Settings

Animates setting values from current/start values to new ones.

Click here for more info

appear(

duration?: undefined | number,
delay?: undefined | number

)

#

Returns Promise

Inherited from Sprite

Plays initial reveal animation regardless if element is currently hidden or visible.

compositeOpacity()

#

Returns number

Inherited from Sprite

Returns an actual opacity of the element, taking into account all parents.

@since 5.2.11

compositeRotation()

#

Returns number

Inherited from Sprite

Returns an actual roation of the element, taking into account all parents.

@since 5.9.2

compositeScale()

#

Returns number

Inherited from Sprite

Returns an actual scale of the element, taking into account all parents.

@since 5.9.2

depth()

#

Returns number

Inherited from Sprite

Returns depth (how deep in the hierachy of the content tree) of this element.

dispose()

#

Returns void

Inherited from Settings

Disposes this object.

eachChildren(

f: ( child: Sprite) => void

)

#

Returns void

Inherited from Container

endIndex()

#

Returns number

Inherited from Series

get(

key: Key,
fallback: F

)

#

Returns NonNullable | F

Inherited from Entity

Returns settings value for the specified key.

If there is no value, fallback is returned instead (if set).

Click here for more info

getDataItemById(

id: string

)

#

Returns DataItem | undefined

Inherited from Series

Looks up and returns a data item by its ID.

getDateFormatter()

#

Returns DateFormatter

Inherited from Sprite

Returns an instance of DateFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getDurationFormatter()

#

Returns DurationFormatter

Inherited from Sprite

Returns an instance of DurationFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getNumberFormatter()

#

Returns NumberFormatter

Inherited from Sprite

Returns an instance of NumberFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getTooltip()

#

Returns Tooltip | undefined

Inherited from Sprite

Returns Tooltip used for this element.

has(

key: Key

)

#

Returns boolean

Inherited from Settings

Returns true if the setting exists.

Click here for more info

height()

#

Returns number

Inherited from Sprite

Returns height of this element in pixels.

hide(

duration?: undefined | number

)

#

Returns Promise

Inherited from Sprite

Hides the element and returns a Promise which completes when all hiding animations are finished.

series.hide().then(function(ev) {
  console.log("Series finished hiding");
})
series.hide().then(function(ev) {
  console.log("Series finished hiding");
})

hideDataItem(

dataItem: DataItem,
duration?: undefined | number

)

#

Returns Promise

Inherited from Series

Hides series's data item.

hideTooltip()

#

Returns void

Inherited from Sprite

Hides element's Tooltip.

hover()

#

Returns void

Inherited from Sprite

Simulate hover over element.

innerHeight()

#

Returns number

Inherited from Container

Returns container's inner height (height without padding) in pixels.

innerWidth()

#

Returns number

Inherited from Container

Returns container's inner width (width without padding) in pixels.

isDisposed()

#

Returns boolean

Inherited from Settings

Returns true if this element is disposed.

isDragging()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently being dragged.

isFocus()

#

Returns boolean

Inherited from Sprite

Returns true if this element does currently have focus.

isHidden()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently hidden.

isHiding()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently animating to a hidden state.

isHover()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently hovered by a pointer.

isShowing()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently animating to a default state.

isType(

type: string

)

#

Returns this

Inherited from Entity

Checks if element is of certain class (or inherits one).

isVisible()

#

Returns boolean

Inherited from Sprite

Returns false if if either public or private setting visible is set to false, or forceHidden is set to true.

isVisibleDeep()

#

Returns boolean

Inherited from Sprite

Same as isVisible(), except it checks all ascendants, too.

@since 5.2.7

makeDataItem(

data: ILegendDataItem,
dataContext?: any

)

#

Returns DataItem

Inherited from Component

Creates a new data item and processes it.

markDirtyKey(

key: Key

)

#

Returns void

Inherited from Sprite

Marks some setting as dirty. Could be used to trigger adapter.

markDirtyValues(

_dataItem?: DataItem

)

#

Returns void

Inherited from Component

Forces a repaint of the element which relies on data.

@since 5.0.21

maxHeight()

#

Returns number

Inherited from Sprite

Returns maximum allowed height of this element in pixels.

maxWidth()

#

Returns number

Inherited from Sprite

Returns maximum allowed width of this element in pixels.

new(

root: Root,
settings: ITSettings,
template?: Template

)

#

Static

Returns T

Inherited from Entity

Use this method to create an instance of this class.

Click here for more info

off(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

#

Returns void

Inherited from Settings

Removes a callback for when value of a setting changes.

Click here for more info
@since 5.9.2

offPrivate(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

#

Returns void

Inherited from Settings

Removes a callback for when value of a private setting changes.

Click here for more info
@since 5.9.2

on(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of settings changes or is set.

Click here for more info

onPrivate(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of private settings changes or is set.

Click here for more info

pushDataItem(

data: ILegendDataItem,
dataContext?: any

)

#

Returns DataItem

Inherited from Component

Adds new explicit data item to series.

remove(

key: Key

)

#

Returns void

Inherited from Entity

Removes a setting value for the specified key.

Click here for more info

removeAll()

#

Returns void

Inherited from Settings

Removes all keys;

Click here for more info

scrollToChild(

child: Sprite

)

#

Returns void

Inherited from Container

If scrolling is enabled on the Container (by adding verticalScrollbar) the Container will scroll in such way so that target element becomes visible if its currently outside of view.

@since 5.10.5

set(

key: Key,
value: Value

)

#

Returns Value

Inherited from Entity

Sets a setting value for the specified key, and returns the same value.

Click here for more info

setAll(

settings: Partial

)

#

Returns void

Inherited from Settings

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

setTimeout(

fn: () => void,
delay: number

)

#

Returns IDisposer

Inherited from Entity

Creates and returns a "disposable" timeout.

show(

duration?: undefined | number

)

#

Returns Promise

Inherited from Sprite

Shows currently hidden element and returns a Promise which completes when all showing animations are finished.

series.show().then(function(ev) {
  console.log("Series is now fully visible");
})
series.show().then(function(ev) {
  console.log("Series is now fully visible");
})

showDataItem(

dataItem: DataItem,
duration?: undefined | number

)

#

Returns Promise

Inherited from Series

Shows series's data item.

showTooltip(

point?: IPoint

)

#

Returns void

Inherited from Sprite

Shows element's Tooltip.

startIndex()

#

Returns number

Inherited from Series

toBack()

#

Returns void

Inherited from Sprite

Moves sprite to the beginning of the parent's children array.

Depending on layout setting of the parten container, it may effect the positioning or overlapping order of the elements.

toFront()

#

Returns void

Inherited from Sprite

Moves sprite to the end of the parent's children array.

Depending on layout setting of the parten container, it may effect the positioning or overlapping order of the elements.

toGlobal(

point: IPoint

)

#

Returns IPoint

Inherited from Sprite

Converts X/Y coordinate within this element to a global coordinate.

toLocal(

point: IPoint

)

#

Returns IPoint

Inherited from Sprite

Converts global X/Y coordinate to a coordinate within this element.

unhover()

#

Returns void

Inherited from Sprite

Simulate unhover over element.

width()

#

Returns number

Inherited from Sprite

Returns width of this element in pixels.

x()

#

Returns number

Inherited from Sprite

Returns element's actual X position in pixels.

y()

#

Returns number

Inherited from Sprite

Returns element's actual Y position in pixels.

There are 64 inherited items currently hidden from this list.

Events

Add event handlers to Legend object using its events.on() method.

Read about adding event handlers.

#blur

Param { originalEvent: FocusEvent,
  target: Sprite,
  type: "blur",
  target: this }

Inherited from ISpriteEvents

Invoked when element loses focus.

#boundschanged

Param { type: "boundschanged",
  target: this }

Inherited from ISpriteEvents

Invoked when element's bounds change due to any manipulation to it.

#click

Param { type: "click",
  target: this }

Inherited from ISpriteEvents

Invoked when element is clicked or tapped.

#dataitemchanged

Param { newDataItem: DataItem | undefined,
  oldDataItem: DataItem | undefined,
  type: "dataitemchanged",
  target: this }

Inherited from ISpriteEvents

Invoked when element's data item changes.

#datavalidated

Param { type: "datavalidated",
  target: this }

Inherited from IComponentEvents

#dblclick

Param { type: "dblclick",
  target: this }

Inherited from ISpriteEvents

Invoked when element is doubleclicked or tapped twice quickly.

#dragged

Param { type: "dragged",
  target: this }

Inherited from ISpriteEvents

Invoked when element ois being dragged.

#dragstart

Param { type: "dragstart",
  target: this }

Inherited from ISpriteEvents

Invoked when element dragging starts.

#dragstop

Param { type: "dragstop",
  target: this }

Inherited from ISpriteEvents

Invoked when element dragging stops.

#focus

Param { originalEvent: FocusEvent,
  target: Sprite,
  type: "focus",
  target: this }

Inherited from ISpriteEvents

Invoked when element gains focus.

#globalpointermove

Param { type: "globalpointermove",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer is moving anywhere in the window, even outside of the element or even chart area.

#globalpointerup

Param { type: "globalpointerup",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer button is released or touch stops in the window, even outside of the element or even chart area.

#middleclick

Param { type: "middleclick",
  target: this }

Inherited from ISpriteEvents

Invoked when element is clicked with the middle mouse button.

#pointerdown

Param { type: "pointerdown",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer button is pressed or touch starts over the element.

#pointerout

Param { type: "pointerout",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer moves outside the element.

#pointerover

Param { type: "pointerover",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer moves over the element.

#pointerup

Param { type: "pointerup",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer button is released or touch stops over the element.

#positionchanged

Param { type: "positionchanged",
  target: this }

Inherited from ISpriteEvents

Invoked when element's position (X/Y) changes.

#rightclick

Param { type: "rightclick",
  target: this }

Inherited from ISpriteEvents

Invoked when element is clicked width the right mouse button.

#wheel

Param { originalEvent: WheelEvent,
  point: IPoint,
  type: "wheel",
  target: this }

Inherited from ISpriteEvents

Invoked when mouse wheel is spinned while pointer is over the element.

There are 20 inherited items currently hidden from this list.