API Reference › core-backend› Elements › TextAnnotation2d

TextAnnotation2d Class @preview

An element that displays textual content within a 2d model. The text is stored as a TextAnnotation from which the element's geometry and Placement are computed.

@see setAnnotation to change the textual content.

Extends

Methods

Name Description
constructor(props: TextAnnotation2dProps, iModel: IModelDb): TextAnnotation2d Protected    
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Collect the Ids of this entity's references at this level of the class hierarchy.  
getAnnotation(): undefined | TextAnnotation Extract the textual content, if present.  
setAnnotation(annotation: TextAnnotation): void Change the textual content of the TextAnnotation2d.  
toJSON(): TextAnnotation2dProps Obtain the JSON representation of this Entity.  
create(iModelDb: IModelDb, arg: TextAnnotation2dCreateArgs): TextAnnotation2d Static Creates a new TextAnnotation2d instance with the specified properties.  
deserialize(props: DeserializeEntityArgs): TextAnnotation2dProps Static Converts an ECSqlRow of an Entity to an EntityProps.  
fromJSON(props: TextAnnotation2dProps, iModel: IModelDb): TextAnnotation2d Static Creates a new instance of TextAnnotation2d from its JSON representation.  
onInsert(arg: OnElementPropsArg): void Protected Static Called before a new Element is inserted.  
onUpdate(arg: OnElementPropsArg): void Protected Static Called before an Element is updated.  
serialize(props: TextAnnotation2dProps, iModel: IModelDb): ECSqlRow Static Converts an EntityProps to an ECSqlRow.  
validateVersionAndUpdateGeometry(arg: OnElementPropsArg): void Protected Static Populates the elementGeometryBuilderParams property in the TextAnnotation2dProps.  

Inherited methods

Name Inherited from Description
calculateRange3d(): Range3d Inherited AnnotationElement2d  
delete(): void Inherited AnnotationElement2d Delete this Element from the iModel.
forEach(func: PropertyHandler, includeCustom: boolean = true): void Inherited AnnotationElement2d Call a function for each property of this Entity.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void Inherited AnnotationElement2d Call a function for each property of this Entity.
getClassMetaData(): undefined | EntityMetaData Inherited AnnotationElement2d Get the class metadata for this element.
getDisplayLabel(): string Inherited AnnotationElement2d Get a display label for this Element.
getJsonProperty(nameSpace: string): any Inherited AnnotationElement2d Get a JSON property of this element, by namespace
getMetaData(): Promise<EntityClass> Inherited AnnotationElement2d Query metadata for this entity class from the iModel's schema.
getPlacementTransform(): Transform Inherited AnnotationElement2d Get the Transform from the Placement of this GeometricElement
getReferenceIds(): EntityReferenceSet Inherited AnnotationElement2d Get the set of this entity's entity references, EntityReferenceSet.
getToolTipMessage(): string[] Inherited AnnotationElement2d Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any Inherited AnnotationElement2d Get a set of JSON user properties by namespace
insert(): string Inherited AnnotationElement2d Insert this Element into the iModel.
is2d(): this is GeometricElement2d Inherited AnnotationElement2d Type guard for instanceof GeometricElement2d
is3d(): this is GeometricElement3d Inherited AnnotationElement2d Type guard for instanceof GeometricElement3d
removeUserProperties(nameSpace: string): void Inherited AnnotationElement2d Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(nameSpace: string, value: any): void Inherited AnnotationElement2d  
setUserProperties(nameSpace: string, value: any): void Inherited AnnotationElement2d Change a set of user JSON properties of this Element by namespace.
update(): void Inherited AnnotationElement2d Update this Element in the iModel.
is(otherClass: Entity): boolean Static Inherited AnnotationElement2d return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void Protected Static Inherited AnnotationElement2d 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 Protected Static Inherited AnnotationElement2d Called when a root element in a subgraph is changed and before its outputs are processed.
onChildAdd(_arg: OnChildElementPropsArg): void Protected Static Inherited AnnotationElement2d 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 Protected Static Inherited AnnotationElement2d Called after an existing element has been updated so that an instance of this class is its new parent.
onChildDelete(_arg: OnChildElementIdArg): void Protected Static Inherited AnnotationElement2d Called when an element with an instance of this class as its parent is about to be deleted.
onChildDeleted(arg: OnChildElementIdArg): void Protected Static Inherited AnnotationElement2d Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void Protected Static Inherited AnnotationElement2d 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 Protected Static Inherited AnnotationElement2d 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 Protected Static Inherited AnnotationElement2d Called when a new element with an instance of this class as its parent is about to be inserted.
onChildInserted(arg: OnChildElementIdArg): void Protected Static Inherited AnnotationElement2d Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void Protected Static Inherited AnnotationElement2d Called when an element with an instance of this class as its parent is about to be updated.
onChildUpdated(arg: OnChildElementIdArg): void Protected Static Inherited AnnotationElement2d Called after an element with an instance of this the class as its parent was updated.
onDelete(arg: OnElementIdArg): void Protected Static Inherited AnnotationElement2d Called before an Element is deleted.
onDeleted(arg: OnElementIdArg): void Protected Static Inherited AnnotationElement2d Called after an Element was deleted.
onSubModelDelete(_arg: OnSubModelIdArg): void Protected Static Inherited AnnotationElement2d Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(arg: OnSubModelIdArg): void Protected Static Inherited AnnotationElement2d Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(_arg: OnSubModelPropsArg): void Protected Static Inherited AnnotationElement2d Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(arg: OnSubModelIdArg): void Protected Static Inherited AnnotationElement2d Called after an instance of this class was sub-modeled by a new Model.

