Interface FindCellOptions

Options for the find operation

interface FindCellOptions {
    bounds?: CellRangeCoordsAddress;
    disableWrap?: boolean;
    fields?: FindCellField[];
    from?: CellCoordsAddress;
    includeFrom?: boolean;
    isMatchCase?: boolean;
    isMatchEntireCell?: boolean;
    isReverse?: boolean;
    isRowScan?: boolean;
    isUseRegex?: boolean;
    onFound?: ((pair) => boolean | void);
    to?: CellCoordsAddress;
}

Properties

bounds? disableWrap? fields? from? includeFrom? isMatchCase? isMatchEntireCell? isReverse? isRowScan? isUseRegex? onFound? to?

Properties

Optional bounds

bounds?: CellRangeCoordsAddress

A bounds to limit the find by.

Default Value

'This will use the current range bounds if there is a single bounds. Otherwise it will use the entire sheet'

Optional disableWrap

disableWrap?: boolean

Determine if will wrap back to beginning

Default Value

false

Optional fields

fields?: FindCellField[]

Optional from

from?: CellCoordsAddress

The cell to start from @defaultValue. The next cell after the current selection

Optional includeFrom

includeFrom?: boolean

Checks the from cell for a match

Default Value

false

Optional isMatchCase

isMatchCase?: boolean

If the search is case sensitive

Default Value

false

Optional isMatchEntireCell

isMatchEntireCell?: boolean

Optional isReverse

isReverse?: boolean

Search in reverse order

Default Value

false

Optional isRowScan

isRowScan?: boolean

Optional isUseRegex

isUseRegex?: boolean

Optional onFound

onFound?: ((pair) => boolean | void)

Called on a found results.

Type declaration

Remarks

This will break unless an explicit false is returned.

Optional to

to?: CellCoordsAddress

The cell to end at

Settings

Member Visibility

Theme

On This Page

boundsdisableWrapfieldsfromincludeFromisMatchCaseisMatchEntireCellisReverseisRowScanisUseRegexonFoundto