Class Path<O>

Open or closed polyline through a reactive list of Points.

path(start, opts?).to(p2).to(p3) — fluent (preferred) new Path([p1, p2, p3], opts?) — explicit array

Extension methods (to/u/d/l/r/offset/along) mutate in place and return this. The d attribute and all sampling methods react to point changes automatically.

Type Parameters

O extends PathOpts = PathOpts

Hierarchy

Shape<O>
- Path (View Summary)

Index

Accessors

bottom

get bottom(): Writable<Vec>
Returns Writable<Vec>
Inherited from Shape.bottom
- Defined in src/shapes/shape.ts:110

center

get center(): Writable<Vec>
Lens-backed parent-frame anchors; writes shift translate.

Returns Writable<Vec>
Inherited from Shape.center
- Defined in src/shapes/shape.ts:104

left

get left(): Writable<Vec>
Returns Writable<Vec>
Inherited from Shape.left
- Defined in src/shapes/shape.ts:113

points

get points(): readonly Vec[]
Untracked snapshot of the points list.

Returns readonly Vec[]
- Defined in src/shapes/path.ts:181

right

get right(): Writable<Vec>
Returns Writable<Vec>
Inherited from Shape.right
- Defined in src/shapes/shape.ts:116

svgRoot

get svgRoot(): SVGSVGElement | null
Nearest enclosing <svg> root, or null if this shape isn't mounted under one. Used by drag helpers that need world-space cursor coords.

Returns SVGSVGElement | null
Inherited from Shape.svgRoot
- Defined in src/shapes/shape.ts:360

top

get top(): Writable<Vec>
Returns Writable<Vec>
Inherited from Shape.top
- Defined in src/shapes/shape.ts:107

Constructors

constructor

new Path<O extends PathOpts = PathOpts>(
start?: Vec | readonly Vec[],
opts?: O,
): Path<O>
Type Parameters
- O extends PathOpts = PathOpts
Parameters
- start: Vec | readonly Vec[] = []
- opts: O = ...
Returns Path<O>
Overrides Shape.constructor
- Defined in src/shapes/path.ts:121

Methods

add

add<T extends AnyShape>(child: T): T
Type Parameters
- T extends AnyShape
Parameters
- child: T
Returns T
Inherited from Shape.add
- Defined in src/shapes/shape.ts:371
add<T extends AnyShape[]>(...children: T): T
Type Parameters
- T extends AnyShape[]
Parameters
- ...children: T
Returns T
Inherited from Shape.add
- Defined in src/shapes/shape.ts:372

along

along(angle: Val<number>, dist: Val<number>): Path<O>
Walk dist at angle (radians, y-down).
Parameters
- angle: Val<number>
- dist: Val<number>
Returns Path<O>
- Defined in src/shapes/path.ts:218

at

at(u: number, v: number): Writable<Vec>
Parameters
- u: number
- v: number
Returns Writable<Vec>
Inherited from Shape.at
- Defined in src/shapes/shape.ts:119

attr

attr(
    name: string,
    val: Val<string | number>,
    target?: "intrinsic" | "wrapper",
): void
Bind one SVG attribute; static sets once, reactive runs as effect.
Parameters
- name: string
- val: Val<string | number>
- target: "intrinsic" | "wrapper" = "intrinsic"
Returns void
Inherited from Shape.attr
- Defined in src/shapes/shape.ts:246

attrs

attrs(
map: Record<string, Val<string | number>>,
target?: "intrinsic" | "wrapper",
): void
Bind several attributes at once — this.attrs({ cx, cy, r }).
Parameters
- map: Record<string, Val<string | number>>
- target: "intrinsic" | "wrapper" = "intrinsic"
Returns void
Inherited from Shape.attrs
- Defined in src/shapes/shape.ts:260

boundary

boundary(toward: Vec): Vec
Parent-frame perimeter point toward target; tighter shapes override.
Parameters
- toward: Vec
Returns Vec
Inherited from Shape.boundary
- Defined in src/shapes/shape.ts:203

clear

clear(): void
Returns void
Inherited from Shape.clear
- Defined in src/shapes/shape.ts:397

d

d(n: Val<number>): Path<O>
Step n down from the last vertex.
Parameters
- n: Val<number>
Returns Path<O>
- Defined in src/shapes/path.ts:203

dispose

dispose(): void
Returns void
Inherited from Shape.dispose
- Defined in src/shapes/shape.ts:404

effect

effect(fn: () => void): void
Reactive effect torn down with the shape.
Parameters
- fn: () => void
Returns void
Inherited from Shape.effect
- Defined in src/shapes/shape.ts:313

l

l(n: Val<number>): Path<O>
Step n left from the last vertex.
Parameters
- n: Val<number>
Returns Path<O>
- Defined in src/shapes/path.ts:207

offset

offset(dx: Val<number>, dy: Val<number>): Path<O>
Parameters
- dx: Val<number>
- dy: Val<number>
Returns Path<O>
- Defined in src/shapes/path.ts:214

on

on(
    name: string,
    handler: (e: Event) => void,
    opts?: AddEventListenerOptions,
): () => void
Parameters
- name: string
- handler: (e: Event) => void
- Optionalopts: AddEventListenerOptions
Returns () => void
Inherited from Shape.on
- Defined in src/shapes/shape.ts:317

