API Reference › core-backend› ViewDefinitions › SpatialViewDefinition

SpatialViewDefinition Class @preview

Defines a view of one or more SpatialModels. The list of viewed models is stored by the ModelSelector.

This is how a SpatialViewDefinition selects the elements to display:

SpatialViewDefinition

  • ModelSelector
    • ModelIds -------> SpatialModels <----------GeometricElement3d.Model
  • CategorySelector
    • CategoryIds -----> SpatialCategories <----------GeometricElement3d.Category

Extends

Extended by

Methods

Name Description
constructor(props: SpatialViewDefinitionProps, iModel: IModelDb): SpatialViewDefinition Protected    
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Collect the Ids of this entity's references at this level of the class hierarchy.  
loadModelSelector(): ModelSelector Load this view's ModelSelector from the IModelDb.  
toJSON(): SpatialViewDefinitionProps Obtain the JSON representation of this Entity.  
createWithCamera(iModelDb: IModelDb, definitionModelId: string, name: string, modelSelectorId: string, categorySelectorId: string, displayStyleId: string, range: Range3d, standardView: StandardViewIndex = StandardViewIndex.Iso, cameraAngle: number = Angle.piOver2Radians): SpatialViewDefinition Static Create a SpatialViewDefinition with the camera turned on.  
deserialize(props: DeserializeEntityArgs): SpatialViewDefinitionProps Static Converts an ECSqlRow of an Entity to an EntityProps.  
fromJSON(props: Omit<SpatialViewDefinitionProps, "classFullName">, iModel: IModelDb): SpatialViewDefinition Static Construct a SpatialViewDefinition from its JSON representation.  
insertWithCamera(txn: EditTxn, definitionModelId: string, name: string, modelSelectorId: string, categorySelectorId: string, displayStyleId: string, range: Range3d, standardView?: StandardViewIndex, cameraAngle?: number): string Static Insert an SpatialViewDefinition with the camera turned on.  
insertWithCamera(iModelDb: IModelDb, definitionModelId: string, name: string, modelSelectorId: string, categorySelectorId: string, displayStyleId: string, range: Range3d, standardView?: StandardViewIndex, cameraAngle?: number): string Static   Deprecated  
serialize(props: SpatialViewDefinitionProps, _iModel: IModelDb): ECSqlRow Static Converts an EntityProps to an ECSqlRow.  

Inherited methods

