NestedContentField Class

Describes a content field that contains Nested content.

Extends

Methods

Name Description
constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, isReadonly: boolean, priority: number, contentClassInfo: ClassInfo, pathToPrimaryClass: RelationshipPath, nestedFields: Field[], editor?: EditorDescription, autoExpand?: false | true, renderer?: RendererDescription): NestedContentField Creates an instance of NestedContentField.  
clone(): NestedContentField    
getFieldByName(name: string, recurse?: false | true): Field | undefined Get field by its name  
toJSON(): NestedContentFieldJSON Serialize this object to JSON  
fromJSON(json: NestedContentFieldJSON | undefined, categories: CategoryDescription[]): NestedContentField | undefined Static Deserialize NestedContentField from JSON  
fromJSON(json: NestedContentFieldJSON | string | undefined): NestedContentField | undefined Static Deserialize NestedContentField from JSON Deprecated  

Inherited methods

Name Inherited from Description
getFieldDescriptor(): FieldDescriptor Field Get descriptor for this field.
isNestedContentField(): this Field Is this a NestedContentField
isPropertiesField(): this Field Is this a PropertiesField
toCompressedJSON(classesMap: [id: string]: CompressedClassInfoJSON): FieldJSON<string> Field Serialize this object to compressed JSON
fromCompressedJSON(json: FieldJSON<string>, classesMap: [id: string]: CompressedClassInfoJSON): FieldJSON | undefined Static Field Deserialize Field from compressed JSON
getCategoryFromFieldJson(fieldJson: FieldJSON, categories?: CategoryDescription[]): CategoryDescription ProtectedStatic Field  

Properties

Name Type Description
autoExpand undefined | false | true Flag specifying whether field should be expanded  
contentClassInfo ClassInfo Information about an ECClass whose properties are nested inside this field  
nestedFields Field[] Contained nested fields  
pathToPrimaryClass RelationshipPath Relationship path to Primary class  

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.
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: 01 December, 2021