API Reference › core-backend› ViewDefinitions › AuxCoordSystem3d

AuxCoordSystem3d Class

A 3d auxiliary coordinate system.

Extends

Extended by

Methods

Name Description
constructor(props: AuxCoordSystem3dProps, iModel: IModelDb): AuxCoordSystem3d    
createCode(iModel: IModelDb, scopeModelId: string, codeValue: string): Code Static Create a Code for a AuxCoordSystem3d element given a name that is meant to be unique within the scope of the specified DefinitionModel.  

Inherited methods

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

Properties

Name Type Description
origin Point3d | undefined    
pitch number    
roll number    
yaw number    

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string AuxCoordSystem Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static ReadOnly string AuxCoordSystem Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string AuxCoordSystem The name of the BIS class associated with this class.
code Code AuxCoordSystem The Code for this element
description string | undefined AuxCoordSystem  
federationGuid string | undefined AuxCoordSystem A FederationGuid assigned to this element by some other federated database
id string AuxCoordSystem The Id of this Entity.
iModel IModelDb AuxCoordSystem The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" AuxCoordSystem An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isPrivate boolean AuxCoordSystem If true, don't show this DefinitionElement in user interface lists.
jsonProperties Readonly [key: string]: any AuxCoordSystem Optional json properties of this element.
model Readonly string AuxCoordSystem The ModelId of the Model containing this element
parent RelatedElement | undefined AuxCoordSystem The parent element, if present, of this element.
requiredReferenceKeys Static Readonly AuxCoordSystem A required reference is an element that had to be inserted before this element could have been inserted.
schema Static AuxCoordSystem The Schema that defines this class.
schemaName Accessor ReadOnly string AuxCoordSystem The name of the BIS Schema that defines this class
type number AuxCoordSystem  
userLabel string | undefined AuxCoordSystem A user-assigned label for this element.

Defined in

Last Updated: 13 May, 2024