SheetXL - v1.0.2
    Preparing search index...

    Interface PivotTablePaneProps

    Props for PivotTablePane.

    interface PivotTablePaneProps {
        args?: PivotTablePaneArgs;
        entryKey: string;
        frame?: IFrame;
        model?: any;
        ref?: Ref<any>;
        renderFilter?: ((props: PivotMenuRenderProps) => ReactNode) | null;
        renderHeader?: (props: PivotTableHeaderProps) => ReactNode;
        renderMenu?: ((props: PivotChipMenuRenderProps) => ReactNode) | null;
    }

    Hierarchy (View Summary)

    Index
    args? entryKey frame? model? ref? renderFilter? renderHeader? renderMenu?
    args?: PivotTablePaneArgs

    What the activating call asked this pane to show — ActivateFrameOptions.args, delivered verbatim.

    The pane defines the shape; the area only carries it. It is scoped to one activation rather than to the pane's lifetime: activating again without it clears it, and re-delivering the same payload means passing it again. So a pane treats an arriving value as an EVENT — react to it changing, not to its presence, or a re-render replays it.

    undefined is the ordinary case: opened from the ribbon, a pane is asked for nothing in particular.

    entryKey: string

    The key used to register the taskPane.

    frame?: IFrame
    model?: any
    ref?: Ref<any>

    Ref to the task pane's root element (React 19 ref-as-prop).

    renderFilter?: ((props: PivotMenuRenderProps) => ReactNode) | null

    As PivotFieldsProps.renderFilter.

    renderHeader?: (props: PivotTableHeaderProps) => ReactNode

    The table's name and source above its fields, for a host that edits them. Absent, the name is shown as text.

    renderMenu?: ((props: PivotChipMenuRenderProps) => ReactNode) | null

    As PivotFieldsProps.renderMenu.

    Settings
    Member Visibility

    On This Page
    Properties