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

    Interface TableauWorksheetGeometry

    Where a worksheet sits on its dashboard, in the dashboard's own pixel space.

    Flattened out of TableauPoint and TableauSize rather than holding them, for the same reason every other field of a snapshot is a primitive: the snapshot is a plain JSON-serializable value that a future Dashboard Extensions binder can fill in unchanged, and the extractor that reads it must never be handed a live Tableau object.

    All four numbers come from the same object's position and size, so they are mutually comparable whatever the units turn out to be; the extractor uses the extents only inside ratios, never against a fixed pixel tolerance.

    interface TableauWorksheetGeometry {
        x: number;
        y: number;
        width: number;
        height: number;
        isFloating: boolean;
        isVisible: boolean;
    }
    Index

    Properties

    x: number

    Left edge, relative to the top-left corner of the dashboard.

    y: number

    Top edge, relative to the top-left corner of the dashboard.

    width: number
    height: number
    isFloating: boolean

    True when the object floats above the tiled layout instead of within it.

    isVisible: boolean

    True when the object is visible on the dashboard.