API Reference › presentation-common› Content › PropertiesField

PropertiesField Class

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

Extends

Extended by

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.  
isArrayPropertiesField(): this is ArrayPropertiesField Is this a an array property field  
isStructPropertiesField(): this is StructPropertiesField Is this a an struct property field  
matchesDescriptor(descriptor: FieldDescriptor): boolean Checks if this field matches given field descriptor  
toCompressedJSON(classesMap: [id: string]: CompressedClassInfoJSON): PropertiesFieldJSON<string> Serialize this object to compressed JSON  
toJSON(): PropertiesFieldJSON<ClassInfoJSON> Serialize this object to JSON  
fromCompressedJSON(json: PropertiesFieldJSON<string>, classesMap: [id: string]: CompressedClassInfoJSON, categories: CategoryDescription[]): undefined | PropertiesField Static Deserialize a PropertiesField from compressed JSON.  
fromJSON(json: PropertiesFieldJSON<ClassInfoJSON>, categories: CategoryDescription[]): undefined | PropertiesField Static Deserialize PropertiesField from JSON  

Inherited methods

Name Inherited from Description
isNestedContentField(): this is NestedContentField Inherited Field Is this a NestedContentField
isPropertiesField(): this is PropertiesField Inherited Field Is this a PropertiesField
rebuildParentship(parentField?: NestedContentField): void Inherited Field Sets provided NestedContentField as parent of this field.
resetParentship(): void Inherited Field Resets field's parent.
getCategoryFromFieldJson(fieldJson: FieldJSON<ClassInfoJSON>, categories: CategoryDescription[]): CategoryDescription Protected Static Inherited Field  

Properties

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

Inherited properties

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

Defined in

Last Updated: 17 December, 2024