SheetXL - v0.3.20
    Preparing search index...

    Interface GetValuesOptions

    Options for ICellRange.getValues.

    interface GetValuesOptions {
        asJSDate?: boolean;
        excludeHidden?: boolean | IRange.Orientation;
        includeMergeOverflow?: boolean;
        maxSize?: number;
        orientation?: IRange.Orientation;
        reverse?: boolean;
    }
    Index

    Properties

    asJSDate? excludeHidden? includeMergeOverflow? maxSize? orientation? reverse?

    Properties

    asJSDate?: boolean

    Return dates as Javascript dates instead of OADates. This is slower for values that are numbers as the Style needs to be read to determine if the value should be interpreted as a date or a number. See ICell.IteratorContext.asJSDate.

    false
    excludeHidden?: boolean | IRange.Orientation

    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.Orientation to indicate the header orientation 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
    orientation?: IRange.Orientation

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

    IRange.Orientation.Row

    Both SetValuesOptions and GetValuesOptions allow for IRange.Orientations.

    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