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

    Interface GetByRangesOptions

    Options for INamedCollection.getByRanges.

    The same filters GetItemsOptions offers, minus the two that describe a spatial query: address is the method's own argument, and allowExtrudes loosens a match that this method defines as exact. Neither has a meaning here, so neither is accepted.

    interface GetByRangesOptions {
        home?: CellCoords | null;
        includeHidden?: boolean;
        includeParts?: boolean;
        name?: string;
        scope?: string | null;
        type?: string;
    }

    Hierarchy

    Index
    home? includeHidden? includeParts? name? scope? type?
    home?: CellCoords | null

    The cell of the formula a part reference is for.

    Only read with includeParts. A table cell in the formula's own row is a this-row reference (Sales[@Amount]), and inside the table a single column drops the table name ([Amount], [@Amount]). Without it every part is qualified (Sales[Amount]) and a row's cells are addresses.

    includeHidden?: boolean

    If 'true' then include hidden named ranges.

    includeParts?: boolean

    If true also match the insides of an item, returning a reference to the part.

    false

    A table's column, header row, totals row and full extent are all addressable (Sales[Amount], Sales[#Headers], Sales[#Totals], Sales[#All]) without being names in their own right. Off by default because the two consumers genuinely differ: a name box shows the address for a column selection, whereas a formula editor substituting a dragged range wants Sales[Amount].

    Part references sort after whole-item matches — a real name beats a synthesized reference to the same region.

    name?: string

    Only items with this name, compared case-insensitively.

    Several items can share a name (a global and a sheet-scoped Rate), which is what makes this a filter rather than a lookup — INamedCollection.getByName answers the "which one wins" question; this returns every holder of the name. Mirrors INamedFormulasCollection.getItems.

    scope?: string | null

    Only items with this scope: a sheet name, or null for globally scoped items only.

    Filters on INamed.getScope — visibility, never location — and the KEY being present is what turns it on: { scope: null } returns only global items, while omitting scope applies no filter at all. Mirrors INamedFormulasCollection.getItems.

    type?: string

    A string indicating the type.

    Settings
    Member Visibility

    On This Page
    Properties