SheetXL - v0.3.20
    Preparing search index...

    Interface CopyOptions

    Options for copying ICellHeaderRange.

    interface CopyOptions {
        autoFit?: boolean | AutoFitOptions;
        autoSelect?: boolean | ITypes.SelectOptions;
        description?: string;
        editMode?: EditMode;
        fitDestination?: boolean;
        isCut?: boolean;
        orientation?: IRange.Orientation;
        skipBoundsCheck?: boolean;
        textParser?: boolean | ModifiersFromStringOptions;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoFit? autoSelect? description? editMode? fitDestination? isCut? orientation? skipBoundsCheck? textParser?

    Properties

    autoFit?: boolean | AutoFitOptions

    Convenience method that calls autoFit after the setValues.

    none - No autofit.

    If set to true then autoFit will mimic the UI with the following options:

    {
    skipCustomSize: true,
    expandOnly: true,
    minContent: true
    }
    autoSelect?: boolean | ITypes.SelectOptions

    If true or set then this will select the affect item after the transaction is complete.

    If this is set to true then any restore will also select.

    description?: string

    A human description.

    'determined by the set operation and locale'
    editMode?: EditMode

    When performing a copy the editMode type to use.

    'copy'
    fitDestination?: boolean

    When pasting from a smaller range to a larger range copy will repeat or 'wallpaper' the source values.

    Note - If the destination range is only a single cell then fitDestination will always be applied.

    isCut?: boolean

    Indicates if a cut is desired.

    false
    orientation?: IRange.Orientation

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

    IRange.Orientation.Row

    Both SetValuesOptions and GetValuesOptions allow for IRange.Orientations.

    skipBoundsCheck?: boolean

    Skip the bounds check when setting values.

    When set to true, this option allows value arrays to exceed the dimensions of the range. This is useful for setting values in a table where the range is smaller than the data, but determining the exact size requires processing the entire dataset.

    textParser?: boolean | ModifiersFromStringOptions

    By default setValue will attempt to parse text values into a native type. This can be disabled or customized using the parseText flag. Setting this to false will use the raw text value.

    Settings

    Member Visibility

    On This Page

    Properties