Skip to content

GaugeNode

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/scenery-phet/blob/main/js/GaugeNode.ts for the most up-to-date information.

Overview

GaugeNode is a circular gauge that depicts some dynamic value. This was originally ported from the speedometer node in forces-and-motion-basics.

@author Sam Reid (PhET Interactive Simulations) @author John Blanco (PhET Interactive Simulations)

Class GaugeNode

import { GaugeNode } from 'scenerystack/scenery-phet';

Constructor

new GaugeNode( valueProperty : TReadOnlyProperty<number>, labelProperty : TReadOnlyProperty<string>, range : Range, providedOptions? : GaugeNodeOptions )

Instance Methods

dispose()

Instance Properties

radius : number

(readonly)

Type GaugeNodeOptions

import type { GaugeNodeOptions } from 'scenerystack/scenery-phet';
  • radius?: number
  • backgroundFill?: TColor
  • backgroundStroke?: TColor
  • backgroundLineWidth?: number
  • maxLabelWidthScale?: number
  • numberOfTicks?: number
    ticks
  • majorTickStroke?: TColor
  • minorTickStroke?: TColor
  • majorTickLength?: number
  • minorTickLength?: number
  • majorTickLineWidth?: number
  • minorTickLineWidth?: number
  • labelTextOptions?: GaugeNodeLabelTextOptions
    label text
  • span?: number
    the top half of the gauge, plus PI/8 extended below the top half on each side
  • needleLineWidth?: number
  • updateWhenInvisible?: boolean
    true - always updates, even when invisible false - does not update when invisible, use to optimize performance
  • & NodeOptions

Source Code

See the source for GaugeNode.ts in the scenery-phet repository.