IgxSpreadsheetComponent

Custom control that displays one or more worksheets.

Constructors

new IgxSpreadsheetComponent(_renderer: Renderer2, _elRef: ViewContainerRef, _ngZone: NgZone, _componentFactoryResolver: ComponentFactoryResolver, _injector: Injector): IgxSpreadsheetComponent

Returns IgxSpreadsheetComponent

Properties

_dynamicContent

_dynamicContent: ViewContainerRef

ngAcceptInputType_allowAddWorksheet

ngAcceptInputType_allowAddWorksheet: string | boolean

ngAcceptInputType_allowAsyncCalculations

ngAcceptInputType_allowAsyncCalculations: string | boolean

ngAcceptInputType_allowDeleteWorksheet

ngAcceptInputType_allowDeleteWorksheet: string | boolean

ngAcceptInputType_areGridlinesVisible

ngAcceptInputType_areGridlinesVisible: string | boolean

ngAcceptInputType_areHeadersVisible

ngAcceptInputType_areHeadersVisible: string | boolean

ngAcceptInputType_fixedDecimalPlaceCount

ngAcceptInputType_fixedDecimalPlaceCount: string | number

ngAcceptInputType_isEnterKeyNavigationEnabled

ngAcceptInputType_isEnterKeyNavigationEnabled: string | boolean

ngAcceptInputType_isFixedDecimalEnabled

ngAcceptInputType_isFixedDecimalEnabled: string | boolean

ngAcceptInputType_isFormulaBarVisible

ngAcceptInputType_isFormulaBarVisible: string | boolean

ngAcceptInputType_isInEditMode

ngAcceptInputType_isInEditMode: string | boolean

ngAcceptInputType_isInEndMode

ngAcceptInputType_isInEndMode: string | boolean

ngAcceptInputType_isPerformingAsyncCalculations

ngAcceptInputType_isPerformingAsyncCalculations: string | boolean

ngAcceptInputType_isRenamingWorksheet

ngAcceptInputType_isRenamingWorksheet: string | boolean

ngAcceptInputType_isScrollLocked

ngAcceptInputType_isScrollLocked: string | boolean

ngAcceptInputType_isUndoEnabled

ngAcceptInputType_isUndoEnabled: string | boolean

ngAcceptInputType_nameBoxWidth

ngAcceptInputType_nameBoxWidth: string | number

ngAcceptInputType_selectedWorksheets

ngAcceptInputType_selectedWorksheets: string | Worksheet[]

ngAcceptInputType_validationInputMessagePosition

ngAcceptInputType_validationInputMessagePosition: any

ngAcceptInputType_zoomLevel

ngAcceptInputType_zoomLevel: string | number

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxSpreadsheetComponent, "igx-spreadsheet", never, object, object, never, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxSpreadsheetComponent, never>

activeCell

activeCell: SpreadsheetCell

activePane

activePane: SpreadsheetPane

activeSelection

activeSelection: SpreadsheetSelection

activeTable

activeTable: WorksheetTable

activeWorksheet

activeWorksheet: Worksheet

allowAddWorksheet

allowAddWorksheet: boolean

allowAsyncCalculations

allowAsyncCalculations: boolean

allowDeleteWorksheet

allowDeleteWorksheet: boolean

areGridlinesVisible

areGridlinesVisible: boolean

areHeadersVisible

areHeadersVisible: boolean

cellEditMode

cellEditMode: SpreadsheetCellEditMode

chartAdapter

chartAdapter: SpreadsheetChartAdapterBase

enterKeyNavigationDirection

enterKeyNavigationDirection: SpreadsheetEnterKeyNavigationDirection

fixedDecimalPlaceCount

fixedDecimalPlaceCount: number

height

height: string

isEnterKeyNavigationEnabled

isEnterKeyNavigationEnabled: boolean

isFixedDecimalEnabled

isFixedDecimalEnabled: boolean

isFormulaBarVisible

isFormulaBarVisible: boolean

isInEditMode

isInEditMode: boolean

isInEndMode

isInEndMode: boolean

isPerformingAsyncCalculations

isPerformingAsyncCalculations: boolean

isRenamingWorksheet

isRenamingWorksheet: boolean

isScrollLocked

isScrollLocked: boolean

isUndoEnabled

