Brush

Defined in: geometry/Brush.ts:32

GoJS-compatible: a portable, serializable description of a solid color, linear gradient, radial gradient, or pattern fill/stroke — an alternative to a plain CSS color string for Shape.fill/stroke (and anywhere else BrushLike is accepted). Unlike a raw CanvasGradient, a Brush doesn’t need a live canvas context to construct — it’s resolved to one lazily at draw time (see resolveBrushLike in render/BrushResolver.ts).

Constructors

Constructor

new Brush(type?, init?): Brush

Defined in: geometry/Brush.ts:54

Parameters

type?

string | BrushType

one of Brush.Solid/Linear/Radial/Pattern (default Solid).

init?

Partial<Brush> & Record<number, string>

a partial property bag, plus optionally numeric keys ({0: "red", 1: "blue"}) as shorthand for color stops.

Returns

Brush

Properties

HSL

readonly static HSL: 2 = ColorSpace.HSL

Defined in: geometry/Brush.ts:38

---

Lab

readonly static Lab: 1 = ColorSpace.Lab

Defined in: geometry/Brush.ts:37

---

Linear

readonly static Linear: 2 = BrushType.Linear

Defined in: geometry/Brush.ts:34

---

Pattern

readonly static Pattern: 4 = BrushType.Pattern

Defined in: geometry/Brush.ts:36

---

Radial

readonly static Radial: 3 = BrushType.Radial

Defined in: geometry/Brush.ts:35

---

Solid

readonly static Solid: 1 = BrushType.Solid

Defined in: geometry/Brush.ts:33

Accessors

color

Get Signature

get color(): string

Defined in: geometry/Brush.ts:106

Returns

string

Set Signature

set color(value): void

Defined in: geometry/Brush.ts:110

Parameters

value

string

Returns

void

---

colorStops

Get Signature

get colorStops(): Map<number, string> | null

Defined in: geometry/Brush.ts:146

Returns

Map<number, string> | null

Set Signature

set colorStops(value): void

Defined in: geometry/Brush.ts:150

Parameters

value

Map<number, string> | null

Returns

void

---

end

Get Signature

get end(): Spot

Defined in: geometry/Brush.ts:122

Returns

Spot

Set Signature

set end(value): void

Defined in: geometry/Brush.ts:126

Parameters

value

Spot

Returns

void

---

endRadius

Get Signature

get endRadius(): number

Defined in: geometry/Brush.ts:138

Returns

number

Set Signature

set endRadius(value): void

Defined in: geometry/Brush.ts:142

Parameters

value

number

Returns

void

---

pattern

Get Signature

get pattern(): HTMLCanvasElement | HTMLImageElement | null

Defined in: geometry/Brush.ts:154

Returns

HTMLCanvasElement | HTMLImageElement | null

Set Signature

set pattern(value): void

Defined in: geometry/Brush.ts:158

Parameters

value

HTMLCanvasElement | HTMLImageElement | null

Returns

void

---

start

Get Signature

get start(): Spot

Defined in: geometry/Brush.ts:114

Returns

Spot

Set Signature

set start(value): void

Defined in: geometry/Brush.ts:118

Parameters

value

Spot

Returns

void

---

startRadius

Get Signature

get startRadius(): number

Defined in: geometry/Brush.ts:130

Returns

number

Set Signature

set startRadius(value): void

Defined in: geometry/Brush.ts:134

Parameters

value

number

Returns

void

---

type

Get Signature

get type(): BrushType

Defined in: geometry/Brush.ts:98

Returns

BrushType

Set Signature

set type(value): void

Defined in: geometry/Brush.ts:102

Parameters

value

BrushType

Returns

void

Methods

addColorStop()

addColorStop(loc, color): this

Defined in: geometry/Brush.ts:92

GoJS-compatible: add a color stop at fractional location loc (0..1); returns this.

Parameters

loc

number

color

string

Returns

this

---

copy()

copy(): Brush

Defined in: geometry/Brush.ts:79

Returns

Brush

---

darkenBy()

darkenBy(fraction?, _mode?): this

Defined in: geometry/Brush.ts:169

Darken this brush’s solid color in place by fraction (default 0.2); returns this.

Parameters

fraction?

number = 0.2

_mode?

ColorSpace = ColorSpace.Lab

Returns

this

---

isDark()

isDark(): boolean

Defined in: geometry/Brush.ts:175

Whether this brush’s solid color is perceptually dark (ignores gradients/patterns).

Returns

boolean

---

lightenBy()

lightenBy(fraction?, _mode?): this

Defined in: geometry/Brush.ts:163

Lighten this brush’s solid color in place by fraction (default 0.2); returns this.

Parameters

fraction?

number = 0.2

_mode?

ColorSpace = ColorSpace.Lab

Returns

this

---

darken()

static darken(color): string

Defined in: geometry/Brush.ts:209

Parameters

color

string

Returns

string

---

darkenBy()

static darkenBy(color, fraction?, _mode?): string

Defined in: geometry/Brush.ts:213

Parameters

color

string

fraction?

number = 0.2

_mode?

ColorSpace = ColorSpace.Lab

Returns

string

---

isDark()

static isDark(color): boolean

Defined in: geometry/Brush.ts:223

Parameters

color

BrushLike

Returns

boolean

---

isValidColor()

static isValidColor(color): boolean

Defined in: geometry/Brush.ts:188

Parameters

color

string

Returns

boolean

---

lighten()

static lighten(color): string

Defined in: geometry/Brush.ts:201

Parameters

color

string

Returns

string

---

lightenBy()

static lightenBy(color, fraction?, _mode?): string

Defined in: geometry/Brush.ts:205

Parameters

color

string

fraction?

number = 0.2

_mode?

ColorSpace = ColorSpace.Lab

Returns

string

---

mix()

static mix(color1, color2, fraction?): string

Defined in: geometry/Brush.ts:217

Parameters

color1

string

color2

string

fraction?

number = 0.5

Returns

string

---

randomColor()

static randomColor(min?, max?): string

Defined in: geometry/Brush.ts:181

Parameters

min?

number = 0

max?

number = 255

Returns

string