Options
All
  • Public
  • Public/Protected
  • All
Menu

ViewsheetAPI provides operations for accessing viewsheets.

Hierarchy

  • ViewsheetApi

Index

Methods

closeViewsheet

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

exportViewsheet

  • exportViewsheet(id: string, format: string): Promise<ArrayBuffer>
  • Exports an opened viewsheet.

    Parameters

    • id: string

      the runtime identifier of the opened viewsheet.

    • format: string

      the format of the exported viewsheet.

    Returns Promise<ArrayBuffer>

    the binary content of the exported viewsheet.

getOpenedViewsheet

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

getOpenedViewsheets

  • getOpenedViewsheets(): Promise<Sheet[]>

getViewsheets

  • getViewsheets(): Promise<Sheet[]>

mailViewsheet

  • mailViewsheet(id: string, format: string, recipients: string[], sender: string, subject: string, message: string): Promise<void>
  • Sends an opened viewsheet in an email message.

    Parameters

    • id: string

      the runtime identifier of the opened viewsheet.

    • format: string

      the file format for the attached viewsheet.

    • recipients: string[]

      the email addresses of the recipients of the message.

    • sender: string

      the email address of the sender of the message.

    • subject: string

      the subject line of the message.

    • message: string

      the body of the message.

    Returns Promise<void>

openViewsheet

  • openViewsheet(assetId: string, parameters: object): Promise<Sheet>
  • Opens a viewsheet.

    Parameters

    • assetId: string

      the asset identifier of the viewsheet to open.

    • parameters: object

      a map of parameters to use when opening the viewsheet.

      • [name: string]: any

    Returns Promise<Sheet>

    the opened viewsheet information.

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