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

    Interface AddOptions

    Options for adding a comment.

    replaceExisting replaces the comment on the cell when there is one, rather than throwing.

    interface AddOptions {
        asNote?: boolean;
        autoSelect?: boolean | ITypes.SelectOptions;
        description?: string;
        person?: string | IPerson;
        replaceExisting?: boolean;
        resolved?: boolean;
    }

    Hierarchy

    Index
    asNote? autoSelect? description? person? replaceExisting? resolved?
    asNote?: boolean

    Whether the comment is a note: displayed in Excel's simple box rather than as a thread, with no author date, replies or resolved state.

    false
    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'
    person?: string | IPerson

    The author: a person, or a display name. Defaults to the workbook's current person.

    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.

    resolved?: boolean

    Whether the thread is resolved.

    Always false for a note.

    Settings
    Member Visibility

    On This Page
    Properties