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

    Interface TableauDataTableReader

    Paginated reader over a worksheet's summary data.

    Only one active reader for summary data is supported per viz, and releaseAsync must be called — later calls on a released reader throw. Both facts are why reader.ts owns a serial queue and a finally.

    interface TableauDataTableReader {
        pageCount: number;
        totalRowCount: number;
        getPageAsync: (pageNumber: number) => Promise<TableauDataTable>;
        getAllPagesAsync?: (maxRows?: number) => Promise<TableauDataTable>;
        releaseAsync: () => Promise<void>;
    }
    Index

    Properties

    pageCount totalRowCount getPageAsync getAllPagesAsync? releaseAsync

    Properties

    pageCount: number
    totalRowCount: number
    getPageAsync: (pageNumber: number) => Promise<TableauDataTable>
    getAllPagesAsync?: (maxRows?: number) => Promise<TableauDataTable>

    Documented convenience that concatenates every page. Not used — it caps at 400 pages and hides which page a failure came from — but declared because a real reader has it.

    releaseAsync: () => Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties