Salesforce Docs Portal

DataFormattingOptions | Tableau Embedding API

Interface DataFormattingOptions

interface DataFormattingOptions {
    customFormatString: string;
    decimalCharacter: string;
    decimals: number;
    formatType: DataFormatType;
    locale: string;
    negativeFormat: NegativeNumberFormat;
    prefix: string;
    separatorCharacter: string;
    showSeparators: boolean;
    suffix: string;
    units: NumberFormatUnits;
}
Index

Properties

customFormatString decimalCharacter decimals formatType locale negativeFormat prefix separatorCharacter showSeparators suffix units

Properties

customFormatString: string

The custom format string to display for the value. For more information on number formats, see Format Numbers and Null Values. When the custom format string is used for numbers, other formatting options are ignored. For information on formatting dates, see Custom Date Formats. The custom format string is always used for dates and the other formatting options do not apply (except for the formatType and locale).

decimalCharacter: string

The character to use as the decimal point.

decimals: number

The number of digits to display after the decimal point.

formatType: DataFormatType

The type of the format. Can specify number, currency, date, time, percentage, scientific, or auto-format (default). For numbers, can also specify custom number format.

locale: string

The locale of the format (e.g. en-US, fr-FR, etc.).

negativeFormat: NegativeNumberFormat

The format for displaying .

prefix: string

The prefix to display before the value.

separatorCharacter: string

The character to use as the thousand separator.

showSeparators: boolean

Whether to show thousand separators.

suffix: string

The suffix to display after the value.

units: NumberFormatUnits

Display the number using specified units (e.g. K for thousands, M for millions, B for billions, etc.).

Settings

Member Visibility

On This Page

Properties