Name Inherited from Description
delete(txn: EditTxn): void Inherited ViewDefinition3d Delete this Element from the iModel using the supplied EditTxn.
delete(): void Inherited ViewDefinition3d Delete this Element from the iModel.
forEach(func: PropertyHandler, includeCustom: boolean = true): void Inherited ViewDefinition3d Call a function for each property of this Entity.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void Inherited ViewDefinition3d Call a function for each property of this Entity.
getAuxiliaryCoordinateSystemId(): string Inherited ViewDefinition3d The Id of the AuxiliaryCoordinateSystem for this ViewDefinition, or an invalid Id if no ACS is defined.
getClassMetaData(): EntityMetaData | undefined Inherited ViewDefinition3d Get the class metadata for this element.
getDisplayLabel(): string Inherited ViewDefinition3d Get a display label for this Element.
getJsonProperty(nameSpace: string): any Inherited ViewDefinition3d Get a JSON property of this element, by namespace
getMetaData(): Promise<EntityClass> Inherited ViewDefinition3d Query metadata for this entity class from the iModel's schema.
getReferenceIds(): EntityReferenceSet Inherited ViewDefinition3d Get the set of this entity's entity references, EntityReferenceSet.
getToolTipMessage(): string[] Inherited ViewDefinition3d Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any Inherited ViewDefinition3d Get a set of JSON user properties by namespace
insert(txn: EditTxn): string Inherited ViewDefinition3d Insert this Element into the iModel using the supplied EditTxn.
insert(): string Inherited ViewDefinition3d Insert this Element into the iModel.
isDrawingView(): this is DrawingViewDefinition Inherited ViewDefinition3d Type guard for 'instanceof DrawingViewDefinition'
isSpatialView(): this is SpatialViewDefinition Inherited ViewDefinition3d Type guard for instanceof SpatialViewDefinition
isView2d(): this is ViewDefinition2d Inherited ViewDefinition3d Type guard for 'instanceof ViewDefinition2d`
isView3d(): this is ViewDefinition3d Inherited ViewDefinition3d Type guard for instanceof ViewDefinition3d
loadCategorySelector(): CategorySelector Inherited ViewDefinition3d Load this view's CategorySelector from the IModelDb.
loadDisplayStyle(): DisplayStyle Inherited ViewDefinition3d Load this view's DisplayStyle from the IModelDb.
loadDisplayStyle3d(): DisplayStyle3d Inherited ViewDefinition3d Load this view's DisplayStyle3d from the IModelDb.
removeUserProperties(nameSpace: string): void Inherited ViewDefinition3d Remove a set of JSON user properties, specified by namespace, from this Element
setAuxiliaryCoordinateSystemId(acsId: string): void Inherited ViewDefinition3d Set or clear the AuxiliaryCoordinateSystem for this ViewDefinition.
setJsonProperty(nameSpace: string, value: any): void Inherited ViewDefinition3d  
setUserProperties(nameSpace: string, value: any): void Inherited ViewDefinition3d Change a set of user JSON properties of this Element by namespace.
update(txn: EditTxn): void Inherited ViewDefinition3d Update this Element in the iModel using the supplied EditTxn.
update(): void Inherited ViewDefinition3d Update this Element in the iModel.
createCode(iModel: IModelDb, scopeModelId: string, codeValue: string): Code Static Inherited ViewDefinition3d Create a Code for a ViewDefinition given a name that is meant to be unique within the scope of the specified DefinitionModel.
is(otherClass: Entity): boolean Static Inherited ViewDefinition3d return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void Protected Static Inherited ViewDefinition3d Called on an element in a graph after all of its inputs have been processed and before its outputs are processed.
onAllInputsHandledArg(arg: OnElementDependencyArg): void Protected Static Inherited ViewDefinition3d Called on an element in a graph after all of its inputs have been processed and before its outputs are processed.
onBeforeOutputsHandled(_id: string, _iModel: IModelDb): void Protected Static Inherited ViewDefinition3d Called when a root element in a subgraph is changed and before its outputs are processed.
onBeforeOutputsHandledArg(arg: OnElementDependencyArg): void Protected Static Inherited ViewDefinition3d Called when a root element in a subgraph is changed and before its outputs are processed.
onBulkChildDeleted(arg: OnBulkChildDeletedBatchArg): void Protected Static Inherited ViewDefinition3d Called after a batch of child Elements of this class's instances were deleted in a bulk delete operation.
onBulkDeleted(arg: OnBulkDeletedBatchArg): void Protected Static Inherited ViewDefinition3d Called after a batch of Elements of this class were deleted in a bulk delete operation.
onChildAdd(_arg: OnChildElementPropsArg): void Protected Static Inherited ViewDefinition3d Called when an existing element is about to be updated so that an instance of this class will become its new parent.
onChildAdded(arg: OnChildElementIdArg): void Protected Static Inherited ViewDefinition3d Called after an existing element has been updated so that an instance of this class is its new parent.
onChildDelete(_arg: OnChildElementIdArg): void Protected Static Inherited ViewDefinition3d Called when an element with an instance of this class as its parent is about to be deleted.
onChildDeleted(arg: OnChildElementIdArg): void Protected Static Inherited ViewDefinition3d Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void Protected Static Inherited ViewDefinition3d Called when an element with an instance of this class as its parent is about to be updated change to a different parent.
onChildDropped(arg: OnChildElementIdArg): void Protected Static Inherited ViewDefinition3d Called after an element with an instance of this class as its previous parent was updated to have a new parent.
onChildInsert(_arg: OnChildElementPropsArg): void Protected Static Inherited ViewDefinition3d Called when a new element with an instance of this class as its parent is about to be inserted.
onChildInserted(arg: OnChildElementIdArg): void Protected Static Inherited ViewDefinition3d Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void Protected Static Inherited ViewDefinition3d Called when an element with an instance of this class as its parent is about to be updated.
onChildUpdated(arg: OnChildElementIdArg): void Protected Static Inherited ViewDefinition3d Called after an element with an instance of this the class as its parent was updated.
onCloned(context: IModelElementCloneContext, sourceElementProps: ViewDefinitionProps, targetElementProps: ViewDefinitionProps): Promise<void> Protected Static Inherited ViewDefinition3d  
onDelete(arg: OnElementIdArg): void Protected Static Inherited ViewDefinition3d Called before an Element is deleted.
onDeleted(arg: OnElementIdArg): void Protected Static Inherited ViewDefinition3d Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void Protected Static Inherited ViewDefinition3d Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void Protected Static Inherited ViewDefinition3d Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void Protected Static Inherited ViewDefinition3d Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(arg: OnSubModelIdArg): void Protected Static Inherited ViewDefinition3d Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(arg: OnSubModelPropsArg): void Protected Static Inherited ViewDefinition3d Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(arg: OnSubModelIdArg): void Protected Static Inherited ViewDefinition3d Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void Protected Static Inherited ViewDefinition3d Called before an Element is updated.
onUpdated(arg: OnElementIdArg): void Protected Static Inherited ViewDefinition3d Called after an Element was updated.

