Documentation

ISettingsModalSettings

Type interface

Inheritance

ISettingsModalSettings extends IModalSettings.

ISettingsModalSettings is not extended by any other symbol.

Properties

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

ariaLabel
#

Type undefined | string

Inherited from IModalSettings

Name of the dialog for screen readers.

If not set, the first heading (<h1> - <h6>) in the content is used.

@since 5.21.0

content
#

Type undefined | string

Inherited from IModalSettings

HTML content of the modal.
deactivateRoot
#

Type undefined | false | true

Default true

Inherited from IModalSettings

Disables interaction with the chart while the modal is open.

@since 5.2.11

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

showResetLink
#

Type undefined | false | true

Default true

Shows a "Reset to default" link, which puts back the values the fields had when the modal was first opened for that indicator or series.

@since 5.9.0

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

The StockChart the modal belongs to.
strokeWidths
#

Type number[]

Default [1,
2,
4,
10]

Line widths to choose from when editing a line series.

@since 5.11.2

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

Type any

Inherited from IEntitySettings

Any data of your own to keep with the element.
There are 12 inherited items currently hidden from this list.