Interface CellVisitorOptions

interface CellVisitorOptions {
    bounds?: CellRangeCoordsAddress;
    from?: CellCoordsAddress;
    includeEmpty?: boolean;
    includeHiddenHeaders?: boolean | HeaderOrientation;
    includeStyles?: boolean | HeaderOrientation;
    isReverse?: boolean;
    isRowScan?: boolean;
}

Properties

bounds? from? includeEmpty? includeHiddenHeaders? includeStyles? isReverse? isRowScan?

Properties

Optional bounds

bounds?: CellRangeCoordsAddress

The containing range for the scan.

Remarks

If not specified will scan the the smallest area containing data all of the data.

Optional from

from?: CellCoordsAddress

Will attempt to start visiting at this location.

Remarks

If this is not within the bounds then the visit will be skipped.

Default Value

the topLeft of the bounds (or bottomRight if isReverse)

Optional includeEmpty

includeEmpty?: boolean

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

Remarks

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.

Default Value

false

Optional includeHiddenHeaders

includeHiddenHeaders?: boolean | HeaderOrientation

When scanning skip cells that are hidden via headers

Default Value

false

Remarks

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.

Optional includeStyles

includeStyles?: boolean | HeaderOrientation

Include styled cells into scan.

Default Value

false

Optional isReverse

isReverse?: boolean

Iterate in reverse order.

Default Value

false

Optional isRowScan

isRowScan?: boolean

Scan direction is row

Default Value

true

Settings

Member Visibility

Theme

On This Page

boundsfromincludeEmptyincludeHiddenHeadersincludeStylesisReverseisRowScan