New to Kendo UI for Angular? Start a free 30-day trial

SpreadsheetComponent

Represents the Kendo UI Spreadsheet component for Angular.

Selector

kendo-spreadsheet

Export Name

Accessible in templates as #kendoSpreadsheetInstance="kendo-spreadsheet"

Inputs

NameTypeDefaultDescription

activeSheet

string

The name of the currently active sheet. Must match one of the sheet names.

columns

number

50

The number of columns in the document.

columnWidth

number

100

The initial column width in pixels.

defaultCellStyle

CellDefaultStyle

The initial styles applies to the sheet cells.

excel

ExcelExportSettings

Configures the Excel export settings of the Spreadsheet.

formulaListMaxHeight

string

'300px'

Sets the height of the formula list container. Accepts same values as the CSS style.height property.

headerHeight

number

30

The height of the header row in pixels.

headerWidth

number

32

The width of the header column in pixels.

images

{[name: string]: string}

An object containing any images used in the Spreadsheet. The keys should be image IDs (they are referenced by this ID in sheets.drawings), and the values should be image URLs. The image URLs can be either data URLs (in which case the images are fully contained by the JSON), or external URLs.

menuItems

SpreadsheetMainMenuItem[]

The menu items configuration.

overflow

boolean

false

Sets the overflow option of the built-in Toolbar components.

rowHeight

number

30

The initial row height in pixels.

rows

number

200

The number of rows in the document.

sheets

SheetDescriptor[]

An array which defines the document sheets and their content.

Events

NameTypeDescription

activeSheetChange

EventEmitter<SpreadsheetActiveSheetChangeEvent>

Fired when the active sheet is about to change. The event exposes the new active Sheet and the SpreadsheetWidget instance.

change

EventEmitter<SpreadsheetChangeEvent>

Fired when a value in the Spreadsheet is changed. Exposes the SpreadsheetWidget instance and the selected Range as event data.

excelExport

EventEmitter<SpreadsheetExcelExportEvent>

Fired when the end user clicks the Export to Excel toolbar button. The event is preventable and exposes the Workbook object, a preventDefault method (if invoked, the generated file will not be saved), and the SpreadsheetWidget instance.

excelImport

EventEmitter<SpreadsheetExcelImportEvent>

Fired when the end user clicks the Open toolbar button. The event is preventable and exposes the selected File or Blob, a preventDefault method (if invoked, the selected file will not be loaded), and the SpreadsheetWidget instance.

formatChange

EventEmitter<SpreadsheetChangeEvent>

Fired when the selected range format is changed from the UI. Exposes the SpreadsheetWidget instance and the selected Range as event data.

selectionChange

EventEmitter<SpreadsheetChangeEvent>

Fired when the selection is changed by the end user. Exposes the SpreadsheetWidget instance and the selected Range as event data.

In this article

Not finding the help you need?