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

    Interface WorksheetSnapshot

    Everything one worksheet contributes, read once and then never awaited again.

    This is the boundary between the async half of the adapter (reader.ts) and the pure half (fields.ts, extractor.ts): the extractor is handed snapshots and produces a figure with no I/O of its own.

    interface WorksheetSnapshot {
        name: string;
        columns: readonly TableauColumn[];
        rows: readonly TableauRow[];
        spec?: TableauVisualSpecification;
        geometry?: TableauWorksheetGeometry;
    }
    Index

    Properties

    name: string
    columns: readonly TableauColumn[]

    Columns in view order, exactly as getSummaryColumnsInfoAsync gave them.

    rows: readonly TableauRow[]

    Every row, already remapped into view order.

    Present only when the host exposes getVisualSpecificationAsync.

    Where this worksheet sits on the dashboard.

    Present only when the active sheet is a dashboard whose objects reported usable geometry — so absence covers an older Embedding library, a lone worksheet sheet, a story, and a worksheet no dashboard object named. The extractor needs it on every surviving worksheet before it will lay the figure out as a grid; one gap and the whole figure is a column again.