Library screen

Screen library. Used for screen specific functionality.

Functions

getParameters() Returns the current screen parameters (including any overrides set by screen.setParameters()).
resetParameters() Resets the parameters for the screen back to their defaults.
setParameters( params ) Sets the parameters that determine how the screen should be rendered.


Functions

screen.getParameters()
Returns the current screen parameters (including any overrides set by screen.setParameters()).

Environment:

Client
screen.resetParameters()
Resets the parameters for the screen back to their defaults.

Environment:

Client
screen.setParameters( params )
Sets the parameters that determine how the screen should be rendered. This should be called at startup to ensure the screen renders as expected. This will throw an error if any of the parameters are invalid.

Environment:

Client

Parameters:

  • (ScreenParameters) params: The parameters to use to determine how the screen is rendered.

Valid XHTML 1.0!