Interface ReplaceCellOptions

Options for the replace operation.

interface ReplaceCellOptions {
    autoFit?: boolean | AutoFitOptions | HeaderOrientation;
    description?: string;
    findOptions: FindCellOptions;
    isReplaceAll?: boolean;
    noSelectOnUndo?: boolean;
    onReplaceText?: ((coord, text) => void);
    parseTextAsValue?: boolean | CellUpdateFromStringOptions;
}

Hierarchy (view full)

Properties

autoFit? description? findOptions isReplaceAll? noSelectOnUndo? onReplaceText? parseTextAsValue?

Properties

Optional autoFit

autoFit?: boolean | AutoFitOptions | HeaderOrientation

Determines if the cells that are set should autoFit.

Default Value

true (meaning  autoFit in both directions)

Optional description

description?: string

A description that is used for versioning and tracking changes.

Default Value

'determined by the consumer'

findOptions

findOptions: FindCellOptions

Optional isReplaceAll

isReplaceAll?: boolean

Optional noSelectOnUndo

noSelectOnUndo?: boolean

If true then the selection will not be included in an undo operation.

Default Value

false

Optional onReplaceText

onReplaceText?: ((coord, text) => void)

Type declaration

    • (coord, text): void

    • Parameters

      Returns void

Optional parseTextAsValue

parseTextAsValue?: boolean | CellUpdateFromStringOptions

If this is set to true string values will try to be coerce into numbers, dates, and booleans.

Remarks

If a function is passed this will still attempt to coerce the value but will also called the function and take it's return value if not void

Settings

Member Visibility

Theme

On This Page

autoFitdescriptionfindOptionsisReplaceAllnoSelectOnUndoonReplaceTextparseTextAsValue