IDrawingToolControlSettings

Type interface

Inheritance

IDrawingToolControlSettings extends IStockControlSettings.

IDrawingToolControlSettings is not extended by any other symbol.

Properties

active
#

Type undefined | false | true

Default false

Inherited from IStockControlSettings

Indicates if control is active.

align
#

Type "left" | "right"

Default "left"

Inherited from IStockControlSettings

Alignment of the control in a toolbar.

description
#

Type undefined | string

Inherited from IStockControlSettings

Description of what the button does.

forceHidden
#

Type undefined | false | true

Inherited from IStockControlSettings

Force this control to always be invisible.

@since 5.8.5
@defaul false

icon
#

Type HTMLElement | SVGElement | "none"

Inherited from IStockControlSettings

An element with control icon. If not set, each control will aytomatically create an icon.

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.

name
#

Type undefined | string

Inherited from IStockControlSettings

Name of the control. Used for the label.

scrollable
#

Type undefined | false | true

If set to true, the dropdown will fix the height to fit within chart's area, with scroll if the contents do not fit.

@since 5.9.5

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.

stockChart
#

Type StockChart

Inherited from IStockControlSettings

A StockChart the toolbar is for.

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.

togglable
#

Type undefined | false | true

Default true

Inherited from IStockControlSettings

If set to true, control can be toggle on and off by clicking on it.

tools
#

Type DrawingTools[]

userData
#

Type any

Inherited from IEntitySettings

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

visible
#

Type undefined | false | true

Default true

Inherited from IStockControlSettings

Is control visible?

There are 16 inherited items currently hidden from this list.