API Reference › core-backend› ViewDefinitions › SheetViewDefinition

SheetViewDefinition Class

Defines a view of a SheetModel.

Extends

Methods

Name Description
constructor(props: ViewDefinition2dProps, iModel: IModelDb): SheetViewDefinition Protected    

Inherited methods

Name Inherited from Description
collectPredecessorIds(predecessorIds: EntityReferenceSet): void Protected Inherited ViewDefinition2d Collect the Ids of this element's references at this level of the class hierarchy.
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Inherited ViewDefinition2d Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void Inherited ViewDefinition2d Delete this Element from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: booleantrue): void Inherited ViewDefinition2d Call a function for each property of this Entity.
getAuxiliaryCoordinateSystemId(): string Inherited ViewDefinition2d The Id of the AuxiliaryCoordinateSystem for this ViewDefinition, or an invalid Id if no ACS is defined.
getClassMetaData(): undefined | EntityMetaData Inherited ViewDefinition2d Get the class metadata for this element.
getDisplayLabel(): string Inherited ViewDefinition2d Get a display label for this Element.
getJsonProperty(nameSpace: string): any Inherited ViewDefinition2d Get a JSON property of this element, by namespace
getPredecessorIds(): Id64Set Inherited ViewDefinition2d Get the Ids of this element's references.
getReferenceIds(): EntityReferenceSet Inherited ViewDefinition2d Get the set of this entity's entity references, EntityReferenceSet.
getToolTipMessage(): string[] Inherited ViewDefinition2d Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any Inherited ViewDefinition2d Get a set of JSON user properties by namespace
insert(): string Inherited ViewDefinition2d Insert this Element into the iModel.
isDrawingView(): this is DrawingViewDefinition Inherited ViewDefinition2d Type guard for 'instanceof DrawingViewDefinition'
isSpatialView(): this is SpatialViewDefinition Inherited ViewDefinition2d Type guard for instanceof SpatialViewDefinition
isView2d(): this is ViewDefinition2d Inherited ViewDefinition2d Type guard for 'instanceof ViewDefinition2d`
isView3d(): this is ViewDefinition3d Inherited ViewDefinition2d Type guard for instanceof ViewDefinition3d
loadCategorySelector(): CategorySelector Inherited ViewDefinition2d Load this view's CategorySelector from the IModelDb.
loadDisplayStyle(): DisplayStyle Inherited ViewDefinition2d Load this view's DisplayStyle from the IModelDb.
loadDisplayStyle2d(): DisplayStyle2d Inherited ViewDefinition2d Load this view's DisplayStyle2d from the IModelDb.
removeUserProperties(nameSpace: string): void Inherited ViewDefinition2d Remove a set of JSON user properties, specified by namespace, from this Element
setAuxiliaryCoordinateSystemId(acsId: string): void Inherited ViewDefinition2d Set or clear the AuxiliaryCoordinateSystem for this ViewDefinition.
setJsonProperty(nameSpace: string, value: any): void Inherited ViewDefinition2d  
setUserProperties(nameSpace: string, value: any): void Inherited ViewDefinition2d Change a set of user JSON properties of this Element by namespace.
toJSON(): ViewDefinition2dProps Inherited ViewDefinition2d Obtain the JSON representation of this Entity.
update(): void Inherited ViewDefinition2d Update this Element in the iModel.
createCode(iModel: IModelDb, scopeModelId: string, codeValue: string): Code Static Inherited ViewDefinition2d Create a Code for a ViewDefinition given a name that is meant to be unique within the scope of the specified DefinitionModel.
is(otherClass: ): boolean Static Inherited ViewDefinition2d return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void Protected Static Inherited ViewDefinition2d 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 ViewDefinition2d Called when a root element in a subgraph is changed and before its outputs are processed.
onChildAdd(_arg: OnChildElementPropsArg): void Protected Static Inherited ViewDefinition2d 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 ViewDefinition2d 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 ViewDefinition2d 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 ViewDefinition2d Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void Protected Static Inherited ViewDefinition2d 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 ViewDefinition2d 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 ViewDefinition2d 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 ViewDefinition2d Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void Protected Static Inherited ViewDefinition2d 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 ViewDefinition2d Called after an element with an instance of this the class as its parent was updated.
onCloned(context: IModelElementCloneContext, sourceElementProps: ViewDefinitionProps, targetElementProps: ViewDefinitionProps): void Protected Static Inherited ViewDefinition2d  
onDelete(arg: OnElementIdArg): void Protected Static Inherited ViewDefinition2d Called before an Element is deleted.
onDeleted(_arg: OnElementIdArg): void Protected Static Inherited ViewDefinition2d Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void Protected Static Inherited ViewDefinition2d Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void Protected Static Inherited ViewDefinition2d Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void Protected Static Inherited ViewDefinition2d Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(_arg: OnSubModelIdArg): void Protected Static Inherited ViewDefinition2d Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(_arg: OnSubModelPropsArg): void Protected Static Inherited ViewDefinition2d Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(_arg: OnSubModelIdArg): void Protected Static Inherited ViewDefinition2d Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void Protected Static Inherited ViewDefinition2d Called before an Element is updated.
onUpdated(_arg: OnElementIdArg): void Protected Static Inherited ViewDefinition2d Called after an Element was updated.

Properties

Name Type Description
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  

Inherited properties

Name Type Inherited from Description
angle Inherited Angle ViewDefinition2d The rotation of this view.
baseModelId Inherited string ViewDefinition2d The Id of the Model displayed by this view.
categorySelectorId Inherited string ViewDefinition2d The element Id of the CategorySelector for this ViewDefinition
classFullName Accessor Inherited ReadOnly string ViewDefinition2d Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string ViewDefinition2d Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string ViewDefinition2d The name of the BIS class associated with this class.
code Inherited Code ViewDefinition2d The Code for this element
delta Inherited Point2d ViewDefinition2d The delta (size) of this view, in meters, aligned with view x,y.
details Accessor Inherited ReadOnly ViewDetails ViewDefinition2d Provides access to optional detail settings for this view.
displayStyleId Inherited string ViewDefinition2d The element Id of the DisplayStyle for this ViewDefinition
federationGuid Inherited string | undefined ViewDefinition2d A FederationGuid assigned to this element by some other federated database
id Inherited string ViewDefinition2d The Id of this Entity.
iModel Inherited IModelDb ViewDefinition2d The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" ViewDefinition2d An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isPrivate Inherited boolean ViewDefinition2d If true, don't show this DefinitionElement in user interface lists.
jsonProperties Readonly Inherited [key: string]: any ViewDefinition2d Optional json properties of this element.
model Readonly Inherited string ViewDefinition2d The ModelId of the Model containing this element
origin Inherited Point2d ViewDefinition2d The lower-left corner of this view in Model coordinates.
parent Inherited RelatedElement | undefined ViewDefinition2d The parent element, if present, of this element.
requiredReferenceKeys Static Readonly Inherited ReadonlyArray ViewDefinition2d  
schema Static Inherited ViewDefinition2d The Schema that defines this class.
schemaName Accessor Inherited ReadOnly string ViewDefinition2d The name of the BIS Schema that defines this class
userLabel Inherited string | undefined ViewDefinition2d A user-assigned label for this element.

Defined in

Last Updated: 17 December, 2024