Descriptor Class
Data structure that describes content: fields, sorting, filtering, format, etc. Descriptor may be changed to control how content is created.
Implements
Methods
| Name | Description | |
|---|---|---|
| constructor(source: DescriptorSource): Descriptor | Construct a new Descriptor using a DescriptorSource |
|
| createDescriptorOverrides(): DescriptorOverrides | Create descriptor overrides object from this descriptor. | |
| getFieldByName(name: string, recurse?: boolean): undefined | Field | Get field by its name | |
| toCompressedJSON(): CompressedDescriptorJSON | Serialize Descriptor to compressed JSON | |
| toJSON(): DescriptorJSON | Serialize this object to JSON | |
| fromJSON(json: undefined | string | DescriptorJSON | CompressedDescriptorJSON): undefined | Descriptor Static | Deserialize Descriptor from JSON |
Properties
| Name | Type | Description | |
|---|---|---|---|
| categories Readonly | CategoryDescription[] | A list of content field categories used in this descriptor | |
| connectionId Readonly | string | Id of the connection used to create the descriptor | |
| contentFlags Readonly | number | ContentFlags used to create the descriptor | |
| contentOptions Readonly | any | Extended options used to create the descriptor | |
| displayType Readonly | string | Display type used to create the descriptor | |
| fields Readonly | Field[] | A list of fields contained in the descriptor | |
| filterExpression | undefined | string | Content filtering ECExpression | |
| inputKeysHash Readonly | string | Hash of the input keys used to create the descriptor | |
| selectClasses Readonly | SelectClassInfo[] | A list of classes that will be selected when creating content with this descriptor | |
| selectionInfo Readonly | undefined | SelectionInfo | Selection info used to create the descriptor | |
| sortDirection | undefined | SortDirection | Sorting direction | |
| sortingField | undefined | Field | Field used to sort the content |
Defined in
Last Updated: 11 June, 2024