SpreadsheetComponent
Represents the Kendo UI Spreadsheet component for Angular.
Definition
Package:@progress/kendo-angular-spreadsheet
Selector:kendo-spreadsheet
Export Name:Accessible in templates as #kendo-spreadsheetInstance="kendo-spreadsheet"
Syntax:
<kendo-spreadsheet [sheets]="sheets"></kendo-spreadsheet>Inputs
activeSheet
string
The name of the currently active sheet. Must match one of the sheet names.
Sets the custom cell editors for the Spreadsheet.
Accepts an array of SpreadsheetCellEditorOptions objects that define custom editors.
columns
number
The number of columns in the document.
50
columnWidth
number
The initial column width in pixels.
100
The initial styles applies to the sheet cells.
Configures the Excel export settings of the Spreadsheet.
formulaListMaxHeight
string
Sets the height of the formula list container.
Accepts same values as the CSS style.height property.
'300px'
headerHeight
number
The height of the header row in pixels.
30
headerWidth
number
The width of the header column in pixels.
32
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.
The menu items configuration.
overflow
boolean
Sets the overflow option of the built-in Toolbar components.
false
Configures the PDF export settings of the Spreadsheet.
rowHeight
number
The initial row height in pixels.
30
rows
number
The number of rows in the document.
200
An array of SheetDescriptor objects that describe the sheets in the Spreadsheet.
Fields
Returns the underlying SpreadsheetWidget instance.
Use it to programmatically access the Range and Sheet APIs.
For usage examples, see Cell and Sheet Operations article.
Events
Fires when the active sheet is about to change.
The event exposes the new active Sheet and the SpreadsheetWidget instance.
Fires when a value in the Spreadsheet is changed. Exposes the SpreadsheetWidget instance and the selected Range as event data.
Fires when a clipboard action (cut, copy, or paste) occurs in the Spreadsheet.
Fires when the user right-clicks within the Spreadsheet view and before the context menu is opened.
Fires 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.
Fires 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.
Fires when the selected range format is changed from the UI. Exposes the SpreadsheetWidget instance and the selected Range as event data.
Fires when the end user clicks the Export to PDF toolbar button.
The event is preventable and exposes a preventDefault method
(if you invoke it, the generated PDF file is not saved) and the SpreadsheetWidget instance.
Fires when the selection is changed by the end user. Exposes the SpreadsheetWidget instance and the selected Range as event data.