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

    Interface Properties

    A set of values that can be set on a ISheetView.

    ISheetView

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

    The freeze panes.

    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 | null

    The selection coords. null when there is no stored selection (it lives on the RangeSelection).

    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: TopLeft

    The top left scroll position of the (main) pane.

    Expressed in zoom-independent (base, unzoomed) px. Screen/scroll position is derived as base * zoomScale at the rendering boundary, so this value is stable across zoom changes.

    zoomScale: number

    Zoom. This is expressed as a percentage. Values can be between 10 (10%) or 400 (400%).

    Settings
    Member Visibility

    On This Page
    Properties