Documentation

ISerializerSettings

Type interface

Inheritance

ISerializerSettings extends IEntitySettings.

ISerializerSettings is extended by IChartSerializerSettings.

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
excludeProperties #	Type `Array` Properties to leave out of the output, e.g. `"data"`. @since 5.3.2
excludeSettings #	Type `Array` Settings to leave out of the output. Ignored when `includeSettings` is set.
fullSettings #	Type `Array` Settings whose plain-object values are written with all their keys. In other settings, a plain object comes out empty. @since 6.4.3
functionsAs #	Type `"string"` \| `"function"` Default `"string"` 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` \| `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
includeAdapters #	Type `undefined` \| `false` \| `true` Default `false` Writes the elements' adapters. @since 5.15.0
includeSettings #	Type `Array` The only settings to write; all others are left out.
includeStates #	Type `undefined` \| `false` \| `true` Default `false` Writes the elements' states. @since 5.15.0
maxDepth #	Type `undefined` \| `number` Default `2` How many levels of nested objects to write; deeper ones are left out.
runningAnimations #	Type `undefined` \| `false` \| `true` Default `true` 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. @since 5.21.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.
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 9 inherited items currently hidden from this list.