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

Implements

Inherited methods

Name Inherited from Description
buildConcurrencyControlRequest(opcode: DbOpcode): void Model Add a request for the locks that would be needed to carry out the specified operation.
delete(): void Model Delete this Model from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void Entity Call a function for each property of this Entity.
getJsonProperty(name: string): any Model  
getUserProperties(namespace: string): any Model Get a set of JSON user properties by namespace
insert(): string Model Insert this Model in the iModel
queryExtents(): AxisAlignedBox3d GeometricModel Query for the union of the extents of the elements contained by this model.
removeUserProperties(nameSpace: string): void Model Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(name: string, value: any): void Model  
setUserProperties(nameSpace: string, value: any): void Model Change a set of user JSON properties of this Element by namespace.
update(): void Model Update this Model in the iModel.
onDelete(arg: OnModelIdArg): void ProtectedStatic Model Called before a Model is deleted.
onDeleteElement(_arg: OnElementInModelIdArg): void ProtectedStatic Model Called when an Element in an instance of a Model of this class is about to be deleted.
onDeleted(_arg: OnModelIdArg): void ProtectedStatic Model Called after a Model was deleted.
onDeletedElement(_arg: OnElementInModelIdArg): void ProtectedStatic Model Called after an Element in an instance of a Model of this class has been deleted.
onInsert(arg: OnModelPropsArg): void ProtectedStatic Model Called before a new Model is inserted.
onInsertElement(_arg: OnElementInModelPropsArg): void ProtectedStatic Model Called before a prospective Element is to be inserted into an instance of a Model of this class.
onInserted(arg: OnModelIdArg): void ProtectedStatic Model Called after a new Model is inserted.
onInsertedElement(_arg: OnElementInModelIdArg): void ProtectedStatic Model Called after an Element has been inserted into an instance of a Model of this class.
onUpdate(arg: OnModelPropsArg): void ProtectedStatic Model Called before a Model is updated.
onUpdateElement(_arg: OnElementInModelPropsArg): void ProtectedStatic Model Called when an Element in an instance of a Model of this class is about to be updated.
onUpdated(arg: OnModelIdArg): void ProtectedStatic Model Called after a Model is updated.
onUpdatedElement(_arg: OnElementInModelIdArg): void ProtectedStatic Model Called after an Element in an instance of a Model of this class has been updated.
populateRequest(req: ConcurrencyControl.Request, props: ModelProps, iModel: IModelDb, opcode: DbOpcode): void Static Model Disclose the codes and locks needed to perform the specified operation on this model

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string Entity Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string Entity Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string Entity The name of the BIS class associated with this class.
geometryGuid undefined | GuidString GeometricModel  
globalOrigin undefined | Point2d GeometricModel2d The actual coordinates of (0,0) in modeling coordinates.
id Id64String Entity The Id of this Entity.
iModel IModelDb Entity The IModelDb that contains this Entity
isPrivate boolean Model  
isTemplate boolean Model  
jsonProperties [key: string]: any Model  
modeledElement RelatedElement Model  
name string Model  
parentModel Id64String Model  
schema Static undefined Entity The Schema that defines this class.
schemaName Accessor ReadOnly string Entity The name of the BIS Schema that defines this class

Defined in

Last Updated: 01 December, 2021