ScreenIcon¶

Under Construction

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

Overview¶

ScreenIcon is an icon that is suitable for one of the screen-selection buttons on the home screen or navigation bar. By default, the size is optimized for the home screen. To optimize for the navigation bar, use options.size: Screen.MINIMUM_NAVBAR_ICON_SIZE

@author Chris Malley (PixelZoom, Inc.)

Class ScreenIcon¶

import { ScreenIcon } from 'scenerystack/sim';

Constructor¶

new ScreenIcon( iconNode : Node, providedOptions? : ScreenIconOptions )¶

Instance Methods¶

dispose()¶

Type ScreenIconOptions¶

import type { ScreenIconOptions } from 'scenerystack/sim';

size?: Dimension2
maxIconWidthProportion?: number
maxIconHeightProportion?: number
fill?: TColor
stroke?: TColor
& StrictOmit<NodeOptions, "children">

Source Code¶

See the source for ScreenIcon.ts in the joist repository.