Properties

Name Type Description
_customHandledProps Protected Static Readonly CustomHandledProperty[] List of properties that are need to be custom handled during deserialization and serialization.  
defaultTextStyle TextAnnotationUsesTextStyleByDefault | undefined The default AnnotationTextStyle used by the TextAnnotation2d.  

Inherited properties

Name Type Inherited from Description
_metadata Protected Inherited EntityClass | RelationshipClass AnnotationElement2d Cached Metadata for the ECClass
category Inherited string AnnotationElement2d The Id of the Category for this GeometricElement.
classFullName Accessor Inherited ReadOnly string AnnotationElement2d Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string AnnotationElement2d Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string AnnotationElement2d The name of the BIS class associated with this class.
code Inherited Code AnnotationElement2d The Code for this element
federationGuid Inherited string | undefined AnnotationElement2d A FederationGuid assigned to this element by some other federated database
geom Inherited GeometryStreamProps | undefined AnnotationElement2d The GeometryStream for this GeometricElement.
id Inherited string AnnotationElement2d The Id of this Entity.
iModel Inherited IModelDb AnnotationElement2d The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" AnnotationElement2d An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
jsonProperties Readonly Inherited [key: string]: any AnnotationElement2d Optional json properties of this element.
model Readonly Inherited string AnnotationElement2d The ModelId of the Model containing this element
parent Inherited RelatedElement | undefined AnnotationElement2d The parent element, if present, of this element.
placement Inherited Placement2d AnnotationElement2d The origin, orientation, and bounding box of this GeometricElement.
requiredReferenceKeys Static Readonly Inherited ReadonlyArray AnnotationElement2d  
schema Static Inherited Schema AnnotationElement2d The Schema that defines this class.
schemaItemKey Accessor Inherited ReadOnly SchemaItemKey AnnotationElement2d Get the item key used by the ecschema-metadata package to identify this entity class
schemaItemKey Accessor Static Inherited ReadOnly SchemaItemKey AnnotationElement2d Serves as a unique identifier for this class. Typed variant of classFullName.
schemaName Accessor Inherited ReadOnly string AnnotationElement2d The name of the BIS Schema that defines this class
typeDefinition Inherited TypeDefinition | undefined AnnotationElement2d  
userLabel Inherited string | undefined AnnotationElement2d A user-assigned label for this element.

Defined in

Last Updated: 24 October, 2025