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

    Interface GetValuesOptions

    Options for ICellRange.getValues.

    interface GetValuesOptions {
        axis?: Axis;
        ignoreHidden?: boolean | Axis;
        includeMergeOverflow?: boolean;
        maxSize?: number;
        reverse?: boolean;
    }
    Index
    axis? ignoreHidden? includeMergeOverflow? maxSize? reverse?
    axis?: Axis

    Specifies the primary direction for iterating over the range (row-major or column-major).

    IRange.Axis.Row

    Both SetValuesOptions and GetValuesOptions allow for IRange.Axiss.

    ignoreHidden?: boolean | Axis

    Excludes hidden cells from the returned values.

    false
    • When enabled, the number of returned rows or columns might be less than the range size.
    • If the entire range is hidden, the result will be empty and empty Array ([]).
    • Optionally, you can specify a IRange.Axis to indicate the header axis for skipping cases. For example, in sorting, you might want to skip hidden rows but not hidden columns.
    includeMergeOverflow?: boolean

    Includes any merge overflow in first element visited.

    If true any merges that fall outside of the range will be include in the top/left most cell that the merge intersects. Useful for rendering merged cells when the top/left is outside the viewport.

    maxSize?: number

    Limits the maximum number of values returned. An error will be thrown if results contain more values than maxSize.

    10000
    reverse?: boolean

    Reverses the iteration order (e.g., from bottom to top for rows, or from right to left for columns).

    false

    Settings
    Member Visibility

    On This Page
    Properties