Options
All
  • Public
  • Public/Protected
  • All
Menu

WorksheetApi provides operations to access worksheets.

Hierarchy

  • WorksheetApi

Index

Methods

closeWorksheet

  • closeWorksheet(id: string): Promise<void>

getOpenedWorksheet

  • getOpenedWorksheet(id: string): Promise<Sheet>

getOpenedWorksheets

  • getOpenedWorksheets(): Promise<Sheet[]>

getWorksheetData

  • getWorksheetData(id: string, from: number, rows: number): Promise<TableData>
  • Gets a block of rows from an opened worksheet.

    Parameters

    • id: string

      the runtime identifier of the opened worksheet.

    • from: number

      the starting, zero-based row number for the returned data. If not specified, 0 will be used.

    • rows: number

      the number of rows to return. Fewer rows may be returned if the end of the table is reached.

    Returns Promise<TableData>

    the worksheet data rows.

getWorksheetMetadata

  • getWorksheetMetadata(id: string): Promise<TableData>

getWorksheetParameters

getWorksheets

  • getWorksheets(): Promise<Sheet[]>

openWorksheet

  • openWorksheet(asset: string, parameters: object): Promise<Sheet>
  • Opens a worksheet.

    Parameters

    • asset: string

      the asset identifier of the worksheet.

    • parameters: object

      the parameters to use when opening the sheet.

      • [name: string]: any

    Returns Promise<Sheet>

    the worksheet was opened successfully.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc