API Reference > imodeljs-backend > Elements > GraphicalElement2d

GraphicalElement2d Class

An abstract base class for 2d Geometric Elements that are used to convey information within graphical presentations (like drawings).

Extends

Extended by

Inherited methods

Name Inherited from Description
buildConcurrencyControlRequest(opcode: DbOpcode): void GeometricElement2d Add a request for locks, code reservations, and anything else that would be needed to carry out the specified operation.
calculateRange3d(): Range3d GeometricElement2d  
delete(): void GeometricElement2d Delete this Element from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void GeometricElement2d Call a function for each property of this Entity.
getClassMetaData(): undefined | EntityMetaData GeometricElement2d Get the class metadata for this element.
getDisplayLabel(): string GeometricElement2d Get a display label for this Element.
getJsonProperty(nameSpace: string): any GeometricElement2d Get a JSON property of this element, by namespace
getPlacementTransform(): Transform GeometricElement2d Get the Transform from the Placement of this GeometricElement
getPredecessorIds(): Id64Set GeometricElement2d Get the Ids of this element's predecessors.
getToolTipMessage(): string[] GeometricElement2d Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any GeometricElement2d Get a set of JSON user properties by namespace
insert(): string GeometricElement2d Insert this Element into the iModel.
is2d(): this is GeometricElement2d GeometricElement2d Type guard for instanceof GeometricElement2d
is3d(): this is GeometricElement3d GeometricElement2d Type guard for instanceof GeometricElement3d
removeUserProperties(nameSpace: string): void GeometricElement2d Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(nameSpace: string, value: any): void GeometricElement2d  
setUserProperties(nameSpace: string, value: any): void GeometricElement2d Change a set of user JSON properties of this Element by namespace.
update(): void GeometricElement2d Update this Element in the iModel.
is(otherClass: undefined): boolean Static GeometricElement2d return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic GeometricElement2d 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 ProtectedStatic GeometricElement2d Called when a root element in a subgraph is changed and before its outputs are processed.
onChildAdd(_arg: OnChildElementPropsArg): void ProtectedStatic GeometricElement2d 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 ProtectedStatic GeometricElement2d Called after an existing element has been updated so that an instance of this class is its new parent.
onChildDelete(_arg: OnChildElementIdArg): void ProtectedStatic GeometricElement2d Called when an element with an instance of this class as its parent is about to be deleted.
onChildDeleted(_arg: OnChildElementIdArg): void ProtectedStatic GeometricElement2d Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void ProtectedStatic GeometricElement2d 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 ProtectedStatic GeometricElement2d 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 ProtectedStatic GeometricElement2d Called when a new element with an instance of this class as its parent is about to be inserted.
onChildInserted(_arg: OnChildElementIdArg): void ProtectedStatic GeometricElement2d Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void ProtectedStatic GeometricElement2d Called when an element with an instance of this class as its parent is about to be updated.
onChildUpdated(_arg: OnChildElementIdArg): void ProtectedStatic GeometricElement2d Called after an element with an instance of this the class as its parent was updated.
onCloned(_context: IModelCloneContext, _sourceProps: ElementProps, _targetProps: ElementProps): void ProtectedStatic GeometricElement2d Called during the iModel transformation process after an Element from the source iModel was cloned for the target iModel.
onDelete(arg: OnElementIdArg): void ProtectedStatic GeometricElement2d Called before an Element is deleted.
onDeleted(_arg: OnElementIdArg): void ProtectedStatic GeometricElement2d Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void ProtectedStatic GeometricElement2d Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void ProtectedStatic GeometricElement2d Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void ProtectedStatic GeometricElement2d Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(_arg: OnSubModelIdArg): void ProtectedStatic GeometricElement2d Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(_arg: OnSubModelPropsArg): void ProtectedStatic GeometricElement2d Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(_arg: OnSubModelIdArg): void ProtectedStatic GeometricElement2d Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void ProtectedStatic GeometricElement2d Called before an Element is updated.
onUpdated(arg: OnElementIdArg): void ProtectedStatic GeometricElement2d Called after an Element was updated.
populateRequest(req: ConcurrencyControl.Request, props: ElementProps, iModel: IModelDb, opcode: DbOpcode, original: undefined | ElementProps): void Static GeometricElement2d Disclose the codes and locks needed to perform the specified operation on this element

Inherited properties

Name Type Inherited from Description
category string GeometricElement2d The Id of the Category for this GeometricElement.
classFullName Accessor ReadOnly string GeometricElement2d Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string GeometricElement2d Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string GeometricElement2d The name of the BIS class associated with this class.
code Code GeometricElement2d The Code for this element
federationGuid undefined | string GeometricElement2d A FederationGuid assigned to this element by some other federated database
geom undefined | GeometryStreamProps GeometricElement2d The GeometryStream for this GeometricElement.
id string GeometricElement2d The Id of this Entity.
iModel IModelDb GeometricElement2d The IModelDb that contains this Entity
jsonProperties Readonly { T } GeometricElement2d Optional json properties of this element.
model Readonly string GeometricElement2d The ModelId of the Model containing this element
parent undefined | RelatedElement GeometricElement2d The parent element, if present, of this element.
placement Placement2d GeometricElement2d  
schema Static undefined GeometricElement2d The Schema that defines this class.
schemaName Accessor ReadOnly string GeometricElement2d The name of the BIS Schema that defines this class
typeDefinition undefined | TypeDefinition GeometricElement2d  
userLabel undefined | string GeometricElement2d A user-assigned label for this element.

Defined in

Last Updated: 12 June, 2024