Properties

Name Type Description
_customHandledProps Protected Static Readonly CustomHandledProperty[] List of properties that are need to be custom handled during deserialization and serialization.  
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  
modelSelector RelatedElementProps Navigation property identifying the ModelSelector element for this view.  
modelSelectorId Accessor string The Id of the ModelSelector for this SpatialViewDefinition.  
modelSelectorId Setter modelSelectorId(id: string): void    
requiredReferenceKeys Static Readonly ReadonlyArray    

Inherited properties

Name Type Inherited from Description
_metadata Protected Inherited EntityClass | RelationshipClass ViewDefinition3d Cached Metadata for the ECClass
allowedSubModelClasses Accessor Protected Static Inherited ReadOnly EntityClassType<Model>[] | undefined ViewDefinition3d The Model classes that may sub-model an instance of this class.
A sub-model is accepted if its class is, or derives from, one of these classes, including generated JavaScript classes for unregistered EC subclasses.
The default is undefined, which permits any Model class.
Domain classes implementing bis:ISubModeledElement should override this to restrict their sub-model class.
angles Inherited YawPitchRollAngles ViewDefinition3d Rotation from world coordinates to view coordinates.
camera Inherited Camera ViewDefinition3d The camera used for this view, if cameraOn is true.
cameraOn Inherited boolean ViewDefinition3d If true, camera is used.
categorySelector Inherited RelatedElementProps ViewDefinition3d The CategorySelector referenced by this ViewDefinition.
categorySelectorId Accessor Inherited string ViewDefinition3d The Id of the CategorySelector for this ViewDefinition.
classFullName Accessor Inherited ReadOnly string ViewDefinition3d Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string ViewDefinition3d Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string ViewDefinition3d The name of the BIS class associated with this class.
code Inherited Code ViewDefinition3d The Code for this element
details Accessor Inherited ReadOnly ViewDetails3d ViewDefinition3d Provides access to optional detail settings for this view.
displayStyle Inherited RelatedElementProps ViewDefinition3d The DisplayStyle referenced by this ViewDefinition.
displayStyleId Accessor Inherited string ViewDefinition3d The Id of the DisplayStyle for this ViewDefinition.
extents Inherited Vector3d ViewDefinition3d The extent (size) of the view frustum, in meters, along its x,y,z axes.
federationGuid Inherited string | undefined ViewDefinition3d A FederationGuid assigned to this element by some other federated database
id Inherited string ViewDefinition3d The Id of this Entity.
iModel Inherited IModelDb ViewDefinition3d The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" ViewDefinition3d An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isPrivate Inherited boolean ViewDefinition3d If true, don't show this DefinitionElement in user interface lists.
jsonProperties Readonly Inherited [key: string]: any ViewDefinition3d Optional json properties of this element.
model Readonly Inherited string ViewDefinition3d The ModelId of the Model containing this element
origin Inherited Point3d ViewDefinition3d The lower left back corner of the view frustum.
parent Inherited RelatedElement | undefined ViewDefinition3d The parent element, if present, of this element.
schema Static Inherited Schema ViewDefinition3d The Schema that defines this class.
schemaItemKey Accessor Inherited ReadOnly SchemaItemKey ViewDefinition3d Get the item key used by the ecschema-metadata package to identify this entity class
schemaItemKey Accessor Static Inherited ReadOnly SchemaItemKey ViewDefinition3d Serves as a unique identifier for this class. Typed variant of classFullName.
schemaName Accessor Inherited ReadOnly string ViewDefinition3d The name of the BIS Schema that defines this class
userLabel Inherited string | undefined ViewDefinition3d A user-assigned label for this element.

Defined in

Last Updated: 12 October, 2026