API Reference › core-backend › Models › GraphicalModel2d

GraphicalModel2d Class

A container for persisting 2d graphical elements.

Extends

Extended by

Methods

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

Inherited methods

Name Inherited from Description
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected GeometricModel2d Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void GeometricModel2d Delete this Model from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void GeometricModel2d Call a function for each property of this Entity.
getJsonProperty(name: string): any GeometricModel2d  
getReferenceIds(): EntityReferenceSet GeometricModel2d Get the set of this entity's entity references, EntityReferenceSet.
getUserProperties(namespace: string): any GeometricModel2d Get a set of JSON user properties by namespace
insert(): string GeometricModel2d Insert this Model in the iModel
queryExtents(): Range3d GeometricModel2d Query for the union of the extents of the elements contained by this model.
queryRange(): Promise<Range3d> GeometricModel2d Query for the union of the extents of all elements contained within this model.
removeUserProperties(nameSpace: string): void GeometricModel2d Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(name: string, value: any): void GeometricModel2d  
setUserProperties(nameSpace: string, value: any): void GeometricModel2d Change a set of user JSON properties of this Element by namespace.
toJSON(): GeometricModel2dProps GeometricModel2d Obtain the JSON representation of this Entity.
update(): void GeometricModel2d Update this Model in the iModel.
is(otherClass: undefined): boolean Static GeometricModel2d return whether this Entity class is a subclass of another Entity class
onDelete(arg: OnModelIdArg): void ProtectedStatic GeometricModel2d Called before a Model is deleted.
onDeleteElement(_arg: OnElementInModelIdArg): void ProtectedStatic GeometricModel2d Called when an Element in an instance of a Model of this class is about to be deleted.
onDeleted(_arg: OnModelIdArg): void ProtectedStatic GeometricModel2d Called after a Model was deleted.
onDeletedElement(_arg: OnElementInModelIdArg): void ProtectedStatic GeometricModel2d Called after an Element in an instance of a Model of this class has been deleted.
onInsert(arg: OnModelPropsArg): void ProtectedStatic GeometricModel2d Called before a new Model is inserted.
onInsertElement(_arg: OnElementInModelPropsArg): void ProtectedStatic GeometricModel2d Called before a prospective Element is to be inserted into an instance of a Model of this class.
onInserted(_arg: OnModelIdArg): void ProtectedStatic GeometricModel2d Called after a new Model is inserted.
onInsertedElement(_arg: OnElementInModelIdArg): void ProtectedStatic GeometricModel2d Called after an Element has been inserted into an instance of a Model of this class.
onUpdate(arg: OnModelPropsArg): void ProtectedStatic GeometricModel2d Called before a Model is updated.
onUpdateElement(_arg: OnElementInModelPropsArg): void ProtectedStatic GeometricModel2d Called when an Element in an instance of a Model of this class is about to be updated.
onUpdated(_arg: OnModelIdArg): void ProtectedStatic GeometricModel2d Called after a Model is updated.
onUpdatedElement(_arg: OnElementInModelIdArg): void ProtectedStatic GeometricModel2d Called after an Element in an instance of a Model of this class has been updated.

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string GeometricModel2d Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string GeometricModel2d Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string GeometricModel2d The name of the BIS class associated with this class.
geometryGuid undefined | string GeometricModel2d  
globalOrigin undefined | Point2d GeometricModel2d The actual coordinates of (0,0) in modeling coordinates.
id string GeometricModel2d The Id of this Entity.
iModel IModelDb GeometricModel2d The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" GeometricModel2d An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isPrivate boolean GeometricModel2d  
isTemplate boolean GeometricModel2d  
jsonProperties Readonly { T } GeometricModel2d  
modeledElement Readonly RelatedElement GeometricModel2d  
name Readonly string GeometricModel2d  
parentModel Readonly string GeometricModel2d  
schema Static undefined GeometricModel2d The Schema that defines this class.
schemaName Accessor ReadOnly string GeometricModel2d The name of the BIS Schema that defines this class

Defined in

Last Updated: 25 April, 2024