API Reference › core-backend› Models › SheetModel

SheetModel Class

A container for persisting ViewAttachments and DrawingGraphics. A SheetModel is a digital representation of a sheet of paper. SheetModels are 2d models in bounded paper coordinates. SheetModels may contain annotation Elements as well as references to 2d or 3d Views.

Extends

Methods

Name Description
constructor(props: GeometricModel2dProps, iModel: IModelDb): SheetModel Protected    

Inherited methods

Name Inherited from Description
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected GraphicalModel2d Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void GraphicalModel2d Delete this Model from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: booleantrue): void GraphicalModel2d Call a function for each property of this Entity.
getJsonProperty(name: string): any GraphicalModel2d  
getReferenceIds(): EntityReferenceSet GraphicalModel2d Get the set of this entity's entity references, EntityReferenceSet.
getUserProperties(namespace: string): any GraphicalModel2d Get a set of JSON user properties by namespace
insert(): string GraphicalModel2d Insert this Model in the iModel
queryExtents(): Range3d GraphicalModel2d Query for the union of the extents of the elements contained by this model.
queryRange(): Promise<Range3d> GraphicalModel2d Query for the union of the extents of all elements contained within this model.
removeUserProperties(nameSpace: string): void GraphicalModel2d Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(name: string, value: any): void GraphicalModel2d  
setUserProperties(nameSpace: string, value: any): void GraphicalModel2d Change a set of user JSON properties of this Element by namespace.
toJSON(): GeometricModel2dProps GraphicalModel2d Obtain the JSON representation of this Entity.
update(): void GraphicalModel2d Update this Model in the iModel.
is(otherClass: ): boolean Static GraphicalModel2d return whether this Entity class is a subclass of another Entity class
onDelete(arg: OnModelIdArg): void Protected Static GraphicalModel2d Called before a Model is deleted.
onDeleteElement(_arg: OnElementInModelIdArg): void Protected Static GraphicalModel2d Called when an Element in an instance of a Model of this class is about to be deleted.
onDeleted(_arg: OnModelIdArg): void Protected Static GraphicalModel2d Called after a Model was deleted.
onDeletedElement(_arg: OnElementInModelIdArg): void Protected Static GraphicalModel2d Called after an Element in an instance of a Model of this class has been deleted.
onInsert(arg: OnModelPropsArg): void Protected Static GraphicalModel2d Called before a new Model is inserted.
onInsertElement(_arg: OnElementInModelPropsArg): void Protected Static GraphicalModel2d Called before a prospective Element is to be inserted into an instance of a Model of this class.
onInserted(_arg: OnModelIdArg): void Protected Static GraphicalModel2d Called after a new Model is inserted.
onInsertedElement(_arg: OnElementInModelIdArg): void Protected Static GraphicalModel2d Called after an Element has been inserted into an instance of a Model of this class.
onUpdate(arg: OnModelPropsArg): void Protected Static GraphicalModel2d Called before a Model is updated.
onUpdateElement(_arg: OnElementInModelPropsArg): void Protected Static GraphicalModel2d Called when an Element in an instance of a Model of this class is about to be updated.
onUpdated(_arg: OnModelIdArg): void Protected Static GraphicalModel2d Called after a Model is updated.
onUpdatedElement(_arg: OnElementInModelIdArg): void Protected Static GraphicalModel2d Called after an Element in an instance of a Model of this class has been 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
classFullName Accessor ReadOnly string GraphicalModel2d Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static ReadOnly string GraphicalModel2d Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string GraphicalModel2d The name of the BIS class associated with this class.
geometryGuid string | undefined GraphicalModel2d  
globalOrigin Point2d | undefined GraphicalModel2d The actual coordinates of (0,0) in modeling coordinates.
id string GraphicalModel2d The Id of this Entity.
iModel IModelDb GraphicalModel2d The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" GraphicalModel2d An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isPrivate boolean GraphicalModel2d  
isTemplate boolean GraphicalModel2d  
jsonProperties Readonly [key: string]: any GraphicalModel2d  
modeledElement Readonly RelatedElement GraphicalModel2d  
name Readonly string GraphicalModel2d  
parentModel Readonly string GraphicalModel2d  
schema Static GraphicalModel2d The Schema that defines this class.
schemaName Accessor ReadOnly string GraphicalModel2d The name of the BIS Schema that defines this class

Defined in

Last Updated: 28 October, 2024