PhetQueryParameters

PhetQueryParameters

Query parameters that manipulate the startup state of the PhET simulation. This is not an object defined in the global scope, but rather it serves as documentation about available query parameters. Note: The "flag" type for query parameters does not expect a value for the key, but rather just the presence of the key itself.

Members

In environments where users should not be able to navigate hyperlinks away from the simulation, clients can use ?allowLinks=false. In this case, links are displayed and not clickable. This query parameter is public facing.
Type:
  • boolean

(static) audio :string

Allows setting of the sound state, possible values are 'enabled' (default), 'muted', and 'disabled'. Sound must be supported by the sim for this to have any effect.
Type:
  • string

(static) colorProfile :string

The color profile used at startup, relevant only for sims that support multiple color profiles. 'default' and 'projector' are implemented in several sims, other profile names are not currently standardized.
Type:
  • string

(static) homeScreen :boolean

Indicates whether to display the home screen. For multi-screen sims only, throws an assertion error if supplied for a single-screen sim.
Type:
  • boolean

(static) initialScreen :number

Specifies the initial screen that will be visible when the sim starts. See `?screens` query parameter for screen numbering. For multi-screen sims only, throws an assertion error if applied in a single-screen sims. The default value of 0 is the home screen.
Type:
  • number

(static) locale :string

Select the language of the sim to the specific locale. Default to "en".
Type:
  • string