Options
All
  • Public
  • Public/Protected
  • All
Menu

OpenFin Excel Integration API Reference

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

CellValue

CellValue: string | number | null

Possible types for cell values.

ExcelApplicationEventListener

ExcelApplicationEventListener: WorkbookCreatedEventListener

Application-level event listeners.

ExcelCalculationMode

ExcelCalculationMode: "Automatic" | "Manual" | "Semiautomatic"

Available calculation modes which determine when a workbook is re-calculated.

In Excel, these options can be viewed in the ribbon "Formulas" tab, "Calculation" group, "Calculation Options" menu. The SemiAutomatic value maps to the "Automatic Except for Data Tables" option.

ExcelWorkbookEventListener

ExcelWorkbookEventListener: WorkbookActivatedEventListener | WorkbookClosedEventListener | WorkbookDeactivatedEventListener | WorksheetAddedEventListener | WorksheetDeletedEventListener

Workbook-level event listeners.

ExcelWorksheetEventListener

ExcelWorksheetEventListener: WorksheetActivatedEventListener | WorksheetChangedEventListener | WorksheetDeactivatedEventListener

Worksheet-level event listeners.

WorkbookActivatedEventListener

WorkbookActivatedEventListener: () => void

Type declaration

    • (): void

    • Function type for the event listener that is called when a workbook is activated.

      Returns void

WorkbookClosedEventListener

WorkbookClosedEventListener: () => void

Type declaration

    • (): void

    • Function type for the event listener that is called when a workbook is closed.

      Returns void

WorkbookCreatedEventListener

WorkbookCreatedEventListener: (workbook: ExcelWorkbook) => void

Type declaration

    • Function type for the event listener that is called when a workbook is created.

      Parameters

      Returns void

WorkbookDeactivatedEventListener

WorkbookDeactivatedEventListener: () => void

Type declaration

    • (): void

    • Function type for the event listener that is called when a workbook is deactivated.

      Returns void

WorksheetActivatedEventListener

WorksheetActivatedEventListener: () => void

Type declaration

    • (): void

    • Function type for the event listener that is called when a worksheet is activated.

      Returns void

WorksheetAddedEventListener

WorksheetAddedEventListener: (worksheet: ExcelWorksheet) => void

Type declaration

    • Function type for the event listener that is called when a worksheet is added.

      Parameters

      Returns void

WorksheetChangedEventListener

WorksheetChangedEventListener: (changedCells: Cell[]) => void

Type declaration

    • (changedCells: Cell[]): void

    • Function type for the event listener that is called when a worksheet is changed.

      Parameters

      • changedCells: Cell[]

        The cells affected by the change.

      Returns void

WorksheetDeactivatedEventListener

WorksheetDeactivatedEventListener: () => void

Type declaration

    • (): void

    • Function type for the event listener that is called when a worksheet is deactivated.

      Returns void

WorksheetDeletedEventListener

WorksheetDeletedEventListener: (worksheet: ExcelWorksheet) => void

Type declaration

    • Function type for the event listener that is called when a worksheet is deleted.

      Parameters

      Returns void

Functions

disableLogging

  • disableLogging(): void

  • Disables module logging if it has been enabled by a call to enableLogging.

    This function is registered globally so you can disable logging at any time by calling:

    window.fin.Integrations.Excel.disableLogging();

    Returns void

enableLogging

  • enableLogging(): void

  • Enables module logging to the console for debugging/troubleshooting purposes. This is off by default.

    This function is registered globally so you can enable logging at any time by calling:

    window.fin.Integrations.Excel.enableLogging();

    Returns void

getExcelApplication

  • The entry point for using the Excel integration client-side API.

    When calling this function for the first time, it initializes an adapter process for sole use by your application and connects to it via a channel. The adapter process exists for as long as your application is running and connected, after which the adapter terminates automatically. Subsequent calls always reuse the connected adapter.

    throws

    InitializationError if unable to launch the adapter process or some other error occurred during initialization.

    Returns Promise<ExcelApplication>

    An application object that enables control of Excel.

Generated using TypeDoc