Sheet API in Vue Spreadsheet API component

Configures the sheet behavior for the spreadsheet.

Properties

activeCell

string

Specifies active cell within selectedRange in the sheet.

Defaults to ‘A1’

colCount

number

Defines the number of columns to be rendered in the sheet.

Defaults to 100

columns

ColumnModel[]

Configures column and its properties for the sheet.

Defaults to null

conditionalFormats

ConditionalFormatModel[]

Specifies the conditional formatting for the sheet.

Defaults to []

frozenColumns

number

Gets or sets the number of frozen columns.

Defaults to 0

frozenRows

number

Gets or sets the number of frozen rows.

Defaults to 0

index

number

Specifies index of the sheet. Based on the index, sheet properties are applied.

Defaults to 0

isProtected

boolean

Specifies to protect the cells in the sheet.

Defaults to false

name

string

Specifies the name of the sheet, the name will show in the sheet tabs.

Defaults to ”

paneTopLeftCell

string

Represents the freeze pane top left cell. Its default value would be based on the number of freeze rows and columns.

Defaults to ‘A1’

password

string

Specifies the password.

Defaults to ”

protectSettings

ProtectSettingsModel

Configures protect and its options.

Defaults to { selectCells: false, formatCells: false, formatRows: false, formatColumns: false, insertLink: false }

ranges

RangeModel[]

Specifies the collection of range for the sheet.

Defaults to []

rowCount

number

Defines the number of rows to be rendered in the sheet.

Defaults to 100

rows

RowModel[]

Configures row and its properties for the sheet.

Defaults to null

selectedRange

string

Specifies selected range in the sheet.

<div id='Spreadsheet'></div>

let spreadsheet: Spreadsheet = new Spreadsheet({
     sheets: [{
               selectedRange: 'A1:B5'
         }],
     ...
});
spreadsheet.appendTo('#Spreadsheet');

Defaults to ‘A1:A1’

showGridLines

boolean

Specifies to show / hide grid lines in the sheet.

Defaults to true

showHeaders

boolean

Specifies to show / hide column and row headers in the sheet.

Defaults to true

standardHeight

number

Represents the standard height of the sheet.

Defaults to null

state

SheetState

Specifies the sheet visibility state. There must be at least one visible sheet in Spreadsheet.

Defaults to ‘Visible’

topLeftCell

string

Specified cell will be positioned at the upper-left corner of the sheet.

Defaults to ‘A1’

usedRange

UsedRangeModel

Defines the used range of the sheet.

Defaults to { rowIndex: 0, colIndex: 0 }