Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DisplayWindow

Class representing DisplayWindow

Hierarchy

  • DisplayWindow

Index

Properties

Constructors

Methods

Properties

Private io

io: Io

Private displayContext

displayContext: DisplayContext

windowName

windowName: string

displayName

displayName: string

uniformGridCellSize

uniformGridCellSize: UniformGridCellSize

Constructors

constructor

Methods

_postRequest

  • _postRequest<T>(data: object): Promise<T>

id

  • id(): string

clearGrid

  • clearGrid(): Promise<object>

clearContents

  • clearContents(): Promise<object>

createUniformGrid

  • Creates a simple grid layout in the display window

    example

    A sample options object 'contentGrid': { 'row': 2, 'col': 2, 'padding': 5, 'rowHeight' : [ 0.5, 0.5] // ( float array, height percent for each row - 0.0 to 1.0 ) 'colWidth' : [ 0.4, 0.6] //( float array, width percent for each col - 0.0 to 1.0 ) }, 'gridBackground' : { '1|1' : 'white', '1|2' : 'grey', '2|1' : 'grey', '2|2' : 'white' }

    Parameters

    Returns Promise<object>

addToGrid

  • addToGrid(label: string, bounds: { left: string; top: string; width: string; height: string }, backgroundStyle: string): Promise<object>

  • adds a cell to the grid

    Parameters

    • label: string
    • bounds: { left: string; top: string; width: string; height: string }
      • left: string
      • top: string
      • width: string
      • height: string
    • backgroundStyle: string

    Returns Promise<object>

removeFromGrid

  • removeFromGrid(label: string): Promise<object>

getGrid

  • getGrid(): Promise<object>

getUniformGridCellSize

setCellStyle

  • setCellStyle(label: string, style: string, animation?: object): Promise<object>

setFontSize

  • setFontSize(fontSize: string): Promise<object>

hide

  • hide(): Promise<object>

show

  • show(): Promise<object>

close

  • close(): Promise<object>

openDevTools

  • openDevTools(): Promise<object>

closeDevTools

  • closeDevTools(): Promise<object>

capture

  • capture(): Promise<object>

createViewObject

Generated using TypeDoc