PropertiesField Class
Describes a content field that's based on one or more similar EC properties.
Extends
Methods
Name | Description | |
---|---|---|
constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, isReadonly: boolean, priority: number, properties: Property[], editor?: EditorDescription, renderer?: RendererDescription): PropertiesField | Creates an instance of PropertiesField. | |
clone(): PropertiesField | ||
getFieldDescriptor(): FieldDescriptor | Get descriptor for this field. | |
matchesDescriptor(descriptor: FieldDescriptor): boolean | Checks if this field matches given field descriptor | |
toJSON(): PropertiesFieldJSON<ClassInfoJSON> | Serialize this object to JSON | |
fromCompressedJSON(json: PropertiesFieldJSON<string>, classesMap: { T }, categories: CategoryDescription[]): undefined | PropertiesField Static | Deserialize a PropertiesField from compressed JSON. | |
fromJSON(json: undefined | PropertiesFieldJSON<ClassInfoJSON>, categories: CategoryDescription[]): undefined | PropertiesField Static | Deserialize PropertiesField from JSON |
Inherited methods
Name | Inherited from | Description |
---|---|---|
isNestedContentField(): this is NestedContentField | Field | Is this a NestedContentField |
isPropertiesField(): this is PropertiesField | Field | Is this a PropertiesField |
rebuildParentship(parentField?: NestedContentField): void | Field | Sets provided NestedContentField as parent of this field. |
resetParentship(): void | Field | Resets field's parent. |
toCompressedJSON(classesMap: { T }): FieldJSON<string> | Field | Serialize this object to compressed JSON |
getCategoryFromFieldJson(fieldJson: FieldJSON<ClassInfoJSON>, categories: CategoryDescription[]): CategoryDescription ProtectedStatic | Field |
Properties
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 | undefined | NestedContentField | Field | Get parent |
priority | number | Field | Priority of the field. |
renderer | undefined | RendererDescription | Field | Property renderer used to render values of this field |
type | TypeDescription | Field | Description of this field's values data type |
Defined in
Last Updated: 15 March, 2024
Found something wrong, missing, or unclear on this page?
Raise an issue in our repo.