Custom control that displays one or more worksheets.

Constructors

Section titled "Constructors"

IgcSpreadsheetComponent

new IgcSpreadsheetComponent(): IgcSpreadsheetComponent

Returns IgcSpreadsheetComponent

Properties

Section titled "Properties"

htmlTagName

Section titled "htmlTagName" 
htmlTagName: string

activeCell

Section titled "activeCell" 
activeCell: SpreadsheetCell

activeCellChanged

Section titled "activeCellChanged" 
activeCellChanged: object

activePane

Section titled "activePane" 
activePane: SpreadsheetPane

activePaneChanged

Section titled "activePaneChanged" 
activePaneChanged: object

activeSelection

Section titled "activeSelection" 
activeSelection: SpreadsheetSelection

activeTable

Section titled "activeTable" 
activeTable: WorksheetTable

activeTableChanged

Section titled "activeTableChanged" 
activeTableChanged: object

activeWorksheet

Section titled "activeWorksheet" 
activeWorksheet: Worksheet

activeWorksheetChanged

Section titled "activeWorksheetChanged" 
activeWorksheetChanged: object

allowAddWorksheet

Section titled "allowAddWorksheet" 
allowAddWorksheet: boolean

allowAsyncCalculations

Section titled "allowAsyncCalculations" 
allowAsyncCalculations: boolean

allowDeleteWorksheet

Section titled "allowDeleteWorksheet" 
allowDeleteWorksheet: boolean

areGridlinesVisible

Section titled "areGridlinesVisible" 
areGridlinesVisible: boolean

areHeadersVisible

Section titled "areHeadersVisible" 
areHeadersVisible: boolean

cellEditMode

Section titled "cellEditMode" 
cellEditMode: SpreadsheetCellEditMode

chartAdapter

Section titled "chartAdapter" 
chartAdapter: SpreadsheetChartAdapterBase

CommandExecuted

Section titled "CommandExecuted" 
CommandExecuted: object

CommandExecuting

Section titled "CommandExecuting" 
CommandExecuting: object

contextMenuOpening

Section titled "contextMenuOpening" 
contextMenuOpening: object

editModeEntered

Section titled "editModeEntered" 
editModeEntered: object

editModeEntering

Section titled "editModeEntering" 
editModeEntering: object

editModeExited

Section titled "editModeExited" 
editModeExited: object

editModeExiting

Section titled "editModeExiting" 
editModeExiting: object

editModeValidationError

Section titled "editModeValidationError" 
editModeValidationError: object

editRangePasswordNeeded

Section titled "editRangePasswordNeeded" 
editRangePasswordNeeded: object

enterKeyNavigationDirection

Section titled "enterKeyNavigationDirection" 
enterKeyNavigationDirection: SpreadsheetEnterKeyNavigationDirection

fixedDecimalPlaceCount

Section titled "fixedDecimalPlaceCount" 
fixedDecimalPlaceCount: number

height

Section titled "height" 
height: string

hyperlinkExecuting

Section titled "hyperlinkExecuting" 
hyperlinkExecuting: object

isEnterKeyNavigationEnabled

Section titled "isEnterKeyNavigationEnabled" 
isEnterKeyNavigationEnabled: boolean

isFixedDecimalEnabled

Section titled "isFixedDecimalEnabled" 
isFixedDecimalEnabled: boolean

isFormulaBarVisible

Section titled "isFormulaBarVisible" 
isFormulaBarVisible: boolean

isInEditMode

Section titled "isInEditMode" 
isInEditMode: boolean

isInEndMode

Section titled "isInEndMode" 
isInEndMode: boolean

isPerformingAsyncCalculations

Section titled "isPerformingAsyncCalculations" 
isPerformingAsyncCalculations: boolean

isRenamingWorksheet

Section titled "isRenamingWorksheet" 
isRenamingWorksheet: boolean

isScrollLocked

Section titled "isScrollLocked" 
isScrollLocked: boolean

isUndoEnabled

Section titled "isUndoEnabled" 
isUndoEnabled: boolean

nameBoxWidth

Section titled "nameBoxWidth" 
nameBoxWidth: number

selectedWorksheets

Section titled "selectedWorksheets" 
selectedWorksheets: Worksheet[]

selectionChanged

Section titled "selectionChanged" 
selectionChanged: object

selectionMode

Section titled "selectionMode" 
selectionMode: SpreadsheetCellSelectionMode

undoManager

Section titled "undoManager" 
undoManager: UndoManager

userPromptDisplaying

Section titled "userPromptDisplaying" 
userPromptDisplaying: object

validationInputMessagePosition

Section titled "validationInputMessagePosition" 
validationInputMessagePosition: IgPoint

width

Section titled "width" 
width: string

workbook

Section titled "workbook" 
workbook: Workbook

workbookDirtied

Section titled "workbookDirtied" 
workbookDirtied: object

zoomLevel

Section titled "zoomLevel" 
zoomLevel: number

Accessors

Section titled "Accessors"

activeSelectionCellRangeFormat

Section titled "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

panes

Section titled "panes"

Returns an array of the panes for the activeWorksheet.

get panes(): SpreadsheetPane[]

Returns SpreadsheetPane[]

observedAttributes

Section titled "observedAttributes" 
get observedAttributes(): string[]

Returns string[]

Methods

Section titled "Methods"

afterContentInit

Section titled "afterContentInit" 
afterContentInit(): void

Returns void

attributeChangedCallback

Section titled "attributeChangedCallback" 
attributeChangedCallback(name: string, oldValue: string, newValue: string): void

Parameters

  • name: string
  • oldValue: string
  • newValue: string

Returns void

connectedCallback

Section titled "connectedCallback" 
connectedCallback(): void

Returns void

containerResized

Section titled "containerResized"

Notifies the spreadsheet that the container object has been resized.

containerResized(): void

Returns void

destroy

Section titled "destroy" 
destroy(): void

Returns void

disconnectedCallback

Section titled "disconnectedCallback" 
disconnectedCallback(): void

Returns void

executeAction

Section titled "executeAction"

Executes the specified action.

executeAction(action: SpreadsheetAction): boolean

Parameters

Returns boolean

exportVisualData

Section titled "exportVisualData"

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

exportVisualData(): any

Returns any

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

flush

Section titled "flush"

Forces the spreadsheet to synchronously perform any deferred work.

flush(): void

Returns void

styleUpdated

Section titled "styleUpdated"

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

styleUpdated(): void

Returns void

_createFromInternal

Section titled "_createFromInternal" 
_createFromInternal(internal: any): IgcSpreadsheetComponent

Parameters

  • internal: any

Returns IgcSpreadsheetComponent

register

Section titled "register" 
register(): void

Returns void