Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxSpreadsheetComponent

Custom control that displays one or more worksheets.

Hierarchy

Hierarchy

  • IgxSpreadsheetComponent

Implements

  • AfterContentInit
  • OnDestroy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • _renderer: Renderer2
    • _elRef: ViewContainerRef
    • _ngZone: NgZone
    • _componentFactoryResolver: ComponentFactoryResolver
    • _injector: Injector

    Returns IgxSpreadsheetComponent

Properties

_dynamicContent

_dynamicContent: ViewContainerRef

Static ngAcceptInputType_allowAddWorksheet

ngAcceptInputType_allowAddWorksheet: string | boolean

Static ngAcceptInputType_allowDeleteWorksheet

ngAcceptInputType_allowDeleteWorksheet: string | boolean

Static ngAcceptInputType_areGridlinesVisible

ngAcceptInputType_areGridlinesVisible: string | boolean

Static ngAcceptInputType_areHeadersVisible

ngAcceptInputType_areHeadersVisible: string | boolean

Static ngAcceptInputType_fixedDecimalPlaceCount

ngAcceptInputType_fixedDecimalPlaceCount: string | number

Static ngAcceptInputType_isEnterKeyNavigationEnabled

ngAcceptInputType_isEnterKeyNavigationEnabled: string | boolean

Static ngAcceptInputType_isFixedDecimalEnabled

ngAcceptInputType_isFixedDecimalEnabled: string | boolean

Static ngAcceptInputType_isFormulaBarVisible

ngAcceptInputType_isFormulaBarVisible: string | boolean

Static ngAcceptInputType_isInEditMode

ngAcceptInputType_isInEditMode: string | boolean

Static ngAcceptInputType_isInEndMode

ngAcceptInputType_isInEndMode: string | boolean

Static ngAcceptInputType_isRenamingWorksheet

ngAcceptInputType_isRenamingWorksheet: string | boolean

Static ngAcceptInputType_isScrollLocked

ngAcceptInputType_isScrollLocked: string | boolean

Static ngAcceptInputType_isUndoEnabled

ngAcceptInputType_isUndoEnabled: string | boolean

Static ngAcceptInputType_nameBoxWidth

ngAcceptInputType_nameBoxWidth: string | number

Static ngAcceptInputType_selectedWorksheets

ngAcceptInputType_selectedWorksheets: string | Worksheet[]

Static ngAcceptInputType_validationInputMessagePosition

ngAcceptInputType_validationInputMessagePosition: string | IgPoint

Static ngAcceptInputType_zoomLevel

ngAcceptInputType_zoomLevel: string | number

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

ActionExecuted

  • get ActionExecuted(): EventEmitter<{
        args: IgxSpreadsheetActionExecutedEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetActionExecutedEventArgs;
        sender: any;
    }>

ActionExecuting

  • get ActionExecuting(): EventEmitter<{
        args: IgxSpreadsheetActionExecutingEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetActionExecutingEventArgs;
        sender: any;
    }>

activeCell

  • get activeCell(): SpreadsheetCell

  • Returns or sets the active cell within the selected worksheet.

    Returns SpreadsheetCell

  • set activeCell(v: SpreadsheetCell): void

  • Parameters

    Returns void

activeCellChanged

  • get activeCellChanged(): EventEmitter<{
        args: IgxSpreadsheetActiveCellChangedEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetActiveCellChangedEventArgs;
        sender: any;
    }>

activePane

  • get activePane(): SpreadsheetPane

  • Returns an object that represents the pane with the focus.

    Returns SpreadsheetPane

  • set activePane(v: SpreadsheetPane): void

  • Parameters

    Returns void

activePaneChanged

  • get activePaneChanged(): EventEmitter<{
        args: IgxSpreadsheetActivePaneChangedEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetActivePaneChangedEventArgs;
        sender: any;
    }>

activeSelection

  • get activeSelection(): SpreadsheetSelection

  • Returns an object that represents the current selection of the activePane.

    Returns SpreadsheetSelection

  • set activeSelection(v: SpreadsheetSelection): void

  • Parameters

    Returns void

activeSelectionCellRangeFormat

  • get activeSelectionCellRangeFormat(): SpreadsheetCellRangeFormat

  • 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.

    Returns SpreadsheetCellRangeFormat

activeTable

  • get activeTable(): WorksheetTable

  • Returns the ig.excel.WorksheetTable associated with the activeCell of the activeWorksheet.

    Returns WorksheetTable

  • set activeTable(v: WorksheetTable): void

  • Parameters

    Returns void

activeTableChanged

  • get activeTableChanged(): EventEmitter<{
        args: IgxSpreadsheetActiveTableChangedEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetActiveTableChangedEventArgs;
        sender: any;
    }>

