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

    Class NamedStyleCollection

    Implementation for INamedStyleCollection.

    A front over the StyleCollection's maps — the style collection keeps the definitions (they resolve against its theme) and this class keeps the API and the announcing.

    Hierarchy (View Summary)

    Implements

    Index
    • Iterates the collection's items.

      Returns IterableIterator<IStyle.INamed>

      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 IStyle.INamed | undefined

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

      Parameters

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

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

      Returns boolean

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

      Parameters

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

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

      Returns number

    • Returns the style with the given name, or null if there is none.

      Parameters

      • name: string

        The name, compared case-insensitively.

      Returns IStyle.INamed | null

      A custom style of a built-in's name replaces the built-in, and is what is returned.

    • 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.

    • Adds or updates a style.

      Parameters

      • update: NamedUpdate

        The name, the style, and any of the other IStyle.NamedProperties.

      • mergeIfExists: boolean = false

        If true the style is merged over the existing one of that name; otherwise it replaces it.

      Returns IStyle.INamed

      The style as stored.

      Names are case-insensitive. Setting a built-in's name customizes the built-in.

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

      Parameters

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

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

      Returns boolean