MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface TableauFieldInstance

    One field of a visual specification, with its properties.

    Mirrors FieldInstance in ExternalContract/Shared/VisualModelInterface.d.ts together with every member it inherits from FieldBase in ExternalContract/Shared/DataSourceInterfaces.d.ts: twelve inherited members plus fieldId.

    Note that description and dataType are required keys whose value may be undefined, not optional keys — that is how the vendor declares them, and the distinction is the difference between "Tableau reported no description" and "the payload never had the key".

    interface TableauFieldInstance {
        name: string;
        description: string | undefined;
        dataType: TableauDataType | undefined;
        role: TableauFieldRoleType;
        aggregation: TableauFieldAggregationType;
        columnType: TableauFieldColumnType;
        isCalculatedField: boolean;
        isCombinedField: boolean;
        isGenerated: boolean;
        isGeospatial: boolean;
        isHidden: boolean;
        isPresentOnPublishedDatasource: boolean;
        fieldId: string;
    }
    Index

    Properties

    name: string

    The field's caption, e.g. Sales.

    description: string | undefined

    The author's description of the field, undefined when there is none.

    dataType: TableauDataType | undefined
    isCalculatedField: boolean
    isCombinedField: boolean
    isGenerated: boolean

    Whether Tableau generated the field, e.g. Measure Values.

    isGeospatial: boolean
    isHidden: boolean
    isPresentOnPublishedDatasource: boolean
    fieldId: string

    Unique across every data source in the workbook, and — in summary data — inclusive of the aggregation. Documented as changing when the data source is replaced, so it is a within-session key and not a durable one.