OffScaleIndicatorNode¶

Overview¶

An indicator that shows when something is off scale - usually in the context of a plot.

@author Jesse Greenberg (PhET Interactive Simulations)

Class OffScaleIndicatorNode¶

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

Constructor¶

new OffScaleIndicatorNode( direction : 'left' | 'right' | 'up' | 'down', providedOptions? : OffScaleIndicatorNodeOptions )¶

Instance Methods¶

dispose()¶

Type OffScaleIndicatorNodeOptions¶

import type { OffScaleIndicatorNodeOptions } from 'scenerystack/scenery-phet';

• offScaleStringProperty?: TReadOnlyProperty<string>
  The label string for the off scale indicator.
• arrowTailLength?: number
  The length of the arrow icon tail.
• spacing?: number
  Spacing between the label text and the icon arrow.
• arrowNodeOptions?: ArrowNodeOptions
  Options forwarded to the ArrowNode.
• richTextOptions?: RichTextOptions
  Options forwarded to the RichText label.
• panelOptions?: PanelOptions
  Options forwarded to the Panel.
• & ReadingBlockOptions & StrictOmit<TrimParallelDOMOptions<NodeOptions>, "accessibleName" | "accessibleHelpText">

Source Code¶

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