SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface AddOptions

    Options for adding a data validation to the collection.

    replaceExisting redefines the validation at index when it covers exactly the same ranges — see IAnchored.AddOptions.replaceExisting.

    interface AddOptions {
        alert?: string;
        alertStyle?: IDataValidation.AlertStyle;
        alertTitle?: string;
        author?: Author;
        autoSelect?: boolean | ITypes.SelectOptions;
        condition?: ICondition.Properties<any>;
        description?: string;
        expectedCommitId?: string;
        hideDropdown?: boolean;
        imeMode?: string;
        index?: number;
        prompt?: string;
        promptTitle?: string;
        readOnly?: boolean;
        replaceExisting?: boolean;
        showAlertMessage?: boolean;
        showPromptMessage?: boolean;
    }

    Hierarchy (View Summary)

    Index
    alert? alertStyle? alertTitle? author? autoSelect? condition? description? expectedCommitId? hideDropdown? imeMode? index? prompt? promptTitle? readOnly? replaceExisting? showAlertMessage? showPromptMessage?
    alert?: string

    See IDataValidation.setAlertMessage.

    alertStyle?: IDataValidation.AlertStyle

    See IDataValidation.setAlertStyle.

    Stop

    alertTitle?: string

    See IDataValidation.setAlertTitle.

    author?: Author

    Who authored this change. Recorded on the commit (ICommit.getAuthor).

    the store's author, else null (unattributed)

    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.

    condition?: ICondition.Properties<any>

    The predicate a value must satisfy to be valid.

    Whether blanks pass is part of the predicate and lives here as ICondition.Properties.includeBlanks — IDataValidation.isIncludeBlanks reads through to it.

    description?: string

    A human description.

    'determined by the set operation and locale'
    expectedCommitId?: string

    Optimistic concurrency guard. If set, the operation only begins if the store's current commit id matches; otherwise a TransactionConflictError is thrown.

    The check happens atomically as the root transaction begins — there is no window between check and commit. If any transaction is already open the check fails with reason open (the head could move beneath the operation).

    hideDropdown?: boolean

    Suppresses the in-cell dropdown arrow of a list validation. Rendering only; validation is unaffected.

    false
    imeMode?: string

    Input Method Editor mode for East Asian text entry.

    An opaque passthrough. The model carries the value so it survives a round trip and never interprets it; nothing in SheetXL reads it.

    index?: number

    Position in the collection. 0 is first — for a conditional format, the highest priority.

    0 — a new item goes first, as in Excel.
    prompt?: string

    See IDataValidation.setPromptMessage.

    promptTitle?: string

    See IDataValidation.setPromptTitle.

    readOnly?: boolean

    Declares the operation read-only: any state update within it throws.

    false

    Writes are tracked automatically — a batch that performs no updates never creates a commit (no new commit id, no events, no undo entry) whether or not this is set. The flag is purely an assertion for callers that want the guarantee enforced. Nested transactions inherit it; they cannot opt back out.

    replaceExisting?: boolean

    Redefine the item already at index instead of inserting, when it is anchored to exactly the same ranges (discontiguous ranges compare area by area, in authored order).

    false

    Only the item at index is considered, as in Excel. What counts as the same item is per collection: a data validation or protected range matches on ranges alone; a conditional format only redefines a scale rule (data bar, color scale, icon set) of the same kind — a style rule always inserts, since several may apply to one cell, whereas a second scale of one kind on the same ranges could never render.

    showAlertMessage?: boolean

    See IDataValidation.setShowAlertMessage.

    false
    showPromptMessage?: boolean

    See IDataValidation.setShowPromptMessage.

    false

    Settings
    Member Visibility

    On This Page
    Properties