API Reference › core-backend› ViewDefinitions › ViewAttachment

ViewAttachment Class

Represents an attachment of a ViewDefinition to a Sheet.

Extends

Methods

Name Description
constructor(props: ViewAttachmentProps, iModel: IModelDb): ViewAttachment    
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Collect the Ids of this entity's references at this level of the class hierarchy.  

Inherited methods

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

Properties

Name Type Description
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  
view RelatedElement    

Inherited properties

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

Defined in

Last Updated: 28 October, 2024