EnumerationProperty¶

Overview¶

Property support for rich enumeration types.

@author Sam Reid (PhET Interactive Simulations)

Class EnumerationProperty¶

import { EnumerationProperty } from 'scenerystack/axon';

Constructor¶

new EnumerationProperty( value : T, providedOptions? : EnumerationPropertyOptions<T> )¶

Instance Methods¶

Type EnumerationPropertyOptions¶

import type { EnumerationPropertyOptions } from 'scenerystack/axon';

• enumeration?: Enumeration<T>
  By default, this will be taken from the initial value, but if subtyping enumerations, you must provide this manually to make sure it is set to the correct, subtype value, see https://github.com/phetsims/phet-core/issues/102
• & StrictOmit<PropertyOptions<T>, "phetioValueType">

Source Code¶

See the source for EnumerationProperty.ts in the axon repository.