IDrawingControlSettings

Type interface

Sources

IDrawingControlSettings is an interface: it describes a shape of data and is not imported on its own.

Inheritance

IDrawingControlSettings extends IStockControlSettings.

IDrawingControlSettings is not extended by any other symbol.

Properties

#colors

Type ColorSet

Colors to offer in the color pickers.

More info: Drawing control: colors

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

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

#scrollable

Type undefined | false | trueSince 5.9.5

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

#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 | trueDefault true

Extends new lines with a dotted line beyond both ends.

#snapToData

Type undefined | false | trueDefault false

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

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

#tool

Type DrawingToolsDefault "Line"

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

#tools

Type DrawingTools[]

Tools to list in the tool dropdown.

More info: Drawing control: tool list

#toolSettings

Type undefined | objectSince 5.5.2

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

More info: Drawing control: tool settings

18 inherited items

#active

Type undefined | false | trueDefault falseInherited 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 ArrayInherited from IEntitySettingsSince 5.20.8

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" }
]);

#description

Type undefined | stringInherited from IStockControlSettings

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

#forceHidden

Type undefined | false | trueDefault falseInherited from IStockControlSettingsSince 5.8.5

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

#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 | stringInherited 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 | trueDefault falseInherited from IEntitySettingsSince 5.15.6

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

#name

Type undefined | stringInherited from IStockControlSettings

Label text of the control's button.

#stateAnimationDuration

Type undefined | numberDefault 0Inherited from IEntitySettings

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

0 switches at once.

#stateAnimationEasing

Type $ease.EasingDefault out(cubic)Inherited from IEntitySettings

Easing of the animated switch from one state to another.

#stockChart

Type StockChartInherited from IStockControlSettings

The StockChart the control acts on.

#themes

Type ArrayInherited from IEntitySettings

Themes applied to the element and everything inside it.

#themeTags

Type ArrayInherited 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.

More info: Themes

#themeTagsSelf

Type ArrayInherited from IEntitySettings

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

More info: Themes

#togglable

Type undefined | false | trueDefault trueInherited from IStockControlSettings

A click on the button toggles active.

#userData

Type anyInherited from IEntitySettings

Any data of your own to keep with the element.

#visible

Type undefined | false | trueDefault trueInherited from IStockControlSettings

Shows the control's button; false hides it.