Interface INamedItems

isNamedItems

addListener

• addListener(listener): RemoveListener

• Listen for changes to the named ranges.

  Parameters

  • listener: INamedItemsListener

  Returns RemoveListener

addNamedRange

• addNamedRange(namedRange, replaceHidden?): NamedRangeItem

• Add a named range. This is case insensitive; must be unique, and must not have any spaces. This will throw an error if the name is invalid or already exists,

  Parameters

  • namedRange: string | Partial<{
        comment?: string;
        hidden?: string | Partial<boolean>;
        name: string;
        ref: string | SheetCellRangeCoords[] | (string | SheetCellRangeCoords | Partial<{
            colEnd: string | number;
            colStart: string | number;
            fixedColEnd?: string | Partial<boolean>;
            fixedColStart?: string | Partial<boolean>;
            fixedRowEnd?: string | Partial<boolean>;
            fixedRowStart?: string | Partial<boolean>;
            rowEnd: string | number;
            rowStart: string | number;
            sheetName: string;
        }>)[];
        scope?: string;
        type: string;
    }>
  • Optional replaceHidden: boolean

    If true will replace hidden ranges if one already exists.

  Returns NamedRangeItem

  Default Value

  true
  Copy

decodeAddress

• decodeAddress(address): SheetCellRangeCoords[]

• Returns a set of ranges from an address. Will return null if not a valid address.

  Parameters

  • address: SheetCellRangeCoordsAddresses

  Returns SheetCellRangeCoords[]

  Remarks

  This does not resolved named ranges.

deleteNamedRange

• deleteNamedRange(namedRange): NamedRangeItem

• Remove a named range.

  Parameters

  • namedRange: string | NamedRangeItem

    The range to remove

  Returns NamedRangeItem

findValidateName

• findValidateName(ranges, scope?, template?, replaceHidden?): string

• Given the name return a valid name that closely matches.

  Parameters

  • ranges: SheetCellRangeCoords[]
  • Optional scope: string
  • Optional template: string
  • Optional replaceHidden: boolean

  Returns string

fromJSON

• fromJSON(json): void

• Loads value from JSON, this will clear any existing state

  Parameters

  • json: NamedItemsJSON

  Returns void

lookupByName

• lookupByName(name, anchor): NamedItem<CellRangeCoords>

• Lookup a named range with a given name.

  Parameters

  • name: string
  • anchor: SheetCellCoords

  Returns NamedItem<CellRangeCoords>

  Remarks

  This is case insensitive.

lookupByRanges

• lookupByRanges(ranges, anchor): NamedItem<CellRangeCoords>[]

• Lookup a named range by SheetRangeCoords. This will only return a match if all the ranges are exact matches.

  Parameters

  • ranges: SheetCellRangeCoords[]
  • anchor: SheetCellCoords

  Returns NamedItem<CellRangeCoords>[]

search

• search(options?): NamedItem<CellRangeCoords>[]

• Search the named items. These are sorted by type then by name.

  Parameters

  • Optional options: NamedItemsSearchOptions

  Returns NamedItem<CellRangeCoords>[]

toJSON

• toJSON(): NamedItemsJSON

• Serialize the state

  Returns NamedItemsJSON

updateNamedRange

• updateNamedRange(name, namedRange): NamedRangeItem

• Updates a named range. This allows for the original name to be changed.

  Parameters

  • name: string

    The original name
  • namedRange: Partial<{
        comment?: string;
        hidden?: string | Partial<boolean>;
        name: string;
        ref: string | SheetCellRangeCoords[] | (string | SheetCellRangeCoords | Partial<{
            colEnd: string | number;
            colStart: string | number;
            fixedColEnd?: string | Partial<boolean>;
            fixedColStart?: string | Partial<boolean>;
            fixedRowEnd?: string | Partial<boolean>;
            fixedRowStart?: string | Partial<boolean>;
            rowEnd: string | number;
            rowStart: string | number;
            sheetName: string;
        }>)[];
        scope?: string;
        type: string;
    }>

  Returns NamedRangeItem

validateNamedItem

• validateNamedItem(namedRangeItem, scope?, replaceHidden?): void

• Validate that the NamedItem. This is identical to addNamedItem but without actually trying.

  Parameters

  • namedRangeItem: Partial<{
        comment?: string;
        hidden?: string | Partial<boolean>;
        name: string;
        ref: string | SheetCellRangeCoords[] | (string | SheetCellRangeCoords | Partial<{
            colEnd: string | number;
            colStart: string | number;
            fixedColEnd?: string | Partial<boolean>;
            fixedColStart?: string | Partial<boolean>;
            fixedRowEnd?: string | Partial<boolean>;
            fixedRowStart?: string | Partial<boolean>;
            rowEnd: string | number;
            rowStart: string | number;
            sheetName: string;
        }>)[];
        scope?: string;
        type: string;
    }>

    The range to validate
  • Optional scope: string

    The scope of the range.
  • Optional replaceHidden: boolean

    If true then won't check to see if the name is already used for hidden ranges.

  Returns void

  Remarks

  This will throw an error if the sheetName is invalid.

  Default Value

  true
  Copy

  Default Value

  null
  Copy