SheetXL - v0.3.20
    Preparing search index...

    Interface IStringCollection

    Contains a collection of interned strings.

    interface IStringCollection {
        add(shared: string): number;
        addMultiple(shared: string[], conflateDuplicates?: boolean): void;
        beginPersist(): ICollection.IPersistScope<string>;
        getById(id: number): string;
        getCount(): number;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    add addMultiple beginPersist getById getCount

    Methods

    • Add a string to the collection.

      Parameters

      • shared: string

        A string

      Returns number

      Resources are not removed from the the collection. They are autoGCed when there are no references.

    • Add multiple string to the collection.

      Parameters

      • shared: string[]

        An array of strings

      • OptionalconflateDuplicates: boolean

        If the same string is in the list it will be conflated. Default value false.

      Returns void

      There are instances where Excel may have duplicate strings so by default this is false.

    • Returns the string for the given id.

      Parameters

      • id: number

        The id

      Returns string

    • Returns the total items available.

      Returns number

      Useful as a quick escape for search.

    Settings

    Member Visibility

    On This Page

    Methods