Field Class

Describes a single content field. A field is usually represented as a grid column or a property pane row.

Extended by


Name Description
constructor(category: CategoryDescription, name: string, label: string, type: TypeDescription, isReadonly: boolean, priority: number, editor?: EditorDescription, renderer?: RendererDescription): Field Creates an instance of Field.  
clone(): Field    
getFieldDescriptor(): FieldDescriptor Get descriptor for this field.  
isNestedContentField(): this Is this a NestedContentField  
isPropertiesField(): this Is this a PropertiesField  
toCompressedJSON(classesMap: [id: string]: CompressedClassInfoJSON): FieldJSON<string> Serialize this object to compressed JSON  
toJSON(): FieldJSON Serialize this object to JSON  
fromCompressedJSON(json: FieldJSON<string>, classesMap: [id: string]: CompressedClassInfoJSON): FieldJSON | undefined Static Deserialize Field from compressed JSON  
fromJSON(json: FieldJSON | undefined, categories: CategoryDescription[]): Field | undefined Static Deserialize Field from JSON  
fromJSON(json: FieldJSON | string | undefined): Field | undefined Static Deserialize Field from JSON Deprecated  
getCategoryFromFieldJson(fieldJson: FieldJSON, categories?: CategoryDescription[]): CategoryDescription ProtectedStatic    


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

Defined in

Last Updated: 01 December, 2021