Skip to content

SVGGradientStop

Under Construction

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

Overview

Handles creation of an SVG stop element, and handles keeping it updated based on property/color changes.

@author Jonathan Olson <jonathan.olson@colorado.edu>

Class SVGGradientStop

import { SVGGradientStop } from 'scenerystack/scenery';

Constructor

new SVGGradientStop( svgGradient : ActiveSVGGradient, ratio : number, color : TColor )

Instance Methods

isActiveSVGGradientStop() : this is ActiveSVGGradientStop

initialize( svgGradient : ActiveSVGGradient, ratio : number, color : TColor ) : this

update()

Updates the color stop to whatever the current color should be.

dispose()

Disposes, so that it can be reused from the pool.

freeToPool()

Instance Properties

svgElement : SVGStopElement

persistent

svgGradient : ActiveSVGGradient | null

transient

color : TColor

ratio : number

Static Properties

pool : Pool

(readonly)

Type ActiveSVGGradientStop

import type { ActiveSVGGradientStop } from 'scenerystack/scenery';

WithoutNull<SVGGradientStop, "svgGradient">

Source Code

See the source for SVGGradientStop.ts in the scenery repository.