SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface OutlineProps

    Props for the outline: the row and column gutters and their level buttons.

    The HTML attributes (className, style, …) apply to each of the outline's boxes: both gutters and both level strips. Where they sit in the sheet is not theirs to change.

    interface OutlineProps {
        bracketGap?: number;
        laneGap?: number;
        laneSize?: number;
        renderButton?: (props: OutlineButtonProps) => ReactNode;
        renderLevelButton?: (props: OutlineLevelButtonProps) => ReactNode;
    }

    Hierarchy

    • HTMLAttributes<HTMLDivElement>
      • OutlineProps
    Index
    bracketGap? laneGap? laneSize? renderButton? renderLevelButton?
    bracketGap?: number

    Space between a bracket's end and its button, in pixels.

    0
    laneGap?: number

    The space around the buttons, in pixels: between neighbors, and before the first and after the last. Not scaled by zoom.

    1
    laneSize?: number

    The size of one level's lane across the gutter, in pixels at 100% zoom. A button fills its lane, less laneGap.

    18

    The default button is Excel desktop's 17 pixels. Keep the button odd (laneSize - laneGap) and the + or − sits on its center pixel.

    renderButton?: (props: OutlineButtonProps) => ReactNode

    Renders a group's collapse / expand button, filling the square it is placed in. Defaults to OutlineButton.

    renderLevelButton?: (props: OutlineLevelButtonProps) => ReactNode

    Renders a level button, filling the square it is placed in. Defaults to OutlineLevelButton.

    Settings
    Member Visibility

    On This Page
    Properties