Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayoutRefMut

A Layout allows you to combine multiple components together to visualize a variety of information the runner is interested in.

Hierarchy

Index

Constructors

constructor

  • This constructor is an implementation detail. Do not use this.

    Parameters

    • ptr: number

    Returns LayoutRefMut

Properties

ptr

ptr: number

Methods

clone

push

  • Adds a new component to the end of the layout.

    Parameters

    Returns void

remount

  • remount(): void
  • Remounts all the components as if they were freshly initialized. Some components may only provide some information whenever it changes or when their state is first queried. Remounting returns this information again, whenever the layout's state is queried the next time.

    Returns void

scrollDown

  • scrollDown(): void
  • Scrolls down all the components in the layout that can be scrolled down.

    Returns void

scrollUp

  • scrollUp(): void
  • Scrolls up all the components in the layout that can be scrolled up.

    Returns void

settingsAsJson

  • settingsAsJson(): any
  • Encodes the settings of the layout as JSON.

    Returns any

state

  • Calculates and returns the layout's state based on the timer provided.

    Parameters

    Returns LayoutState

stateAsJson

  • Calculates the layout's state based on the timer provided and encodes it as JSON. You can use this to visualize all of the components of a layout.

    Parameters

    Returns any

updateState

  • Updates the layout's state based on the timer provided.

    Parameters

    Returns void

updateStateAsJson

  • Updates the layout's state based on the timer provided and encodes it as JSON.

    Parameters

    Returns any

Generated using TypeDoc