activeWorksheet

  • get activeWorksheet(): Worksheet

  • Returns or sets the Worksheet from the workbook whose content should be displayed within the control.

    Returns Worksheet

  • set activeWorksheet(v: Worksheet): void

  • Parameters

    Returns void

activeWorksheetChanged

  • get activeWorksheetChanged(): EventEmitter<{
        args: IgxSpreadsheetActiveWorksheetChangedEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetActiveWorksheetChangedEventArgs;
        sender: any;
    }>

allowAddWorksheet

  • get allowAddWorksheet(): boolean

  • Returns or sets a boolean indicating whether the spreadsheet allows adding worksheets.

    Returns boolean

  • set allowAddWorksheet(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

allowDeleteWorksheet

  • get allowDeleteWorksheet(): boolean

  • Returns or sets a boolean indicating whether the spreadsheet allows deleting worksheets.

    Returns boolean

  • set allowDeleteWorksheet(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

areGridlinesVisible

  • get areGridlinesVisible(): boolean

  • Returns or sets a boolean indicating if the grid lines are displayed in the selected worksheets.

    Returns boolean

  • set areGridlinesVisible(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

areHeadersVisible

  • get areHeadersVisible(): boolean

  • Returns or sets a boolean indicating if the row and column headers are displayed for the selected worksheets.

    Returns boolean

  • set areHeadersVisible(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

cellEditMode

chartAdapter

  • get chartAdapter(): SpreadsheetChartAdapterBase

  • Returns or sets the object that will provide the chart visualization for display within the Spreadsheet By default charts are not displayed within the spreadsheet. To display charts one should set this property to an instance of a SpreadsheetChartAdapter which is in a separate reference since it relies upon the chart and other data visualization controls.

    Returns SpreadsheetChartAdapterBase

  • set chartAdapter(v: SpreadsheetChartAdapterBase): void

  • Parameters

    Returns void

contextMenuOpening

  • get contextMenuOpening(): EventEmitter<{
        args: IgxSpreadsheetContextMenuOpeningEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetContextMenuOpeningEventArgs;
        sender: any;
    }>

editModeEntered

  • get editModeEntered(): EventEmitter<{
        args: IgxSpreadsheetEditModeEnteredEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetEditModeEnteredEventArgs;
        sender: any;
    }>

editModeEntering

  • get editModeEntering(): EventEmitter<{
        args: IgxSpreadsheetEditModeEnteringEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetEditModeEnteringEventArgs;
        sender: any;
    }>

editModeExited

  • get editModeExited(): EventEmitter<{
        args: IgxSpreadsheetEditModeExitedEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetEditModeExitedEventArgs;
        sender: any;
    }>

editModeExiting

  • get editModeExiting(): EventEmitter<{
        args: IgxSpreadsheetEditModeExitingEventArgs;
        sender: any;
    }>

  • 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).

    Returns EventEmitter<{
        args: IgxSpreadsheetEditModeExitingEventArgs;
        sender: any;
    }>

editModeValidationError

  • get editModeValidationError(): EventEmitter<{
        args: IgxSpreadsheetEditModeValidationErrorEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetEditModeValidationErrorEventArgs;
        sender: any;
    }>

editRangePasswordNeeded

  • get editRangePasswordNeeded(): EventEmitter<{
        args: IgxSpreadsheetEditRangePasswordNeededEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetEditRangePasswordNeededEventArgs;
        sender: any;
    }>

enterKeyNavigationDirection

fixedDecimalPlaceCount

  • get fixedDecimalPlaceCount(): number

  • Returns or sets the number of decimal places by which a whole number typed in during edit mode should be adjusted when isFixedDecimalEnabled is true

    Returns number

  • set fixedDecimalPlaceCount(v: number): void

  • Parameters

    • v: number

    Returns void

height

  • get height(): string

  • Returns string

  • set height(value: string): void

  • Parameters

    • value: string

    Returns void

hyperlinkExecuting

  • get hyperlinkExecuting(): EventEmitter<{
        args: IgxSpreadsheetHyperlinkExecutingEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetHyperlinkExecutingEventArgs;
        sender: any;
    }>

isEnterKeyNavigationEnabled

  • get isEnterKeyNavigationEnabled(): boolean

  • Returns or sets a boolean indicating whether the adjacent cell indicated by the enterKeyNavigationDirection should be navigated to when the enter key is pressed.

    Returns boolean

  • set isEnterKeyNavigationEnabled(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isFixedDecimalEnabled

  • get isFixedDecimalEnabled(): boolean

  • Returns or sets a boolean indicating whether a fixed decimal place is automatically added when a whole number is entered while in edit mode.

    Returns boolean

  • set isFixedDecimalEnabled(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isFormulaBarVisible

  • get isFormulaBarVisible(): boolean

  • Returns or sets a boolean indicating if the formula bar is displayed within the Spreadsheet.

    Returns boolean

  • set isFormulaBarVisible(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isInEditMode

  • get isInEditMode(): boolean

  • Returns a boolean indicating if the control is currently editing the value of the activeCell

    Returns boolean

  • set isInEditMode(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isInEndMode

  • get isInEndMode(): boolean

  • Returns or sets a boolean indicating whether the control is in "End mode". End mode is a mode that affects certain keyboard navigation such as navigating with the arrow keys. For example when in end mode and one presses the right arrow, the activeCell will be changed to be the first cell to the right of the current ActiveCell that has a value (even if the value is ""). If there were no cells to the right with a value then it would activate the right most cell in that row. End mode will end automatically such as when one presses an arrow key.

    Returns boolean

  • set isInEndMode(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isRenamingWorksheet

  • get isRenamingWorksheet(): boolean

  • Returns a boolean indicating if the user is currently editing the name of the active worksheet.

    Returns boolean

  • set isRenamingWorksheet(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isScrollLocked

  • get isScrollLocked(): boolean

  • Returns or sets a boolean indicating whether the scroll lock key is toggled. This property is used when certain keys are pressed while the control has focus. For example if an arrow key is pressed while the scroll lock is enabled the cell area will be scrolled rather than changing the active cell. Note: This property is not maintained/changed by the control. It is just queried when performing actions that consider whether the scroll lock is enabled.

    Returns boolean

  • set isScrollLocked(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isUndoEnabled

  • get isUndoEnabled(): boolean

  • Returns or sets a boolean indicating whether undo is enabled for the control.

    Returns boolean

  • set isUndoEnabled(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

nameBoxWidth

  • get nameBoxWidth(): number

  • Returns or sets the width of the name box within the formula bar.

    Returns number

  • set nameBoxWidth(v: number): void

  • Parameters

    • v: number

    Returns void

panes

  • get panes(): SpreadsheetPane[]

  • Returns an array of the panes for the activeWorksheet.

    Returns SpreadsheetPane[]

selectedWorksheets

  • get selectedWorksheets(): Worksheet[]

  • Returns or sets an array of the Worksheets whose tabs are selected.

    Returns Worksheet[]

  • set selectedWorksheets(v: Worksheet[]): void

  • Parameters

    Returns void

selectionChanged

  • get selectionChanged(): EventEmitter<{
        args: IgxSpreadsheetSelectionChangedEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetSelectionChangedEventArgs;
        sender: any;
    }>

selectionMode

undoManager

  • get undoManager(): UndoManager

  • Returns or sets the UndoManager. Note: this property can not be set to null.

    Returns UndoManager

  • set undoManager(v: UndoManager): void

  • Parameters

    • v: UndoManager

    Returns void

userPromptDisplaying

  • get userPromptDisplaying(): EventEmitter<{
        args: IgxSpreadsheetUserPromptDisplayingEventArgs;
        sender: any;
    }>

  • 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.

    Returns EventEmitter<{
        args: IgxSpreadsheetUserPromptDisplayingEventArgs;
        sender: any;
    }>

validationInputMessagePosition

  • get validationInputMessagePosition(): IgPoint

  • Returns or sets the position of the screen tip used to display the input message for the data validation rule associated with the active cell.

    Returns IgPoint

  • set validationInputMessagePosition(v: IgPoint): void

  • Parameters

    Returns void

width

  • get width(): string

  • Returns string

  • set width(value: string): void

  • Parameters

    • value: string

    Returns void

workbook

  • get workbook(): Workbook

  • Returns or sets the workbook whose information is displayed in the control.

    Returns Workbook

  • set workbook(v: Workbook): void

  • Parameters

    Returns void

workbookDirtied

  • get workbookDirtied(): EventEmitter<{
        args: IgxSpreadsheetWorkbookDirtiedEventArgs;
        sender: any;
    }>

  • 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).

    Returns EventEmitter<{
        args: IgxSpreadsheetWorkbookDirtiedEventArgs;
        sender: any;
    }>

zoomLevel

  • get zoomLevel(): number

  • Returns or sets the magnification of the selected worksheets.

    Returns number

  • set zoomLevel(v: number): void

  • Parameters

    • v: number

    Returns void

Methods

containerResized

  • Notifies the spreadsheet that the container object has been resized.

    Returns void

executeAction

  • Executes the specified action.

    Parameters

    Returns boolean

exportVisualData

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

    Returns any

findByName

  • Parameters

    • name: string

    Returns any

flush

  • Forces the spreadsheet to synchronously perform any deferred work.

    Returns void

ngAfterContentInit

  • Returns void

ngOnDestroy

  • Returns void

styleUpdated

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

    Returns void

Static _createFromInternal