Interface INamedCollection

isNamedCollection

add

• add(named: INamed): INamed

  Add a item to the collection.

  Parameters

  • named: INamed

    The item to add.

  Returns INamed

  Remarks

  This will throw an error if getNamed() is invalid or am item with the same name already exists.

addListeners

• addListeners(listeners: IListeners, options?: IListener.Options): Remove

  Add Listeners.

  Parameters

  • listeners: IListeners
  • Optionaloptions: IListener.Options

  Returns Remove

  See

  IListener.ISource.addListeners

addReference

• addReference(
      name: string,
      reference: ICellRanges.Address,
      replaceExisting?: boolean,
  ): IReference

  Add a named reference.

  Parameters

  • name: string

    The name of the range.
  • reference: ICellRanges.Address

    An address or formula
  • OptionalreplaceExisting: boolean

    If true will replace existing ranges if one already exists. default false.

  Returns IReference

  Remarks

  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.

close

• close(): void

  Close the record and cleans resources. Can't be undone.

  Returns void

findValidName

• findValidName(
      template: string,
      scope?: string,
      ignoreExisting?: boolean,
  ): string

  Returns a new valid name given the name return a valid name that closely matches. This function works by incrementing either the last number or append a number.

  Parameters

  • template: string

    The range to used as a template.
  • Optionalscope: string

    The scope of the range. If null then this will look for a globally scoped. default null.
  • OptionalignoreExisting: boolean

    If true then won't check to see if the name is already used. default false.

  Returns string

  A valid name. If the name used is valid then will return the same name.

  Throws

  Error If the template name is invalid.

fromJSON

• fromJSON(json: JSON): void

  Loads value from JSON, this will clear any existing state

  Parameters

  • json: JSON

  Returns void

getByName

• getByName(name: string, global?: boolean): INamed<any>

  Lookup a named range with a given name.

  Parameters

  • name: string

    Case insensitive name to lookup
  • Optionalglobal: boolean

    If true then will search all scopes. default false

  Returns INamed<any>

getRanges

• getRanges(address: ICellRanges.Address): ICellRanges

  Return ranges for a given address globally scoped.

  Parameters

  • address: ICellRanges.Address

    The address to resolve.

  Returns ICellRanges

isClosed

• isClosed(): boolean

  Returns true if no more operations are allowed.

  Returns boolean

lookupByRanges

• lookupByRanges(ranges: ICellRanges.Address): INamed<any>[]

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

  Parameters

  • ranges: ICellRanges.Address

  Returns INamed<any>[]

  Deprecated

  Use search({ address }) instead.

search

• search(options?: SearchOptions): INamed<any>[]

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

  Parameters

  • Optionaloptions: SearchOptions

  Returns INamed<any>[]

toJSON

• toJSON(): JSON

  Serialize the state.

  Returns JSON

validateName

• validateName(name: string, scope?: string, ignoreExisting?: boolean): void

  Validates a name is valid. This is a convenience method That calls findValidName and throws an error if the name returned is not the same.

  Parameters

  • name: string
  • Optionalscope: string
  • OptionalignoreExisting: boolean

  Returns void

  Throws

  Error If findValidName does not return the same value as the name checking.

  See

  INamedCollection.findValidName