search

Preparing search index...
The search index is not available

Class RVNumberFormattingSpec

Number field formatting specification

Hierarchy

RVFormattingSpec
- RVNumberFormattingSpec

Index

Constructors

constructor

Accessors

Constructors

constructor

new RVNumberFormattingSpec(): RVNumberFormattingSpec

Inherited from RVFormattingSpec.constructor

Returns RVNumberFormattingSpec

Accessors

abbreviationType

get abbreviationType(): RVDashboardNumberAbbreviationType
set abbreviationType(value: RVDashboardNumberAbbreviationType): void

The large number abbreviation type (K = Thousands, M = Millions, B = Billions, T = Trillions)

Returns RVDashboardNumberAbbreviationType
The large number abbreviation type (K = Thousands, M = Millions, B = Billions, T = Trillions)

Parameters
- value: RVDashboardNumberAbbreviationType
Returns void

applyMkFormat

get applyMkFormat(): boolean
set applyMkFormat(value: boolean): void

@deprecated

Use abbreviationType instead.

Apply M/K format. Default is false. It only applies to some of the visualizations (e.g. charts)

Returns boolean
Parameters
- value: boolean
Returns void

currencySymbol

get currencySymbol(): null | string
set currencySymbol(value: null | string): void

Custom currency symbol

Returns null | string
Custom currency symbol

Parameters
- value: null | string
Returns void

decimalDigits

get decimalDigits(): number
set decimalDigits(value: number): void

Number of decimal digits. Default is 0.

Returns number
Number of decimal digits. Default is 0.

Parameters
- value: number
Returns void

formatType

get formatType(): RVDashboardNumberFormattingType
set formatType(value: RVDashboardNumberFormattingType): void

Format type

Returns RVDashboardNumberFormattingType
Format type

Parameters
- value: RVDashboardNumberFormattingType
Returns void

locale

get locale(): null | string
set locale(value: null | string): void

Locale used for numerals and date names. Must be in ISO language - ISO country format. E.g.: 'en-us'.

Returns null | string
Locale used for numerals and date names. Must be in ISO language - ISO country format. E.g.: 'en-us'.

Parameters
- value: null | string
Returns void

negativeFormat

get negativeFormat(): RVDashboardNegativeFormatType
set negativeFormat(value: RVDashboardNegativeFormatType): void

Negative values format type

Returns RVDashboardNegativeFormatType
Negative values format type

Parameters
- value: RVDashboardNegativeFormatType
Returns void

showGroupingSeparator

get showGroupingSeparator(): boolean
set showGroupingSeparator(value: boolean): void

Show/Hide grouping separator

Returns boolean
Show/Hide grouping separator

Parameters
- value: boolean
Returns void