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

    Interface JSON

    A JSON representation useful for persistence.

    interface JSON {
        columnHeaderStyle?: ISheetView.HeaderTextStyle;
        freezePanes?: string | FreezePanes;
        gridLineColor?: string | IColor | null;
        rightToLeft?: boolean;
        rowHeaderStyle?: ISheetView.HeaderTextStyle;
        selection?: SelectionCoords;
        showColumnGridlines?: boolean;
        showColumnHeaders?: boolean;
        showFormulas?: boolean;
        showInvalid?: boolean;
        showLockedShading?: boolean;
        showOutlineSymbols?: boolean;
        showRowGridlines?: boolean;
        showRowHeaders?: boolean;
        showZeros?: boolean;
        tableNames?: ISheetView.ColumnHeaderTableNames;
        topLeft?: string | Partial<TopLeft>;
        zoomScale?: string | number;
    }

    Hierarchy

    • Omit<
          Partial<ISheetView.Properties>,
          "selection" | "topLeft" | "freezePanes" | "zoomScale",
      >
      • JSON
    Index
    columnHeaderStyle? freezePanes? gridLineColor? rightToLeft? rowHeaderStyle? selection? showColumnGridlines? showColumnHeaders? showFormulas? showInvalid? showLockedShading? showOutlineSymbols? showRowGridlines? showRowHeaders? showZeros? tableNames? topLeft? zoomScale?
    columnHeaderStyle?: ISheetView.HeaderTextStyle

    Style of displaying default column header text.

    freezePanes?: string | FreezePanes
    gridLineColor?: string | IColor | null

    The color of the gridline on the sheet.

    GridLine color is a sheet view attribute but in Excel is a workbook attribute. If null then use the app theme.

    rightToLeft?: boolean

    Indicate whether the sheet is displayed right-to-left (the leftmost column on the right). Persisted per sheet; round-trips through xlsx sheetView@rightToLeft.

    rowHeaderStyle?: ISheetView.HeaderTextStyle

    Style of displaying default row header text.

    selection?: SelectionCoords
    showColumnGridlines?: boolean

    Show/Hide column gridlines.

    showColumnHeaders?: boolean

    Show/Hide columns headers.

    showFormulas?: boolean

    Indicate if view is showing formulas or values

    showInvalid?: boolean

    Indicate whether cells whose value fails a data validation are marked.

    The sheet's counterpart of Excel's Circle Invalid Data, except that the marks follow the values as they change. A cell is marked when its value fails any data validation covering it; a list cell is marked only when its value is not on the list. Not written to xlsx, where Excel keeps no such setting.

    showLockedShading?: boolean

    Indicate whether the cells that sheet protection locks are shaded, leaving the ranges that stay editable clear.

    Only meaningful while the sheet is protected: it shades what protection is actually holding shut, so an unprotected sheet has nothing to shade.

    showOutlineSymbols?: boolean

    Indicate whether the outline symbols (the brackets, the collapse and expand buttons and the level buttons of the row and column groups) are shown.

    A view setting, as in Excel (Window.DisplayOutline, Ctrl+8): the groups stay on the sheet, only their symbols are hidden. Round-trips through xlsx sheetView@showOutlineSymbols.

    showRowGridlines?: boolean

    Show/Hide row gridlines.

    showRowHeaders?: boolean

    Show/Hide row headers.

    showZeros?: boolean

    Indicate whether the sheet should show 0 (zero) or blanks in cells containing zero values.

    When false, cells with zero value appear blank instead of showing the number zero.

    tableNames?: ISheetView.ColumnHeaderTableNames

    Controls when the sheet's column headers display table column names.

    topLeft?: string | Partial<TopLeft>
    zoomScale?: string | number

    Settings
    Member Visibility

    On This Page
    Properties