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

    Interface SelectRegionOptions

    Options for selecting a region.

    interface SelectRegionOptions {
        anchor?: boolean | Partial<CellCoords>;
        autoFocus?: boolean;
        axis?: AxisSelection;
        contentOnly: boolean;
        entireRegion?: boolean;
        preserveSelectedSheet?: boolean;
        scrollIntoView?: boolean | ScrollIntoViewOptions;
    }

    Hierarchy (View Summary)

    Index
    anchor? autoFocus? axis? contentOnly entireRegion? preserveSelectedSheet? scrollIntoView?
    anchor?: boolean | Partial<CellCoords>

    If true then the anchor cell will be adjusted to the top-left cell of the range.

    false

    If the current anchor is not within the current range this will be forced to true.

    autoFocus?: boolean

    If true, the selected element will automatically receive focus after being selected.

    • If false (or omitted), the element will not automatically receive focus.
    false
    axis?: AxisSelection

    Restrict the region to entire rows/columns along an axis, filling the enclosing region on that axis while bounding the other axis to the current active range. Named for what is selected (Excel's Ctrl+Space / Shift+Space):

    • Column — select the column(s): fill the region's rows, keep the current columns.
    • Row — select the row(s): fill the region's columns, keep the current rows.
    • Both — select the entire region on both axes.

    Applied to this selection's active range in place (so it also drives a temporary picker selection and preserves the other ranges), unlike the whole-selection entireRegion.

    IRange.AxisSelection.Both

    contentOnly: boolean

    Whether to select content only.

    entireRegion?: boolean

    Whether to select the entire region.

    preserveSelectedSheet?: boolean

    If true, the currently selected sheet will not change as part of the selection. By default, selecting a range will also select its parent sheet, matching Excel behavior.

    false
    scrollIntoView?: boolean | ScrollIntoViewOptions

    If true or if a valid ScrollIntoViewOptions object is provided, the selected element will be scrolled into view.

    • If a ScrollIntoViewOptions object is provided, it will control the exact scrolling behavior.
    • If false (or omitted), the selected element will not be scrolled into view.
    false

    Settings
    Member Visibility

    On This Page
    Properties