IChartSerializerSettings

Type interface

Sources

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

Inheritance

IChartSerializerSettings extends ISerializerSettings.

IChartSerializerSettings is not extended by any other symbol.

Properties

#includeRoot

Type undefined | false | trueDefault falseSince 5.20.2

Adds a root section with what was configured on the Root, such as its settings, formatters and locale.

#removeEmptyObjects

Type undefined | false | trueDefault true

Leaves empty objects out of the output.

#resources

Type undefined | objectSince 5.21.4

Objects to write out by name instead of copying them: geodata packs and locales, under the names JsonParser gets them by in its resources, e.g. { am5geodata_worldLow }. Without them, only packs loaded as globals (the script version) are written as names.

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

#excludeProperties

Type ArrayInherited from ISerializerSettingsSince 5.3.2

Properties to leave out of the output, e.g. "data".

#excludeSettings

Type ArrayInherited from ISerializerSettings

Settings to leave out of the output. Ignored when includeSettings is set.

#fullSettings

Type ArrayInherited from ISerializerSettingsSince 5.7.0

Settings whose plain-object values are written with all their keys.

In other settings, a plain object comes out empty.

#functionsAs

Type "string" | "function"Default "string"Inherited from ISerializerSettings

How adapter callbacks are written (see includeAdapters): "string" as their source code, "function" as the functions themselves, which JSON can't hold. ChartSerializer uses "function" unless set.

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

#includeAdapters

Type undefined | false | trueDefault falseInherited from ISerializerSettingsSince 5.15.0

Writes the elements' adapters.

#includeSettings

Type ArrayInherited from ISerializerSettings

The only settings to write; all others are left out.

#includeStates

Type undefined | false | trueDefault falseInherited from ISerializerSettingsSince 5.15.0

Writes the elements' states.

#maxDepth

Type undefined | numberDefault 2Inherited from ISerializerSettings

How many levels of nested objects to write; deeper ones are left out.

#runningAnimations

Type undefined | false | trueDefault trueInherited from ISerializerSettingsSince 5.20.8

Write an animation started in code that loops forever - a globe that keeps turning, a marker that keeps pulsing - into the animations setting, so the saved chart plays it too. Animations that end (appear(), state changes, zooming) are never written, and neither is one whose easing is a function of its own rather than one of amCharts' easings.

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