API Reference > core-backend > Elements > DetailCallout

DetailCallout Class

A graphical Callout that references a detail drawing.

Extends

Methods

Name Description
constructor(props: CalloutProps, iModel: IModelDb): DetailCallout    

Inherited methods

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

Inherited properties

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

Defined in

Last Updated: 20 June, 2023