AuxCoordSystemState Class

The state of an AuxCoordSystem element in the frontend


Extended by



Name Description
constructor(props: AuxCoordSystemProps, iModel: IModelConnection): AuxCoordSystemState    
display(context: DecorateContext, options: ACSDisplayOptions): void    
drawGrid(context: DecorateContext): void    
getOrigin(result?: Primitives.Point3d): Point3d Abstract    
getRotation(result?: Matrix3d): Matrix3d Abstract get a copy of the rotation matrix for this ACS.  
isValidForView(view: ViewState): boolean    
setOrigin(val: XYAndZ | XAndY): void Abstract    
setRotation(val: Matrix3d): void Abstract    
toJSON(): AuxCoordSystemProps    
createNew(acsName: string, iModel: IModelConnection): AuxCoordSystemState Static Create a new AuxCoordSystemState.  
fromProps(props: AuxCoordSystemProps, iModel: IModelConnection): AuxCoordSystemState Static    
isOriginInView(drawOrigin: Point3d, viewport: Viewport, adjustOrigin: boolean): boolean Static Given an origin point, returns whether the point falls within the view or not.  

Inherited methods

Name Inherited from Description
clone(iModel?: IModelConnection): this EntityState Make an independent copy of this EntityState
equals(other: this): boolean EntityState Return true if this EntityState is equal to another one.


Name Type Description
description undefined | string    
is3d Accessor ReadOnly boolean    
type number    

Inherited properties

Name Type Inherited from Description
classFullName Accessor StaticReadOnly string EntityState Get full BIS class name of this Entity in the form "SchemaName:ClassName".
classFullName string EntityState The full class name in the form "schema:class".
className Accessor ReadOnly string EntityState The name of the BIS class associated with this class.
code Code ElementState The Code for this element
federationGuid undefined | GuidString ElementState A FederationGuid assigned to this element by some other federated database
id Id64String EntityState The Id of this Entity.
iModel IModelConnection EntityState The iModel from which this Entity was loaded
jsonProperties [key: string]: any EntityState Optional json properties of this Entity.
model Id64String ElementState The ModelId of the Model containing this element
parent undefined | RelatedElement ElementState The parent Element of this, or undefined if no parent.
schemaName Accessor StaticReadOnly string EntityState The name of the BIS schema for this class.
userLabel undefined | string ElementState A user-assigned label for this element.

Defined in

Last Updated: 20 September, 2019