QuantityFormatting

Classes for formatting and parsing quantity values.

Classes

Name Description  
BaseUnitFormattingSettingsProvider This abstract class reacts to changes in the "active" iModel and updates the QuantityFormatter overrides and active Beta
LocalUnitFormatProvider Implementation of BaseUnitFormattingSettingsProvider that stores and retrieves data in local storage. Beta
QuantityFormatter Class that supports formatting quantity values into strings and parsing strings into quantity values. Beta

Enumerations

Name Description  
QuantityType Defines standard format types for tools that need to display measurements to user. Beta

Global Functions

Name Description  
getQuantityTypeKey Function to return a QuantityTypeKey given either a QuantityType or a string Beta
isCheckboxFormatPropEditorSpec CheckboxFormatPropEditorSpec type guard. Beta
isCustomQuantityTypeDefinition CustomQuantityTypeDefinition type guard. Beta
isTextInputFormatPropEditorSpec TextInputFormatPropEditorSpec type guard. Beta
isTextSelectFormatPropEditorSpec TextSelectFormatPropEditorSpec type guard. Beta

Interfaces

Name Description  
CheckboxFormatPropEditorSpec CheckboxFormatPropEditorSpec defines getter and setter method for a boolean property editor. Beta
CustomFormatPropEditorSpec Properties that define an EditorSpec for editing a custom formatting property that is stored in the "custom" property in the FormatProps. Beta
CustomQuantityTypeDefinition CustomQuantityTypeDefinition interface is used to define a Custom quantity type that can be registered with the QuantityFormatter. Beta
FormatterParserSpecsProvider Interface that defines the functions required to be implemented to provide custom formatting and parsing of a custom quantity type. Beta
FormattingUnitSystemChangedArgs Arguments sent to FormattingUnitSystemChanged event listeners. Beta
OverrideFormatEntry Override format entries can define formats for any of the different unit systems. Beta
QuantityFormatOverridesChangedArgs Arguments sent to UnitFormattingSettingsProvider when overrides are changed. Beta
QuantityFormatsChangedArgs Arguments sent to QuantityFormatsChanged event listeners. Beta
QuantityTypeDefinition Definition of a standard QuantityType that is registered with the QuantityFormatter. Beta
TextInputFormatPropEditorSpec TextInputFormatPropEditorSpec defines getter and setter method for a text input property editor. Beta
TextSelectFormatPropEditorSpec TextSelectFormatPropEditorSpec defines getter and setter method for a Select/Dropdown property editor. Beta
UnitFormattingSettingsProvider The UnitFormattingSettingsProvider interface is used to store and retrieve override FormatProps and Presentation Unit System for use by the QuantityFormatter. Beta

Type Aliases

Name Description  
QuantityTypeArg Type the can be used to uniquely identify a Quantity Type. Beta
QuantityTypeKey String used to uniquely identify a QuantityType in the quantity registry. Beta
UnitSystemKey Used to uniquely identify a unit system. Beta

Last Updated: 15 June, 2021