Paint

Documentation / @elitechart/core / Paint

Minimal paint surface. Implementations must be deterministic given the same call sequence. Plugins draw through Paint, never raw Canvas, so a future WebGL backend can satisfy the same interface.

Example

code

import type { OverlayFn } from '@elitechart/core';
const drawHi: OverlayFn = (paint, vp, bars) => {
  const last = bars[bars.length - 1];
  if (last === undefined) return;
  paint.fillRect(vp.plotLeft, vp.priceToY(last.high) - 1, vp.plotWidth, 2, '#26a69a');
};

Methods

beginPath()

code

beginPath(): void;

Defined in: paint/types.ts:72

Begin a new path.

Returns

void

clear()

code

clear(rect): void;

Defined in: paint/types.ts:95

Clear a region to transparent.

Parameters

rect

Rect

Returns

void

clipTo()

code

clipTo(rect): void;

Defined in: paint/types.ts:91

Parameters

rect

Rect

Returns

void

fill()

code

fill(color): void;

Defined in: paint/types.ts:78

Fill current path or rect with color.

Parameters

color

string

Returns

void

fillRect()

code

fillRect(
   x, 
   y, 
   w, 
   h, 
   color): void;

Defined in: paint/types.ts:82

Convenience: fill a rect in one call.

Parameters

x

number

y

number

w

number

h

number

color

string

Returns

void

lineTo()

code

lineTo(x, y): void;

Defined in: paint/types.ts:74

Parameters

x

number

y

number

Returns

void

measureText()

code

measureText(str, font?): number;

Defined in: paint/types.ts:88

Measure the pixel width of str under the given font. Cached by the impl.

Parameters

str

string

font?

string

Returns

number

moveTo()

code

moveTo(x, y): void;

Defined in: paint/types.ts:73

Parameters

x

number

y

number

Returns

void

rect()

code

rect(
   x, 
   y, 
   w, 
   h): void;

Defined in: paint/types.ts:76

Draw an axis-aligned rectangle outline or fill (depends on subsequent call).

Parameters

x

number

y

number

w

number

h

number

Returns

void

restore()

code

restore(): void;

Defined in: paint/types.ts:93

Restore state from the most recent save.

Returns

void

save()

code

save(): void;

Defined in: paint/types.ts:90

Clip subsequent draws to rect until restore is called.

Returns

void

stroke()

code

stroke(color, opts?): void;

Defined in: paint/types.ts:80

Stroke current path with color.

Parameters

color

string

opts?

StrokeOpts

Returns

void

strokeRect()

code

strokeRect(
   x, 
   y, 
   w, 
   h, 
   color, 
   opts?): void;

Defined in: paint/types.ts:84

Convenience: stroke a rect in one call.

Parameters

x

number

y

number

w

number

h

number

color

string

opts?

StrokeOpts

Returns

void

text()

code

text(
   str, 
   x, 
   y, 
   opts?): void;

Defined in: paint/types.ts:86

Draw text.

Parameters

str

string

x

number

y

number

opts?

TextOpts

Returns

void