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

    Class ThemeCollection

    Collection of themes

    Hierarchy (View Summary)

    Implements

    Index
    • get isICollection(): true

      For runtime type checking.

      Returns true

    • Iterates the collection's items.

      Returns IterableIterator<ITheme>

      The unfiltered walk — for (const sheet of wb.getSheets()). Every other iterable surface in the SDK (ICellRange, ICellRegions, ICellRanges) reads this way, so a collection that did not was a trap: for…of over one is the obvious line to write and it threw at runtime with nothing in the types to warn first.

      getItems remains the call that takes options — filtering, ordering, anything parameterized. This is sugar over the unfiltered case, not a replacement for it.

    • Returns the item at the given index, or undefined if there is none.

      Parameters

      • index: number

        The position in iteration order. A negative index counts back from the end, as Array.prototype.at does.

      Returns ITheme | undefined

    • Returns true if the predicate accepts every item, including when there are none.

      Parameters

      • predicate: (value: ITheme, index: number, items: readonly ITheme[]) => boolean

        Called once per item in iteration order until it returns false.

      Returns boolean

    • Returns the items the predicate accepts, in iteration order.

      Type Parameters

      Parameters

      • predicate: (value: ITheme, index: number, items: readonly ITheme[]) => value is S

        Called once per item.

      Returns S[]

    • Returns the items the predicate accepts, in iteration order.

      Parameters

      • predicate: (value: ITheme, index: number, items: readonly ITheme[]) => boolean

        Called once per item.

      Returns ITheme[]

    • Returns the first item the predicate accepts, or undefined if it accepts none.

      Type Parameters

      Parameters

      • predicate: (value: ITheme, index: number, items: readonly ITheme[]) => value is S

        Called once per item in iteration order until it returns true.

      Returns S | undefined

    • Returns the first item the predicate accepts, or undefined if it accepts none.

      Parameters

      • predicate: (value: ITheme, index: number, items: readonly ITheme[]) => boolean

        Called once per item in iteration order until it returns true.

      Returns ITheme | undefined

    • Returns the index of the first item the predicate accepts, or -1 if it accepts none.

      Parameters

      • predicate: (value: ITheme, index: number, items: readonly ITheme[]) => boolean

        Called once per item in iteration order until it returns true.

      Returns number

    • Returns the theme for the given name.

      Parameters

      • name: string

      Returns ITheme | null

      Will try to return:

      1. The custom theme for the name
      2. The builtin theme for the name.
      3. nul if it doesn't exist.
    • Returns true once the collection has been closed.

      Returns boolean

      A closed collection is empty and announces nothing further. Collections that are closed by their owner (the workbook's names, functions and modules, when the workbook closes) announce it once with ICollection.Events.onClose; the others are never closed and always return false.

    • Returns the result of calling the function on every item, in iteration order.

      Type Parameters

      • U

      Parameters

      • fn: (value: ITheme, index: number, items: readonly ITheme[]) => U

        Called once per item.

      Returns U[]

    • Returns true if the predicate accepts at least one item.

      Parameters

      • predicate: (value: ITheme, index: number, items: readonly ITheme[]) => boolean

        Called once per item in iteration order until it returns true.

      Returns boolean

    • Returns the items as a fresh array, in iteration order.

      Returns ITheme[]

      The call to make when an array is really wanted. The array is the caller's: changing it does not change the collection, and it does not follow later changes to the collection.