Menu

Hierarchy

Index

Properties

abbreviation

abbreviation: Abbreviation

sets how to display abbreviations

addressSubset

addressSubset: {}

selects a set of data points the addresses of which are improper supersets of the addressSubset

Type declaration

  • [dimKey: string]: Member["key"][]

Optional billionAbbreviation

billionAbbreviation: string

overwrites the string being used for abbreviating billions originally defined by the active locale. determined by locale when not defined. a value of null should lead to the same behavior as an undefined property

Optional decimalSeparator

decimalSeparator: string

single character used for separating the integer part from the fractional part. is set by locale when not defined. a value of null should lead to the same behavior as an undefined property

Optional description

description: string

name of the DataSelection to identify it easily

explicitPositiveSign

explicitPositiveSign: boolean

if true, positive numbers contain a leading + sign

format

format: FormatType

The format type to be used

fractionalDigits

fractionalDigits: number

sets how many fractional digits should be displayed; may fill with zeroes

infinityOutput

infinityOutput: string

when specified, replaces the formattedValue of Infinity values or NaN values with this string

Optional integerDigits

integerDigits: number

sets how many digits the integer part should have; may fill with zeroes. When not defined, number of integer digits are not enforced. a value of null should lead to the same behavior as an undefined property

localeId

localeId: LocaleIdentifier

only locale strings are allowed to keep the config serializable. Locale affects things like abbreviations or ordinals

Optional millionAbbreviation

millionAbbreviation: string

overwrites the string being used for abbreviating millions originally defined by the active locale. determined by locale when not defined. a value of null should lead to the same behavior as an undefined property

negativeSign

negativeSign: NegativeSignMode

sets how to display negative numbers

nullOutput

nullOutput: string

when specified, replaces the formattedValue of null values with this string

prefix

prefix: string

gets prepended to the number string

Optional relationId

relationId: string

An id that can be shared by multiple DataSelections to implement features where a relation between Data Selections exist. For example when the creation of a config creates a related config for another property which should be updated during the lifecycle of the source config.

roundingMethod

roundingMethod: RoundingMethod

sets how to round the numbers

scalingFactor

scalingFactor: number

scales the number before formatting by multiplying it with the scaling factor

spaceSeparatedAbbreviations

spaceSeparatedAbbreviations: boolean

whether the abbreviation should be separated from the number string using a space

suffix

suffix: string

gets appended to the number string

Optional thousandAbbreviation

thousandAbbreviation: string

overwrites the string being used for abbreviating thousands originally defined by the active locale. determined by locale when not defined. a value of null should lead to the same behavior as an undefined property

Optional thousandSeparator

thousandSeparator: string

single character used for separating thousands-groups. set by locale, when not defined. a value of null should lead to the same behavior as an undefined property

Optional totalDigits

totalDigits: number

if set, the fractional digits and abbreviation will be chosen to result in a total amount of digits closest to the determined amount. When not defined, number of total digits are not enforced. a value of null should lead to the same behavior as an undefined property

Optional trillionAbbreviation

trillionAbbreviation: string

overwrites the string being used for abbreviating trillions originally defined by the active locale. determined by locale when not defined. a value of null should lead to the same behavior as an undefined property

Optional zeroOutput

zeroOutput: string

when specified, replaces the formattedValue of zero values with this string. a value of null should lead to the same behavior as an undefined property