IDrawingControlSettings

Type interface

Inheritance

IDrawingControlSettings extends IStockControlSettings.

IDrawingControlSettings 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.

colors
#

Type ColorSet

Colors to show in color pickers.

Click here for more info

description
#

Type undefined | string

Inherited from IStockControlSettings

Description of what the button does.

drawingIcon
#

Type IIcon

drawingIcons
#

Type IIcon[]

fillColor
#

Type Color

Default fill color.

fillOpacity
#

Type undefined | number

Default fill opacity.

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.

labelFill
#

Type Color

Default color for labels.

labelFontFamilies
#

Type string[]

Available fonts for user to choose from.

labelFontFamily
#

Type undefined | string

Default label font.

labelFontSize
#

Type number | string | undefined

Default label font size.

labelFontSizes
#

Type Array

Available font sizes.

labelFontStyle
#

Type "normal" | "italic" | "oblique"

Default label style.

labelFontWeight
#

Type "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900"

Default label font weight.

name
#

Type undefined | string

Inherited from IStockControlSettings

Name of the control. Used for the label.

series
#

Type XYSeries[]

Target series for drawing.

showExtension
#

Type undefined | false | true

Default true

Show dotted/thin line extending from both ends of the drawn line?

snapToData
#

Type undefined | false | true

Default true

Should drawings snap to the nearest data point?

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.

strokeColor
#

Type Color

Default color for lines/borders.

strokeDasharray
#

Type number[]

Default dasharray setting.

strokeDasharrays
#

Type number[]

Available line dash settings for user to choose from.

strokeOpacity
#

Type undefined | number

Default line/border opacity.

strokeWidth
#

Type undefined | number

Default line/border width in pixels.

strokeWidths
#

Type number[]

Available line widths for user to choose from.

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.

tool
#

Type DrawingTools

Default tool.

toolSettings
#

Type undefined | object

Default settings for drawing tools.

@since 5.5.2
Click here for more info

tools
#

Type DrawingTools[]

List of tools available in drawing mode.

Click here for more info

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.