Documentation

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

Turns the control on; its button shows as active.
align
#

Type "left" | "right"

Default "left"

Inherited from IStockControlSettings

Side of the toolbar the control is placed on.
animations
#

Type Array

Inherited from IEntitySettings

Animations the element plays on its own, described as data - so they can be set from a JSON config and saved with it.

Each one animates a setting of the element (or, with target: "dataItem", a value of its data item - a map point's positionOnLine, say). They start when the setting is applied, restart when it changes, and stop when the element is disposed. A saved config keeps what was configured, never a value caught half way through an animation.

sprite.set("animations", [
  { key: "rotation", to: 360, duration: 4000, loops: 0 },
  { key: "scale", from: 1, to: 1.3, duration: 800, loops: 0, yoyo: true, easing: "sine" }
]);

@since 5.20.8

colors
#

Type ColorSet

Colors to offer in the color pickers.

Click here for more info

description
#

Type undefined | string

Inherited from IStockControlSettings

What the control does, shown as the button's tooltip. Falls back to name.
drawingIcon
#

Type IIcon

Icon that the icon tool draws.
drawingIcons
#

Type IIcon[]

Icons to choose from for the icon tool.
fillColor
#

Type Color

Fill color of new drawings.
fillOpacity
#

Type undefined | number

Fill opacity of new drawings, from 0 to 1.
forceHidden
#

Type undefined | false | true

Default false

Inherited from IStockControlSettings

Keeps the control hidden, even when show() is called.

@since 5.8.5

icon
#

Type HTMLElement | SVGElement | "none"

Inherited from IStockControlSettings

Icon element of the button, or "none" for no icon. Each control has its own default icon.
id
#

Type undefined | string

Inherited from IEntitySettings

A unique ID for looking the element up in root.entitiesById. Setting an ID that another element already has throws an error.
ignoreThemes
#

Type undefined | false | true

Default false

Inherited from IEntitySettings

Ignores themes: no theme rule applies to the element, not even one of the default theme.

@since 5.15.6

labelFill
#

Type Color

Text color of new labels and callouts.
labelFontFamilies
#

Type string[]

Font families to choose from.
labelFontFamily
#

Type undefined | string

Font family of new labels and callouts.

"inherit" uses the computed font of the chart's container (since 5.17.3).
labelFontSize
#

Type number | string | undefined

Font size of new labels and callouts.
labelFontSizes
#

Type Array

Font sizes to choose from.
labelFontStyle
#

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

Font style of new labels and callouts.
labelFontWeight
#

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

Font weight of new labels and callouts.
name
#

Type undefined | string

Inherited from IStockControlSettings

Label text of the control's button.
scrollable
#

Type undefined | false | true

Limits the tool list's height to the chart's height minus 100 pixels, scrolling the rest.

@since 5.9.5

series
#

Type XYSeries[]

Series to attach drawings to. Each panel's main series (stockSeries on its panel, the first series on others) is added automatically.
showExtension
#

Type undefined | false | true

Default true

Extends new lines with a dotted line beyond both ends.
snapToData
#

Type undefined | false | true

Default false

Snaps the points of new drawings to the values of the nearest data items.
stateAnimationDuration
#

Type undefined | number

Default 0

Inherited from IEntitySettings

How long, in milliseconds, a switch from one state to another animates.

0 switches at once.
stateAnimationEasing
#

Type $ease.Easing

Default out(cubic)

Inherited from IEntitySettings

Easing of the animated switch from one state to another.
stockChart
#

Type StockChart

Inherited from IStockControlSettings

The StockChart the control acts on.
strokeColor
#

Type Color

Line color of new drawings; changing it also restyles the selected ones.
strokeDasharray
#

Type number[]

Dash pattern of new drawings' lines, such as [2, 2], or [] for a solid line.
strokeDasharrays
#

Type number[]

Dash patterns to choose from.
strokeOpacity
#

Type undefined | number

Line opacity of new drawings, from 0 to 1.
strokeWidth
#

Type undefined | number

Line width of new drawings, in pixels.
strokeWidths
#

Type number[]

Line widths to choose from, in pixels.
themeTags
#

Type Array

Inherited from IEntitySettings

Tags that theme rules can target. They also count for the element's children, so a rule can match a child by a tag of its parent.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

Tags that theme rules can target, like themeTags, but only for this element, not its children.

Click here for more info

themes
#

Type Array

Inherited from IEntitySettings

Themes applied to the element and everything inside it.
togglable
#

Type undefined | false | true

Default true

Inherited from IStockControlSettings

A click on the button toggles active.
tool
#

Type DrawingTools

Default "Line"

The tool in use; the one set at the start is the default.
toolSettings
#

Type undefined | object

Settings for the drawing series of each tool, keyed by tool name.

@since 5.5.2
Click here for more info

tools
#

Type DrawingTools[]

Tools to list in the tool dropdown.

Click here for more info

userData
#

Type any

Inherited from IEntitySettings

Any data of your own to keep with the element.
visible
#

Type undefined | false | true

Default true

Inherited from IStockControlSettings

Shows the control's button; false hides it.
There are 18 inherited items currently hidden from this list.