Skip to content

CanvasGridLineSet¶

Under Construction

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

Overview¶

Copy/paste of GridLineSet that renders to canvas. Note, these 2 files should be maintained together, to keep as similar an API as possible.

@author Sam Reid (PhET Interactive Simulations)

Class CanvasGridLineSet¶

import { CanvasGridLineSet } from 'scenerystack/bamboo';

Constructor¶

new CanvasGridLineSet( chartTransform : ChartTransform, axisOrientation : Orientation, spacing : number, providedOptions? : CanvasGridLineSetOptions )¶

Instance Methods¶

setSpacing( spacing : number )¶

setLineDashOffset( lineDashOffset : number )¶

paintCanvas( context : CanvasRenderingContext2D )¶

Type CanvasGridLineSetOptions¶

import type { CanvasGridLineSetOptions } from 'scenerystack/bamboo';

origin?: number
clippingType?: ClippingType
stroke?: string | CanvasGradient | CanvasPattern
& PickOptional<PathOptions, "lineWidth" | "lineDash" | "lineDashOffset"> & CanvasPainterOptions

Source Code¶

See the source for CanvasGridLineSet.ts in the bamboo repository.