r

r(n: Val<number>): Path<O>
Step n right from the last vertex.
Parameters
- n: Val<number>
Returns Path<O>
- Defined in src/shapes/path.ts:211

remove

remove(...toRemove: AnyShape[]): void
Parameters
- ...toRemove: AnyShape[]
Returns void
Inherited from Shape.remove
- Defined in src/shapes/shape.ts:384

segments

segments(): Segment[]
Stroke segments for the dashed renderer; default = bounding rect.

Returns Segment[]
Overrides Shape.segments
- Defined in src/shapes/path.ts:229

stroke

stroke(
    opts: CommonOpts,
    closed: boolean,
    nativeAttrs?: Record<string, Val<string | number>>,
): void
Wire stroke / fill / dashed for a stroked shape. nativeAttrs binds the shape's native geometry (e.g. {cx, cy, r} for circle); it's skipped when opts.dashed since the intrinsic is then a <path> whose d is driven by segments().
Parameters
- opts: CommonOpts
- closed: boolean
- OptionalnativeAttrs: Record<string, Val<string | number>>
Returns void
Inherited from Shape.stroke
- Defined in src/shapes/shape.ts:271

to

to(p: Vec): this
Parameters
- p: Vec
Returns this
- Defined in src/shapes/path.ts:195

toLocal

toLocal(evt: { clientX: number; clientY: number }): V
Map client coords into this shape's local frame.
Parameters
- evt: { clientX: number; clientY: number }
Returns V
Inherited from Shape.toLocal
- Defined in src/shapes/shape.ts:334

toWorld

toWorld(evt: { clientX: number; clientY: number }): V
Map client coords into the SVG root's frame; stable under rotation (unlike toLocal). Returns (0, 0) when detached.
Parameters
- evt: { clientX: number; clientY: number }
Returns V
Inherited from Shape.toWorld
- Defined in src/shapes/shape.ts:347

track

track(dispose: () => void): void
Register a disposer to run on dispose().
Parameters
- dispose: () => void
Returns void
Inherited from Shape.track
- Defined in src/shapes/shape.ts:308

u

u(n: Val<number>): Path<O>
Step n up from the last vertex.
Parameters
- n: Val<number>
Returns Path<O>
- Defined in src/shapes/path.ts:199

until

until(name: string): Animator<Event>
Wake on the next name event; resume with the event.
Parameters
- name: string
Returns Animator<Event>
Inherited from Shape.until
- Defined in src/shapes/shape.ts:326

Properties

`Readonly`angleAt

angleAt: (t: Val<number>) => Cell<number>

`Readonly`aside

aside: boolean

`Readonly`atDistance

atDistance: (d: Val<number>) => Vec

`Readonly`box

box: Box

Local-frame box; reach into .x, .center, .at(u,v), etc.

`Readonly`closed

closed: boolean

`Readonly`el

el: SVGGElement

`Optional` `Readonly`intrinsic

intrinsic?: SVGElement

`Readonly`length

length: Cell<number>

`Readonly`localFrame

localFrame: Cell<V>

Composed local-frame matrix: T(t) T(p) R(r) S(s) T(-p).

`Readonly`normalAt

normalAt: (t: Val<number>) => Vec

`Readonly`opacity

opacity: Writable<Num>

`Readonly`origin

origin: Writable<Vec>

parent

parent: AnyShape | null = null

Back-link set by add(); cleared by dispose(). Non-reactive.

`Readonly`pointAt

pointAt: (t: Val<number>) => Vec

Sample at t ∈ [0, 1]. Named to avoid shadowing the Box at(u, v) anchor — same symmetry as tangentAt / normalAt / angleAt.

`Readonly`rotate

rotate: Writable<Num>

`Readonly`scale

scale: Writable<Vec>

`Readonly`tangentAt

tangentAt: (t: Val<number>) => Vec

`Readonly`translate

translate: Writable<Vec>

Class Path<O>

Type Parameters

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

bottom

Returns Writable<Vec>

center

Returns Writable<Vec>

left

Returns Writable<Vec>

points

Returns readonly Vec[]

right

Returns Writable<Vec>

svgRoot

Returns SVGSVGElement | null

top

Returns Writable<Vec>

Constructors

constructor

Type Parameters

Parameters

Returns Path<O>

Methods

add

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

along

Parameters

Returns Path<O>

at

Parameters

Returns Writable<Vec>

attr

Parameters

Returns void

attrs

Parameters

Returns void

boundary

Parameters

Returns Vec

clear

Returns void

d

Parameters

Returns Path<O>

dispose

Returns void

effect

Parameters

Returns void

l

Parameters

Returns Path<O>

offset

Parameters

Returns Path<O>

on

Parameters

Returns () => void

r

Parameters

Returns Path<O>

remove

Parameters

Returns void

segments

Returns Segment[]

stroke

Parameters

`Readonly`angleAt

`Readonly`aside

`Readonly`atDistance

`Readonly`box

`Readonly`closed

`Readonly`el

`Optional` `Readonly`intrinsic

`Readonly`length

`Readonly`localFrame

`Readonly`normalAt

`Readonly`opacity

`Readonly`origin

`Readonly`pointAt

`Readonly`rotate

`Readonly`scale

`Readonly`tangentAt

`Readonly`translate