SheetXL - v0.3.20
    Preparing search index...

    Interface IteratorOptions<T>

    Options for customizing how values are retrieved from a range and returned as a 2D array.

    interface IteratorOptions<T = ICellRange.Address> {
        address?: T;
        excludeCellDetails?: boolean;
        excludeHidden?: boolean | IRange.Orientation;
        includeEmpty?: boolean;
        includeMergeOverflow?: boolean;
        orientation?: IRange.Orientation;
        reverse?: boolean;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    address? excludeCellDetails? excludeHidden? includeEmpty? includeMergeOverflow? orientation? reverse?

    Properties

    address?: T

    The containing range coords for the scan.

    If not specified will scan all of the data.

    excludeCellDetails?: boolean

    If set to true the only the raw values will be visited.

    false

    This allows for much faster reading when only the value is needed.

    excludeHidden?: boolean | IRange.Orientation

    When scanning skip cells that are hidden via headers.

    false

    Optionally a header orientation for skipping case be passed in. An example of this is for sorting where the sort direction (row) skips hidden rows but the column direction does not.

    includeEmpty?: boolean

    If true will visit empty cells. This is a potentially huge performance improvement if set to false.

    false

    If includeEmpty is true this will always return rectangular results. If bounds are provided it will provide empty spaces before and after. If passing a large bound care must be taken.

    includeMergeOverflow?: boolean

    Includes any merge overflow in first element visited.

    false

    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.

    orientation?: IRange.Orientation

    The direction of the scan.

    IRange.Orientation.Row

    reverse?: boolean

    Iterate in reverse order.

    false

    Settings

    Member Visibility

    On This Page

    Properties