Class ArrayProperty

Represents an array property with defined item structure.

Hierarchy (View Summary)

Property
- ArrayProperty

Index

Constructors

Properties

description items title type

Methods

addItemProperty itemsDraggable itemTitle setDescription setTitle

Constructors

constructor

new ArrayProperty(): ArrayProperty
Returns ArrayProperty
Overrides Property.constructor
- Defined in settings.ts:151

Properties

description

description: string

items

items: ArrayItems

title

title: string

type

type: "string" | "number" | "boolean" | "array"

Methods

addItemProperty

addItemProperty(
name: string,
property: BooleanProperty | NumberProperty | StringProperty,
): ArrayProperty
Adds a property to the array items.
Parameters
- name: string
- property: BooleanProperty | NumberProperty | StringProperty
Returns ArrayProperty
- Defined in settings.ts:175

itemsDraggable

itemsDraggable(draggable: boolean): ArrayProperty
Enables or disables draggable items in the array.
Parameters
- draggable: boolean
Returns ArrayProperty
- Defined in settings.ts:167

itemTitle

itemTitle(title: string): ArrayProperty
Sets the title for the items in the array.
Parameters
- title: string
Returns ArrayProperty
- Defined in settings.ts:159

setDescription

setDescription(description: string): Property
Sets the description of the property.
Parameters
- description: string
Returns Property
Inherited from Property.setDescription
- Defined in settings.ts:24

setTitle

setTitle(title: string): Property
Sets the title of the property.
Parameters
- title: string
Returns Property
Inherited from Property.setTitle
- Defined in settings.ts:16