IStockControlSettings

Type interface

Sources

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

Inheritance

IStockControlSettings extends IEntitySettings.

IStockControlSettings is extended by IColorControlSettings, IDateRangeSelectorSettings, IDrawingControlSettings, IDrawingToolControlSettings, IDropdownControlSettings, IDropdownListControlSettings, IIconControlSettings, IPeriodSelectorSettings, IResetControlSettings.

Properties

#active

Type undefined | false | trueDefault false

Turns the control on; its button shows as active.

#align

Type "left" | "right"Default "left"

Side of the toolbar the control is placed on.

#description

Type undefined | string

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

#forceHidden

Type undefined | false | trueDefault falseSince 5.8.5

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

#icon

Type HTMLElement | SVGElement | "none"

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

#name

Type undefined | string

Label text of the control's button.

#stockChart

Type StockChart

The StockChart the control acts on.

#togglable

Type undefined | false | trueDefault true

A click on the button toggles active.

#visible

Type undefined | false | trueDefault true

Shows the control's button; false hides it.

9 inherited items

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

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

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

#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

#userData

Type anyInherited from IEntitySettings

Any data of your own to keep with the element.