The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V19.1
19.2 (preview)
19.1
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

IElementMetadata Interface

Provides information about an element required to serialize, display and manage interactivity.

Declaration

interface IElementMetadata

Properties

defaultVal Property

Specifies the default property values.

Declaration

defaultVal?: {}

Property Value

Type Description
__type

An object that specifies default property values.

info Property

Provides information required to serialize an element.

Declaration

info: Utils.ISerializationInfoArray

Property Value

Type Description
ISerializationInfoArray

An array of objects that provide information required to serialize an element.

isToolboxItem Property

Specifies whether an element is displayed in a toolbox.

Declaration

isToolboxItem?: boolean

Property Value

Type Description
boolean

true, if the element is available in the toolbox; otherwise, false.

popularProperties Property

Specifies an element's popular properties.

Declaration

popularProperties?: string[]

Property Value

Type Description
string[]

An array of strings that specify names of popular properties.

surfaceType Property

Specifies an element's surface type.

Declaration

surfaceType: any

Property Value

Type Description
any

A surface type.

toolboxIndex Property

Specifies a zero-based index of an element in the toolbox.

Declaration

toolboxIndex?: number

Property Value

Type Description
number

A control index in the toolbox.

type Property

Specifies an element's type.

Declaration

type?: any

Property Value

Type Description
any

An element type.