Skip to content

StringProperty

Under Construction

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

Overview

StringProperty is a Property whose value is a string.

@author Sam Reid (PhET Interactive Simulations) @author Chris Malley (PixelZoom, Inc.)

Class StringProperty

import { StringProperty } from 'scenerystack/axon';

Constructor

new StringProperty( value : string, providedOptions? : StringPropertyOptions )

Instance Methods

Type StringPropertyOptions

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

StrictOmit<PropertyOptions<string>, "valueType" | "phetioValueType">

Source Code

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