Class Translator

Display names and help texts of BIM terms and feature paths

Index

Constructors

Methods

getDescription getMeasurementHelp isMeasurementEstimated plural pluralFirstUpper translate

Constructors

constructor

new Translator(): Translator
Returns Translator

Methods

`Static`getDescription

getDescription(key: string, context?: object): string
A description of the key, "" when there is none; context refines it (for example the quantity strategy)
Parameters
- key: string
- Optionalcontext: object
Returns string
- Defined in ViewerCommon/viewercommon.d.ts:2115

`Static`getMeasurementHelp

getMeasurementHelp(key: string, context?: object, measurement?: unknown): string
The help text of a calculated quantity for a measurement
Parameters
- key: string
- Optionalcontext: object
- Optionalmeasurement: unknown
Returns string
- Defined in ViewerCommon/viewercommon.d.ts:2117

`Static`isMeasurementEstimated

isMeasurementEstimated(key: string, measurement?: unknown): boolean
Whether a measurement is an estimate (shown as "≈"): a calculated quantity is, unless its accuracy is proven within the accepted limits for the represented IFC geometry
Parameters
- key: string
- Optionalmeasurement: unknown
Returns boolean
- Defined in ViewerCommon/viewercommon.d.ts:2122

`Static`plural

plural(key: string): string
The plural display name
Parameters
- key: string
Returns string
- Defined in ViewerCommon/viewercommon.d.ts:2111

`Static`pluralFirstUpper

pluralFirstUpper(key: string): string
The plural display name, capitalised
Parameters
- key: string
Returns string
- Defined in ViewerCommon/viewercommon.d.ts:2113

`Static`translate

translate(key: string, context?: object): string
The display name of a key (a feature path such as "calculated.quantities.netVolume"); the key itself when unknown. context refines it as in getDescription (for example a quantity of the enclosing box)
Parameters
- key: string
- Optionalcontext: object
Returns string
- Defined in ViewerCommon/viewercommon.d.ts:2109