SheetXL - v1.0.2
    Preparing search index...

    Interface Criteria

    interface Criteria {
        collatorOptions?: CollatorOptions | Record<ScalarType, CollatorOptions>;
        customList?: string;
        iconId?: number;
        iconSet?: ICellStyle.IconSet;
        reverse?: boolean;
        sortOn?: ISort.SortOn;
        style?: ICellStyle.Properties<Serializable>;
    }
    Index
    collatorOptions? customList? iconId? iconSet? reverse? sortOn? style?
    collatorOptions?: CollatorOptions | Record<ScalarType, CollatorOptions>

    Additional options for sorting.

    • Excel has a matchCase flag but we use Intl.CollatorOptions.
    • Excel has Normal | TextAsNumber but we use Intl.CollatorOptions.
    customList?: string

    Sort by a custom list.

    PLACEHOLDER - This is a placeholder for future use.

    iconId?: number

    Used with sortOn === Icon

    PLACEHOLDER - This is a placeholder for future use.

    iconSet?: ICellStyle.IconSet

    Used with sortOn === Icon

    PLACEHOLDER - This is a placeholder for future use.

    reverse?: boolean

    Determines whether to reverse the default sort order.

    false - (sorts in the default order, typically ascending)

    The reverse flag flips the sort order. When set to true, the sort will be performed in reverse order compared to the default (which is usually ascending).

    This flag is data-type agnostic, meaning it will reverse the default order regardless of whether the data is numeric, alphabetic, or complex (e.g., booleans, lists).

    Example usage:

    const criteria: ISort.Criteria = {
      reverse: true, // Sorts in descending order (for numbers/alphabetic)
    };
    sortOn?: ISort.SortOn

    Only value is currently supported

    style?: ICellStyle.Properties<Serializable>

    The format whose color sorts first, with sortOn ISort.SortOn.FillColor (its fill) or ISort.SortOn.FontColor (its font color).

    Settings
    Member Visibility

    On This Page
    Properties