AnnotationElement2d Class

2d element used to annotate drawings and sheets.

Extends

Extended by

Implements

Inherited methods

Name Inherited from Description
buildConcurrencyControlRequest(opcode: DbOpcode): void Element Add a request for locks, code reservations, and anything else that would be needed to carry out the specified operation.
calculateRange3d(): AxisAlignedBox3d GeometricElement  
clone(): this Entity Make a deep copy of this Entity
delete(): void Element Delete this Element from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: boolean = false): void Entity Call a function for each property of this Entity.
Element Get the class metadata for this element.
getDisplayLabel(): string Element Get a display label for this Element.
getJsonProperty(nameSpace: string): any Element Get a JSON property of this element, by namespace
getPlacementTransform(): Transform GeometricElement Get the Transform from the Placement of this GeometricElement
getToolTipMessage(): string[] Element Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any Element Get a set of JSON user properties by namespace
insert(): string Element Insert this Element into the iModel.
is2d(): boolean GeometricElement Type guard for instanceof GeometricElement2d
is3d(): boolean GeometricElement Type guard for instanceof GeometricElement3d
removeUserProperties(nameSpace: string): void Element Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(nameSpace: string, value: any): void Element  
setUserProperties(nameSpace: string, value: any): void Element Change a set of user JSON properties of this Element by namespace.
update(): void Element Update this Element in the iModel.
onAllInputsHandled(_id: Id64String, _iModel: IModelDb): void ProtectedStatic Element  
onBeforeOutputsHandled(_id: Id64String, _iModel: IModelDb): void ProtectedStatic Element  
onDelete(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic Element Called before an Element is deleted.
onDeleted(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic Element Called after an Element was deleted.
onInsert(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic Element Called before a new Element is inserted.
onInserted(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic Element Called after a new Element was inserted.
onUpdate(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic Element Called before an Element is updated.
onUpdated(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic Element Called after an Element was updated.

Inherited properties

Name Type Inherited from Description
category Id64String GeometricElement The Id of the Category for this GeometricElement.
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.
code Code Element The Code for this element
federationGuid undefined | GuidString Element A FederationGuid assigned to this element by some other federated database
geom undefined | GeometryStreamProps GeometricElement The GeometryStream for this GeometricElement.
id Id64String Entity The Id of this Entity.
iModel IModelDb Entity The Entity.IModelDb that contains this Entity
jsonProperties [key: string]: any Element Optional json properties of this element.
model Id64String Element The ModelId of the Model containing this element
parent undefined | RelatedElement Element The parent element, if present, of this element.
placement Placement2d GeometricElement2d  
schema Static Schema Entity The Schema that defines this class.
schemaName Accessor ReadOnly string Entity The name of the BIS Schema that defines this class
typeDefinition undefined | TypeDefinition GeometricElement2d  
userLabel undefined | string Element A user-assigned label for this element.

Defined in

Last Updated: 20 September, 2019