rStats

rStats

new rStats(settingsopt)

Source:
Parameters:
Name Type Attributes Description
settings rStats~Settings <optional>

Settings for the rStats instance.

Type Definitions

CounterProperties

Source:
Properties:
Name Type Attributes Default Description
caption String <optional>

Caption for this counter.

average Boolean <optional>
false

Whether the values should be averaged.

avgMs Number <optional>
1000

Duration for which the values should be averaged.

below Number <optional>

Value below which the graph should be highlighted.

over Number <optional>

Value over which the graph should be highlighted.

interpolate Boolean <optional>
true

Whether framerate should be interpolated.

Type:
  • Object

Settings

Source:
Properties:
Name Type Attributes Default Description
colours Array.<String> <optional>

An array of CSS colour values.

CSSPath String <optional>
''

Base URL where rStats.css is located.

css Array.<String> <optional>

URLs of CSS or font files to import.

values Object.<String, rStats~CounterProperties> <optional>

Properties to use for each counter.

groups Array.<Object> <optional>

Define groups of counters.

fractions Array.<Object> <optional>

Define stacked counters.

plugins Array.<Object> <optional>

Additional plugins.

Type:
  • Object