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

    Interface RangeOptions

    Options for sorting across multiple (rows or columns).

    This include axis, hasHeader, and includeHidden.

    interface RangeOptions {
        axis?: Axis;
        collatorOptions?: CollatorOptions | Record<ScalarType, CollatorOptions>;
        collators?: readonly Collator<Scalar>[];
        hasHeader?: boolean;
        includeHidden?: boolean;
        reverse?: boolean;
        sorts?: ISort.Options[];
    }
    Index
    axis? collatorOptions? collators? hasHeader? includeHidden? reverse? sorts?
    axis?: Axis

    Indicate the axis to sort.

    IRange.Axis.Row
    collatorOptions?: CollatorOptions | Record<ScalarType, CollatorOptions>

    The default collator options to use for sorting.

    ISort.Criteria.collatorOptions

    collators?: readonly Collator<Scalar>[]

    Override the collators used.

    Sort.DefaultCollators
    hasHeader?: boolean

    Indicate if the sort has a header. If the sort has a head this will be ignored.

    Use data to make a 'guess'
    includeHidden?: boolean

    Determine if sort should include values that are hidden.

    false
    reverse?: boolean

    The default reverse for to use for sorting.

    ISort.Criteria.reverse

    sorts?: ISort.Options[]

    Sort levels in priority order.

    Each entry specifies an index plus its criteria. The array index is the sort level:

    • 0 = primary
    • 1 = secondary, etc.

    Settings
    Member Visibility

    On This Page
    Properties