PropertiesField Class

Describes a content field that's based on one or more similar EC properties.



Name Description
constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, isReadonly: boolean, priority: number, properties: Property[], editor?: EditorDescription): PropertiesField Creates an instance of PropertiesField.  

Inherited methods

Name Inherited from Description
isNestedContentField(): boolean Field Is this a NestedContentField
isPropertiesField(): boolean Field Is this a PropertiesField


Name Type Description
properties Property[] A list of properties this field is created from  

Inherited properties

Name Type Inherited from Description
category CategoryDescription Field Category information
editor undefined | EditorDescription Field Property editor used to edit values of this field
isReadonly boolean Field Are values in this field read-only
label string Field Display label
name string Field Unique name
parent Accessor ReadOnly NestedContentField | undefined Field Get parent
priority number Field Priority of the field.
type TypeDescription Field Description of this field's values data type

Defined in

Last Updated: 20 September, 2019