Custom control that displays one or more worksheets.
Constructors
Section titled "Constructors"IgrSpreadsheet
new IgrSpreadsheet(props: IIgrSpreadsheetProps): IgrSpreadsheetReturns IgrSpreadsheet
Properties
Section titled "Properties"ActionExecuted
Section titled "ActionExecuted"ActionExecuted: objectActionExecuting
Section titled "ActionExecuting"ActionExecuting: objectactiveCell
Section titled "activeCell"activeCell: SpreadsheetCellactiveCellChanged
Section titled "activeCellChanged"activeCellChanged: objectactivePane
Section titled "activePane"activePane: SpreadsheetPaneactivePaneChanged
Section titled "activePaneChanged"activePaneChanged: objectactiveSelection
Section titled "activeSelection"activeSelection: SpreadsheetSelectionactiveTable
Section titled "activeTable"activeTable: WorksheetTableactiveTableChanged
Section titled "activeTableChanged"activeTableChanged: objectactiveWorksheet
Section titled "activeWorksheet"activeWorksheet: WorksheetactiveWorksheetChanged
Section titled "activeWorksheetChanged"activeWorksheetChanged: objectallowAddWorksheet
Section titled "allowAddWorksheet"allowAddWorksheet: booleanallowAsyncCalculations
Section titled "allowAsyncCalculations"allowAsyncCalculations: booleanallowDeleteWorksheet
Section titled "allowDeleteWorksheet"allowDeleteWorksheet: booleanareGridlinesVisible
Section titled "areGridlinesVisible"areGridlinesVisible: booleanareHeadersVisible
Section titled "areHeadersVisible"areHeadersVisible: booleancellEditMode
Section titled "cellEditMode"cellEditMode: SpreadsheetCellEditModechartAdapter
Section titled "chartAdapter"chartAdapter: SpreadsheetChartAdapterBasecontextMenuOpening
Section titled "contextMenuOpening"contextMenuOpening: objecteditModeEntered
Section titled "editModeEntered"editModeEntered: objecteditModeEntering
Section titled "editModeEntering"editModeEntering: objecteditModeExited
Section titled "editModeExited"editModeExited: objecteditModeExiting
Section titled "editModeExiting"editModeExiting: objecteditModeValidationError
Section titled "editModeValidationError"editModeValidationError: objecteditRangePasswordNeeded
Section titled "editRangePasswordNeeded"editRangePasswordNeeded: objectenterKeyNavigationDirection
Section titled "enterKeyNavigationDirection"enterKeyNavigationDirection: SpreadsheetEnterKeyNavigationDirectionfixedDecimalPlaceCount
Section titled "fixedDecimalPlaceCount"fixedDecimalPlaceCount: numberheight
Section titled "height"height: stringhyperlinkExecuting
Section titled "hyperlinkExecuting"hyperlinkExecuting: objectisEnterKeyNavigationEnabled
Section titled "isEnterKeyNavigationEnabled"isEnterKeyNavigationEnabled: booleanisFixedDecimalEnabled
Section titled "isFixedDecimalEnabled"isFixedDecimalEnabled: booleanisFormulaBarVisible
Section titled "isFormulaBarVisible"isFormulaBarVisible: booleanisInEditMode
Section titled "isInEditMode"isInEditMode: booleanisInEndMode
Section titled "isInEndMode"isInEndMode: booleanisPerformingAsyncCalculations
Section titled "isPerformingAsyncCalculations"isPerformingAsyncCalculations: booleanisRenamingWorksheet
Section titled "isRenamingWorksheet"isRenamingWorksheet: booleanisScrollLocked
Section titled "isScrollLocked"isScrollLocked: booleanisUndoEnabled
Section titled "isUndoEnabled"isUndoEnabled: booleannameBoxWidth
Section titled "nameBoxWidth"nameBoxWidth: numberselectedWorksheets
Section titled "selectedWorksheets"selectedWorksheets: Worksheet[]selectionChanged
Section titled "selectionChanged"selectionChanged: objectselectionMode
Section titled "selectionMode"selectionMode: SpreadsheetCellSelectionModeundoManager
Section titled "undoManager"undoManager: UndoManageruserPromptDisplaying
Section titled "userPromptDisplaying"userPromptDisplaying: objectvalidationInputMessagePosition
Section titled "validationInputMessagePosition"validationInputMessagePosition: IgPointwidth
Section titled "width"width: stringworkbook
Section titled "workbook"workbook: WorkbookworkbookDirtied
Section titled "workbookDirtied"workbookDirtied: objectzoomLevel
Section titled "zoomLevel"zoomLevel: numberAccessors
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(): SpreadsheetCellRangeFormatReturns SpreadsheetCellRangeFormat
nativeElement
Section titled "nativeElement"get nativeElement(): HTMLElementReturns HTMLElement
panes
Section titled "panes"Returns an array of the panes for the activeWorksheet.
get panes(): SpreadsheetPane[]Returns SpreadsheetPane[]
Methods
Section titled "Methods"componentDidMount
Section titled "componentDidMount"componentDidMount(): voidReturns void
componentWillUnmount
Section titled "componentWillUnmount"componentWillUnmount(): voidReturns void
containerResized
Section titled "containerResized"Notifies the spreadsheet that the container object has been resized.
containerResized(): voidReturns void
destroy
Section titled "destroy"destroy(): voidReturns void
executeAction
Section titled "executeAction"Executes the specified action.
executeAction(action: SpreadsheetAction): booleanParameters
- action:
SpreadsheetAction- Identifies the action to be performed.
Returns boolean
exportVisualData
Section titled "exportVisualData"Returns an object with information about the visual state of the spreadsheet.
exportVisualData(): anyReturns any
findByName
Section titled "findByName"findByName(name: string): anyParameters
- name:
string
Returns any
flush
Section titled "flush"Forces the spreadsheet to synchronously perform any deferred work.
flush(): voidReturns void
initializeContent
Section titled "initializeContent"initializeContent(): voidReturns void
render
Section titled "render"render(): DetailedReactHTMLElement<object, any>Returns DetailedReactHTMLElement<object, any>
shouldComponentUpdate
Section titled "shouldComponentUpdate"shouldComponentUpdate(nextProps: any, nextState: any): booleanParameters
- nextProps:
any - nextState:
any
Returns boolean
styleUpdated
Section titled "styleUpdated"Notifies the spreadsheet that style information used for rendering may have been updated.
styleUpdated(): voidReturns void
_createFromInternal
Section titled "_createFromInternal"_createFromInternal(internal: any): IgrSpreadsheetParameters
- internal:
any