isUndoEnabled: boolean

nameBoxWidth

nameBoxWidth: number

selectedWorksheets

selectedWorksheets: Worksheet[]

selectionMode

selectionMode: SpreadsheetCellSelectionMode

undoManager

undoManager: UndoManager

validationInputMessagePosition

validationInputMessagePosition: IgPoint

width

width: string

workbook

workbook: Workbook

zoomLevel

zoomLevel: number

Accessors

ActionExecuted

Invoked when an action is executed on the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.action" argType="string" Gets the action that was executed.

get ActionExecuted(): EventEmitter<object>

Returns EventEmitter<object>

ActionExecuting

Invoked when an action is about to be executed by the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.action" argType="string" Gets the action that is about to be executed.

get ActionExecuting(): EventEmitter<object>

Returns EventEmitter<object>

activeCellChanged

Invoked when the activeCell of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldValue" argType="string" Gets the previous active cell. eventArgument="ui.newValue" argType="string" Gets the current active cell.

get activeCellChanged(): EventEmitter<object>

Returns EventEmitter<object>

activePaneChanged

Invoked when the activePane of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActivePane" argType="object" Gets the previous active pane. eventArgument="ui.newActivePane" argType="object" Gets the current active pane. eventArgument="ui.activeCell" argType="string" Gets the active cell of the new active pane or null if there is no active pane. eventArgument="ui.visibleRange" argType="string" Gets the current visible range of the new active pane or null if there is no active pane.

get activePaneChanged(): EventEmitter<object>

Returns EventEmitter<object>

activeSelectionCellRangeFormat

Returns an object used to get the formatting of the activeCell and where modifications are applied to the entire activeSelection. Any changes made to this object will affect all the objects in the selection. So for example, the Font.Name may return "Arial" because the active cell has that as its resolved font name even though the other cells are using a different font but if you set the Font.Name of this object to "Arial" then all the objects affected by the selection will have their Font.Name updated to that value.

get activeSelectionCellRangeFormat(): SpreadsheetCellRangeFormat

Returns SpreadsheetCellRangeFormat

activeTableChanged

Invoked when the activeTable of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActiveTable" argType="object" Gets the previous active Table. eventArgument="ui.newActiveTable" argType="object" Gets the current active Table.

get activeTableChanged(): EventEmitter<object>

Returns EventEmitter<object>

activeWorksheetChanged

Invoked when the activeWorksheet of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActiveWorksheet" argType="object" Gets the previous active worksheet. eventArgument="ui.oldActiveWorksheetName" argType="string" Gets the name of the previous active worksheet or null if oldActiveWorksheet is null. eventArgument="ui.newActiveWorksheet" argType="object" Gets the current active worksheet. eventArgument="ui.newActiveWorksheetName" argType="string" Gets the name of the new active worksheet or null if newActiveWorksheet is null.

get activeWorksheetChanged(): EventEmitter<object>

Returns EventEmitter<object>

contextMenuOpening

Invoked when a contextmenu is being opened for the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.menuArea" argType="string" Get the area for which the menu is being displayed.

get contextMenuOpening(): EventEmitter<object>

Returns EventEmitter<object>

editModeEntered

Invoked when the Spreadsheet has started in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control has entered edit mode.

get editModeEntered(): EventEmitter<object>

Returns EventEmitter<object>

editModeEntering

Invoked when the Spreadsheet is about to start in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control is going into edit mode.

get editModeEntering(): EventEmitter<object>

Returns EventEmitter<object>

editModeExited

Invoked when the Spreadsheet has ended the in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control has exited edit mode.

get editModeExited(): EventEmitter<object>

Returns EventEmitter<object>

editModeExiting

Invoked when the Spreadsheet is about to end the in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.acceptChanges" argType="bool" Get or set a boolean indicating whether the changes will be made to the cell's value when edit mode ends. eventArgument="ui.canCancel" argType="bool" Get a boolean indicating if the edit mode is being forced to exit edit mode in which case it cannot be cancelled. eventArgument="ui.cell" argType="string" Gets the cell for which the control is exiting edit mode. eventArgument="ui.editText" argType="string" Gets the edit text that will be used to update the cell(s).

get editModeExiting(): EventEmitter<object>

Returns EventEmitter<object>

editModeValidationError

