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

    Interface JSON

    There is no whole-sheet flag here: changing it is IProtection.lock and IProtection.unlock, reading it ISheetProtection.isLocked. It is saved as ISheetProtection.JSON.sheet.

    interface JSON {
        autoTable?: boolean;
        deleteColumns?: boolean;
        deleteRows?: boolean;
        formatCells?: boolean;
        formatColumns?: boolean;
        formatRows?: boolean;
        identities?: IdentityProvider[];
        insertColumns?: boolean;
        insertHyperlinks?: boolean;
        insertRows?: boolean;
        objects?: boolean;
        password?: Partial<EncryptedPassword>;
        pivotTables?: boolean;
        scenarios?: boolean;
        selectLockedCells?: boolean;
        selectUnlockedCells?: boolean;
        sheet?: boolean;
        showFormulas?: boolean;
        sort?: boolean;
    }

    Hierarchy (View Summary)

    Index
    autoTable? deleteColumns? deleteRows? formatCells? formatColumns? formatRows? identities? insertColumns? insertHyperlinks? insertRows? objects? password? pivotTables? scenarios? selectLockedCells? selectUnlockedCells? sheet? showFormulas? sort?
    autoTable?: boolean

    Checks if the AutoTable functionality is protected on the sheet.

    true if AutoTable is locked, false otherwise.

    deleteColumns?: boolean

    Checks if deleting columns is protected on the sheet.

    true if deleting columns is locked, false otherwise.

    deleteRows?: boolean

    Checks if deleting rows is protected on the sheet.

    true if deleting rows is locked, false otherwise.

    formatCells?: boolean

    Checks if formatting cells is protected on the sheet.

    true if formatting cells is locked, false otherwise.

    formatColumns?: boolean

    Checks if formatting columns is protected on the sheet.

    true if formatting columns is locked, false otherwise.

    formatRows?: boolean

    Checks if formatting rows is protected on the sheet.

    true if formatting rows is locked, false otherwise.

    identities?: IdentityProvider[]
    insertColumns?: boolean

    Checks if inserting columns is protected on the sheet.

    true if inserting columns is locked, false otherwise.

    insertHyperlinks?: boolean

    Checks if inserting hyperlinks is protected on the sheet.

    true if inserting hyperlinks is locked, false otherwise.

    insertRows?: boolean

    Checks if inserting rows is protected on the sheet.

    true if inserting rows is locked, false otherwise.

    objects?: boolean

    Checks if objects (e.g., charts, shapes) are protected on the sheet.

    true if objects are locked, false otherwise.

    password?: Partial<EncryptedPassword>

    If this is specified then a password will be requested to unlock. If this is an empty object this indicates the object has been locked but without a password

    pivotTables?: boolean

    Checks if pivot tables are protected on the sheet.

    true if pivot tables are locked, false otherwise.

    scenarios?: boolean

    Checks if scenarios are protected on the sheet.

    true if scenarios are locked, false otherwise.

    selectLockedCells?: boolean

    Checks if locked cells may be selected on the protected sheet.

    Defaults to true, and is always true while the sheet is not locked (including paused).

    false if the sheet refuses selection of its locked cells while protected.

    selectUnlockedCells?: boolean

    Checks if unlocked cells may be selected on the protected sheet.

    Defaults to true, and is always true while the sheet is not locked (including paused).

    false if the sheet refuses selection of its unlocked cells while protected.

    sheet?: boolean

    true when the whole sheet stays allowed: it is not protected, and keeps its options for the next lock. Absent, the sheet is protected.

    Like every allowance here, the inverse of its OOXML attribute (sheet="1" is protected).

    showFormulas?: boolean

    Checks if formulas may be shown on the protected sheet.

    • While this is false, a cell's formula shows only when its style grants it (ICellProtection.isShowFormulas) — an exception, the way an always-unlocked cell is one.
    • Defaults to true, and is always true while the sheet is not locked (including paused).

    false if the sheet hides its formulas while protected.

    sort?: boolean

    Checks if sorting is protected on the sheet.

    true if sorting is locked, false otherwise.

    Settings
    Member Visibility

    On This Page
    Properties