ViewDefinitionProps Interface
Parameters used to construct a ViewDefinition
Extends
Properties
| Name | Type | Description | |
|---|---|---|---|
| categorySelector | RelatedElementProps | undefined | The CategorySelector for this view. | |
| categorySelectorId | string | The Id of the CategorySelector for this view. | Deprecated |
| description | string | undefined | ||
| displayStyle | RelatedElementProps | undefined | The DisplayStyle for this view. | |
| displayStyleId | string | The Id of the DisplayStyle for this view. | Deprecated |
| jsonProperties | { viewDetails?: ViewDetailsProps } | undefined | Optional json properties of this element. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| classFullName Inherited | string | DefinitionElementProps | The full name of the ECClass for this entity, in the form "Schema:ClassName" |
| code Inherited | CodeProps | DefinitionElementProps | The Code for this element |
| federationGuid Inherited | string | undefined | DefinitionElementProps | A FederationGuid assigned to this element. |
| id Inherited | string | undefined | DefinitionElementProps | The Id of the entity. |
| isInstanceOfEntity Readonly Inherited | undefined | undefined | DefinitionElementProps | A non-existent property used to discriminate between EntityProps and Entity. |
| isPrivate Inherited | boolean | undefined | DefinitionElementProps | |
| model Inherited | string | DefinitionElementProps | The Id of the Model containing this element |
| parent Inherited | RelatedElementProps | undefined | DefinitionElementProps | The Parent of this element, if defined. |
| userLabel Inherited | string | undefined | DefinitionElementProps | A user-assigned label for this element. |
Defined in
- core/common/src/ViewProps.ts Line 178
Last Updated: 05 May, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.