ISerializerSettings

Type interface

Inheritance

ISerializerSettings extends IEntitySettings.

ISerializerSettings is extended by IChartSerializerSettings.

Properties

excludeProperties
#

Type Array

An array of properties to not include in the serialized data.

@since 5.3.2

excludeSettings
#

Type Array

An array of settings to not include in the serialized data.

fullSettings
#

Type Array

Include full values of these settings.

@since 6.4.3

functionsAs
#

Type "string" | "function"

Default "function"

Serialize functions as strings or functions.

id
#

Type undefined | string

Inherited from IEntitySettings

A custom string ID for the element.

If set, element can be looked up via root.entitiesById.

Will raise error if an element with the same ID already exists.

includeAdapters
#

Type undefined | false | true

Default false

Include adapters in the output.

@since 5.15.0

includeSettings
#

Type Array

An array of settings to include in the serialized data.

includeStates
#

Type undefined | false | true

Default false

Include states in the output.

@since 5.15.0

maxDepth
#

Type undefined | number

Default 2

Maximum depth of recursion when traversing target object.

stateAnimationDuration
#

Type undefined | number

Inherited from IEntitySettings

Duration of transition from one state to another.

stateAnimationEasing
#

Type $ease.Easing

Inherited from IEntitySettings

Easing of transition from one state to another.

themeTags
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

These tags only apply to this object, not any children.

Click here for more info

themes
#

Type Array

Inherited from IEntitySettings

A list of themes applied to the element.

userData
#

Type any

Inherited from IEntitySettings

A storage for any custom user data that needs to be associated with the element.

There are 7 inherited items currently hidden from this list.