Invoked when the Spreadsheet is exiting edit mode and the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.action" argType="string" Get or set the action to take in response to the failed validation. eventArgument="ui.canStayInEditMode" argType="bool" Get a boolean indicating whether the cell is allowed to stay in edit mode. eventArgument="ui.cell" argType="string" Gets the cell for which the control is in edit mode. eventArgument="ui.validationRule" argType="string" Get the rule which failed validation. The EditModeValidationError is raised while exiting edit mode if the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. Since the rule needs to evaluate the value of the cell and potentially other cell's in the Worksheet, the value is first applied to the cell(s) and then is validated. By default if the event is not handled and the showErrorMessageForInvalidValue is true, a message box will be displayed to the end user to determine what action to take. One can handle this event and specify the action that should be taken using the action. Note: The validation rule will not be evaluated if edit mode is being cancelled such as when the user presses Escape to cancel edit. Note: The action will default to AcceptChange if the ShowErrorMessageForInvalidValue of the validationRule is false; otherwise it will default to ShowPrompt . Note: Like Microsoft Excel, only the validation rule of the active cell is considered even if the update is affecting other cells in the selection.

get editModeValidationError(): EventEmitter<object>

Returns EventEmitter<object>

editRangePasswordNeeded

Invoked when the Spreadsheet is performing an operation on a protected Worksheet and there is a single range that may be unlocked to allow the operation to be performed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.ranges" argType="array" Get an array of protected range objects that should be unlocked. eventArgument="ui.unprotect" argType="object" Get a parameterless function that may be invoked to unlock the associated ranges.

get editRangePasswordNeeded(): EventEmitter<object>

Returns EventEmitter<object>

hyperlinkExecuting

Invoked when a hyperlink is being followed in the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.hyperlink" argType="object" Get the hyperlink to be executed.

get hyperlinkExecuting(): EventEmitter<object>

Returns EventEmitter<object>

panes

Returns an array of the panes for the activeWorksheet.

get panes(): SpreadsheetPane[]

Returns SpreadsheetPane[]

selectionChanged

Invoked when the selection for a ig.spreadsheet.SpreadsheetPane of the Spreadsheet is changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.pane" argType="object" Get the pane for which the selection has changed.

get selectionChanged(): EventEmitter<object>

Returns EventEmitter<object>

userPromptDisplaying

Invoked when the user will be prompted with a message regarding an operation that is being performed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.canCancel" argType="bool" Get a boolean indicating if the operation that triggered the prompt can be cancelled. eventArgument="ui.displayMessage" argType="bool" Get a boolean indicating if a message will be displayed to the end user. eventArgument="ui.exception" argType="object" Gets the exception for the error, if there was one. eventArgument="ui.message" argType="string" Get or set the message that will be displayed. eventArgument="ui.trigger" argType="string" Get the action that caused the prompt to be displayed.

get userPromptDisplaying(): EventEmitter<object>

Returns EventEmitter<object>

workbookDirtied

Invoked when a change has been made to the workbook that might require a save. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. Note: This event is invoked asynchronously with regards to the change(s) that have occurred. Also some changes alone are not considered to dirty the Workbook even though it does change state on the Workbook or one of its subobjects. An example of that would be a zoom type operation (e.g. changing the magnificationInNormalView).

get workbookDirtied(): EventEmitter<object>

Returns EventEmitter<object>

Methods

containerResized

Notifies the spreadsheet that the container object has been resized.

containerResized(): void

Returns void

executeAction

Executes the specified action.

executeAction(action: SpreadsheetAction): boolean

Parameters

action: SpreadsheetAction
- Identifies the action to be performed.

Returns boolean

exportVisualData

Returns an object with information about the visual state of the spreadsheet.

exportVisualData(): any

Returns any

findByName

findByName(name: string): any

Parameters

name: string

Returns any

flush

Forces the spreadsheet to synchronously perform any deferred work.

flush(): void

Returns void

ngAfterContentInit

ngAfterContentInit(): void

Returns void

ngOnDestroy

ngOnDestroy(): void

Returns void

styleUpdated

Notifies the spreadsheet that style information used for rendering may have been updated.

styleUpdated(): void

Returns void

_createFromInternal

_createFromInternal(internal: any): IgxSpreadsheetComponent

Parameters

internal: any