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

    Interface TableauWorksheetOverride

    What a page can tell the adapter about a single worksheet when the heuristics read it wrong.

    Every field is JSON-serializable on purpose: a future Extensions binder can read the same object straight out of tableau.extensions.settings without a second configuration format existing.

    interface TableauWorksheetOverride {
        skip?: boolean;
        traceType?: TraceType;
        title?: string;
        x?: string;
        y?: string;
        z?: string;
        orientation?: Orientation;
        stepDirection?: StepDirection;
        axes?: { x?: string; y?: string; z?: string };
    }
    Index

    Properties

    skip? traceType? title? x? y? z? orientation? stepDirection? axes?

    Properties

    skip?: boolean

    Leave this worksheet out of the figure entirely.

    traceType?: TraceType

    What the worksheet is. Outranks the visual specification and the ladder.

    title?: string

    Layer title; defaults to the worksheet name.

    x?: string

    Column.fieldName (or fieldId) to use as the category / x axis.

    y?: string

    Measure to use as the value.

    z?: string

    Dimension to group series by.

    orientation?: Orientation

    Nothing in summary data says which way the bars were drawn.

    stepDirection?: StepDirection

    Nothing in summary data says where a step jumps.

    axes?: { x?: string; y?: string; z?: string }

    Axis labels, when the field captions are not what a reader should hear.

    Settings

    Member Visibility

    On This Page

    Properties