FormattedQuantityDescription Class @beta
Deprecated in 5.11.0. This appui-based quantity description API is deprecated. Use createQuantityDescription to build a plain PropertyDescription with synchronous quantity formatting callbacks backed by IModelApp.quantityFormatter.
Base Quantity Property Description
Extends
Extended by
Methods
| Name | Description | |
|---|---|---|
| constructor(args: FormattedQuantityDescriptionArgs): FormattedQuantityDescription | ||
| constructor(name: string, displayLabel: string, iconSpec?: string, kindOfQuantityName?: string): FormattedQuantityDescription | ||
| formatValue(numberValue: number): string Protected | ||
| parseString(userInput: string): ParseResults Protected |
Properties
| Name | Type | Description | |
|---|---|---|---|
| formatterQuantityType Accessor Abstract ReadOnly | QuantityType | ||
| formatterSpec Accessor ReadOnly | FormatterSpec | undefined | ||
| parseError Accessor Abstract ReadOnly | string | ||
| parserSpec Accessor ReadOnly | ParserSpec | undefined |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| displayLabel Inherited | string | BaseQuantityDescription | Display label for the property description |
| editor Inherited | PropertyEditorInfo | BaseQuantityDescription | Information for a property editor |
| format Inherited | (numberValue: number) => string | BaseQuantityDescription | |
| kindOfQuantityName Inherited | string | undefined | BaseQuantityDescription | KindOfQuantity full name used to look up FormatProps |
| name Inherited | string | BaseQuantityDescription | Name of the property description |
| parse Inherited | (userInput: string) => ParseResults | BaseQuantityDescription | |
| typename Inherited | string | BaseQuantityDescription | Type name used to determine applicable Type Converter and Property Editor |
Defined in
Last Updated: 23 June, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.