Tableau Embedding API
    Preparing search index...

    Interface DataValue

    interface DataValue {
        aliasValue?: string;
        formattedValue?: string;
        hasAlias?: boolean;
        nativeValue: any;
        value: any;
    }
    Index

    Properties

    aliasValue? formattedValue? hasAlias? nativeValue value

    Properties

    aliasValue?: string

    The alias of a value only if hasAlias is true.

    formattedValue?: string

    The value formatted according to the locale and the formatting applied to the field or parameter.

    hasAlias?: boolean

    Indicates if the DataValue contains an alias (for DataValues of Parameters with domain restriction type ParameterValueType.List).

    nativeValue: any

    The raw native value as a JavaScript type, which is one of string, number, boolean, or Date object. Please note that special values are returned as null. The actual special value can be found in formattedValue, which would be something like 'Null', or 'No-Access'. Using nativeValue can greatly simplify your error checking since all values will be their native type value or null.

    value: any

    Contains the raw native value as a JavaScript type, which is one of string, number, boolean, or Date (as a string). Please note that special values, regardless of type, are always returned as a String surrounded by percent signs, such as '%null%', or '%no-access%'.

    Settings

    Member Visibility

    On This Page

    Properties