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

    Interface GetItemsOptions

    Options for getting items from the collection.

    This placeholder is extended by implementations of ICollection

    interface GetItemsOptions {
        address?: ICellRanges.Address;
        allowExtrudes?: boolean;
        includeHidden?: boolean;
        name?: string;
        scope?: string | null;
        type?: string;
    }

    Hierarchy (View Summary)

    Index
    address? allowExtrudes? includeHidden? name? scope? type?
    address?: ICellRanges.Address

    The search area.

    Search the global scope of the NamedCollection.
    allowExtrudes?: boolean

    If true return any Named that is in the bounds even if only partially bounded.

    false
    includeHidden?: boolean

    If 'true' then include hidden named ranges.

    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