IInterfaceColorsSettings

Type interface

Sources

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

Inheritance

IInterfaceColorsSettings extends IEntitySettings.

IInterfaceColorsSettings is not extended by any other symbol.

Properties

#alternativeBackground

Type Color

A color that contrasts with background, for elements that should stand out from it, such as tooltips.

#alternativeText

Type Color

Text color over alternativeBackground, such as in tooltips.

#background

Type Color

Background color, for elements that should blend with what is behind the chart, such as legend item backgrounds.

#disabled

Type Color

Color for disabled elements.

#fill

Type Color

Color for general fills, such as a scrollbar's background.

#grid

Type Color

Color of grid lines.

#negative

Type Color

Color for negative values, such as a fall.

#positive

Type Color

Color for positive values, such as a rise.

#primaryButton

Type Color

Primary button fill color.

#primaryButtonActive

Type Color

Primary button fill color when active.

#primaryButtonDisabled

Type Color

Primary button fill color when disabled.

#primaryButtonDown

Type Color

Primary button fill color while pressed.

#primaryButtonHover

Type Color

Primary button fill color on hover.

#primaryButtonStroke

Type Color

Primary button stroke (outline) color.

#primaryButtonText

Type Color

Primary button text color.

#primaryButtonTextDisabled

Type Color

Primary button text color when disabled.

#secondaryButton

Type Color

Secondary button fill color.

#secondaryButtonActive

Type Color

Secondary button fill color when active.

#secondaryButtonDown

Type Color

Secondary button fill color while pressed.

#secondaryButtonHover

Type Color

Secondary button fill color on hover.

#secondaryButtonStroke

Type Color

Secondary button stroke (outline) color.

#secondaryButtonText

Type Color

Secondary button text color.

#stroke

Type Color

Color for general outlines.

#text

Type Color

Label text color.

#warning

Type Color

Color between negative and positive, such as a warning or the middle of a scale from bad to good.

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.