API Reference › core-backend› Models › SectionDrawingModel

SectionDrawingModel Class

A container for persisting section DrawingGraphics.

Extends

Methods

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

Inherited methods

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

Defined in

Last Updated: 28 October, 2024