API Reference › core-backend › ViewDefinitions › AuxCoordSystemSpatial

AuxCoordSystemSpatial Class

A spatial auxiliary coordinate system.

Extends

Methods

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

Inherited properties

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

Defined in

Last Updated: 16 April, 2024