SheetXL - v0.3.20
    Preparing search index...

    Interface InsertFromOptions

    Options for ICellRange.insertFrom.

    This extends ICellRange.CopyOptions and adds an {@IRange.Orientation.

    interface InsertFromOptions {
        adjustCells?: CopyCellsCallback;
        autoSelect?: boolean | ITypes.SelectOptions;
        description?: string;
        editMode?: EditMode;
        fitDestination?: boolean;
        includeHeaders?: boolean;
        isCut?: boolean;
        orientation?: IRange.Orientation;
        skipBlanks?: boolean;
        transpose?: boolean;
        type?: Content;
        undoRange?: ICellRange;
    }

    Hierarchy (View Summary)

    Index

    Properties

    adjustCells? autoSelect? description? editMode? fitDestination? includeHeaders? isCut? orientation? skipBlanks? transpose? type? undoRange?

    Properties

    adjustCells?: CopyCellsCallback

    Callback to allow for additional customizations.

    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.

    includeHeaders?: boolean

    Indicates if the header (size) should be copied.

    The default is to only copy the headers if the range is entire header span.

    isCut?: boolean

    Indicates if a cut is desired.

    false
    orientation?: IRange.Orientation

    The direction in which to shift existing cells. Defaults to the orientation where the copied range's dimension is smaller. See ICellRange.getDefaultShiftOrientation for details on the default behavior.

    skipBlanks?: boolean

    If true then blank values will not be copied.

    false
    transpose?: boolean

    Have the data transposed for the original orientation.

    false
    type?: Content

    Indicate which items are copied.

    undoRange?: ICellRange

    Allows for undo to range selection to be altered.

    This is used to during drag.

    Settings

    Member Visibility

    On This Page

    Properties