Class Path

Hierarchy (view full)

ColoredShapeBase
- Path

Index

Constructors

Properties

Methods

center collapse corner dispose flagReset getBoundingBox getPointAt hasBoundingBox hide noFill noStroke plot render show subdivide update viewee

Constructors

constructor

new Path(owner, vertices?, closed?, curved?, manual?, options?): Path
Parameters
- owner: Board
- vertices: Anchor[] = []
  A list of Anchors that represent the order and coordinates to construct the rendered shape.
- Optionalclosed: boolean
  Describes whether the path is closed or open.
- Optionalcurved: boolean
  Describes whether the path automatically calculates bezier handles for each vertex.
- Optionalmanual: boolean
  Describes whether the developer controls how vertices are plotted.
- options: PathOptions = {}
Returns Path
Overrides ColoredShapeBase.constructor
- Defined in Path.ts:92

Properties

`Readonly`board

board: Board

parent

parent: unknown

`Readonly`zzz

zzz: ZZZ = ...

Accessors

automatic

get automatic(): boolean
Returns boolean
- Defined in Path.ts:753
set automatic(automatic): void
Parameters
- automatic: boolean
Returns void
- Defined in Path.ts:756

beginning

get beginning(): number
Returns number
- Defined in Path.ts:769
set beginning(beginning): void
Parameters
- beginning: number
Returns void
- Defined in Path.ts:772

cap

get cap(): "butt" | "round" | "square"
Defines the shape to be used at the end of open subpaths when they are stroked.

Returns "butt" | "round" | "square"
See
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
- Defined in Path.ts:779
set cap(cap): void
Parameters
- cap: "butt" | "round" | "square"
Returns void
- Defined in Path.ts:782

closed

get closed(): boolean
Returns boolean
- Defined in Path.ts:785
set closed(closed): void
Parameters
- closed: boolean
Returns void
- Defined in Path.ts:788

curved

get curved(): boolean
Returns boolean
- Defined in Path.ts:793
set curved(curved): void
Parameters
- curved: boolean
Returns void
- Defined in Path.ts:796

dashes

get dashes(): number[]
Array of numbers. Odd indices represent dash length. Even indices represent dash space. A list of numbers that represent the repeated dash length and dash space applied to the stroke of the text.

Returns number[]
See
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray for more information on the SVG stroke-dasharray attribute.
Inherited from ColoredShapeBase.dashes
- Defined in ColoredShapeBase.ts:86
set dashes(dashes): void
Parameters
- dashes: number[]
Returns void
Inherited from ColoredShapeBase.dashes
- Defined in ColoredShapeBase.ts:89

ending

get ending(): number
Returns number
- Defined in Path.ts:801
set ending(ending): void
Parameters
- ending: number
Returns void
- Defined in Path.ts:804

fillColor

get fillColor(): Color
Returns Color
Inherited from ColoredShapeBase.fillColor
- Defined in ColoredShapeBase.ts:94
set fillColor(fill): void
Parameters
- fill: Color
Returns void
Inherited from ColoredShapeBase.fillColor
- Defined in ColoredShapeBase.ts:97

fillOpacity

get fillOpacity(): number
Returns number
Inherited from ColoredShapeBase.fillOpacity
- Defined in ColoredShapeBase.ts:101
set fillOpacity(fillOpacity): void
Parameters
- fillOpacity: number
Returns void
Inherited from ColoredShapeBase.fillOpacity
- Defined in ColoredShapeBase.ts:104

id

get id(): string
Returns string
Inherited from ColoredShapeBase.id
- Defined in element.ts:25
set id(id): void
Parameters
- id: string
Returns void
Inherited from ColoredShapeBase.id
- Defined in element.ts:28

join

get join():
    | "round"
    | "arcs"
    | "bevel"
    | "miter"
    | "miter-clip"
Returns
    | "round"
    | "arcs"
    | "bevel"
    | "miter"
    | "miter-clip"
- Defined in Path.ts:807
set join(join): void
Parameters
- join:
      | "round"
      | "arcs"
      | "bevel"
      | "miter"
      | "miter-clip"
Returns void
- Defined in Path.ts:810

length

get length(): number
Returns number
- Defined in Path.ts:813

lengths

get lengths(): number[]
Returns number[]
- Defined in Path.ts:816

mask

get mask(): Shape
Returns Shape
Inherited from ColoredShapeBase.mask
- Defined in ShapeBase.ts:326
set mask(mask): void
Parameters
- mask: Shape
Returns void
Inherited from ColoredShapeBase.mask
- Defined in ShapeBase.ts:329

matrix

get matrix(): Matrix
Returns Matrix
Inherited from ColoredShapeBase.matrix
- Defined in ShapeBase.ts:336

miterLimit

get miterLimit(): number
Returns number
- Defined in Path.ts:819
set miterLimit(miterlimit): void
Parameters
- miterlimit: number
Returns void
- Defined in Path.ts:822

opacity

get opacity(): number
Returns number
Inherited from ColoredShapeBase.opacity
- Defined in ShapeBase.ts:340
set opacity(opacity): void
Parameters
- opacity: number
Returns void
Inherited from ColoredShapeBase.opacity
- Defined in ShapeBase.ts:343

plumb

get plumb(): boolean
Returns boolean
Inherited from ColoredShapeBase.plumb
- Defined in ShapeBase.ts:273
set plumb(plumb): void
Parameters
- plumb: boolean
Returns void
Inherited from ColoredShapeBase.plumb
- Defined in ShapeBase.ts:276

R

get R(): G20
Returns G20
Inherited from ColoredShapeBase.R
- Defined in ShapeBase.ts:279
set R(R): void
Parameters
- R: G20
Returns void
Inherited from ColoredShapeBase.R
- Defined in ShapeBase.ts:282

scale

get scale(): number
Returns number
Inherited from ColoredShapeBase.scale
- Defined in ShapeBase.ts:287
set scale(scale): void
Parameters
- scale: number | [sx: number, sy: number]
Returns void
Inherited from ColoredShapeBase.scale
- Defined in ShapeBase.ts:295

skewX

get skewX(): number
Returns number
Inherited from ColoredShapeBase.skewX
- Defined in ShapeBase.ts:314
set skewX(skewX): void
Parameters
- skewX: number
Returns void
Inherited from ColoredShapeBase.skewX
- Defined in ShapeBase.ts:317

skewY

get skewY(): number
Returns number
Inherited from ColoredShapeBase.skewY
- Defined in ShapeBase.ts:320
set skewY(skewY): void
Parameters
- skewY: number
Returns void
Inherited from ColoredShapeBase.skewY
- Defined in ShapeBase.ts:323

strokeColor

get strokeColor(): Color
Returns Color
Inherited from ColoredShapeBase.strokeColor
- Defined in ColoredShapeBase.ts:107
set strokeColor(stroke): void
Parameters
- stroke: Color
Returns void
Inherited from ColoredShapeBase.strokeColor
- Defined in ColoredShapeBase.ts:110

strokeOpacity

get strokeOpacity(): number
Returns number
Inherited from ColoredShapeBase.strokeOpacity
- Defined in ColoredShapeBase.ts:114
set strokeOpacity(strokeOpacity): void
Parameters
- strokeOpacity: number
Returns void
Inherited from ColoredShapeBase.strokeOpacity
- Defined in ColoredShapeBase.ts:117

strokeWidth

get strokeWidth(): number
Returns number
Inherited from ColoredShapeBase.strokeWidth
- Defined in ColoredShapeBase.ts:120
set strokeWidth(strokeWidth): void
Parameters
- strokeWidth: number
Returns void
Inherited from ColoredShapeBase.strokeWidth
- Defined in ColoredShapeBase.ts:123

sx

get sx(): number
Returns number
Inherited from ColoredShapeBase.sx
- Defined in ShapeBase.ts:302
set sx(sx): void
Parameters
- sx: number
Returns void
Inherited from ColoredShapeBase.sx
- Defined in ShapeBase.ts:305

sy

get sy(): number
Returns number
Inherited from ColoredShapeBase.sy
- Defined in ShapeBase.ts:308
set sy(sy): void
Parameters
- sy: number
Returns void
Inherited from ColoredShapeBase.sy
- Defined in ShapeBase.ts:311

vectorEffect

get vectorEffect():
    | "none"
    | "non-scaling-stroke"
    | "non-scaling-size"
    | "non-rotation"
    | "fixed-position"
Returns
    | "none"
    | "non-scaling-stroke"
    | "non-scaling-size"
    | "non-rotation"
    | "fixed-position"
Inherited from ColoredShapeBase.vectorEffect
- Defined in ColoredShapeBase.ts:132
set vectorEffect(vectorEffect): void
Parameters
- vectorEffect:
      | "none"
      | "non-scaling-stroke"
      | "non-scaling-size"
      | "non-rotation"
      | "fixed-position"
Returns void
Inherited from ColoredShapeBase.vectorEffect
- Defined in ColoredShapeBase.ts:135

vertices

get vertices(): Collection<Anchor>
Returns Collection<Anchor>
- Defined in Path.ts:825
set vertices(vertices): void
Parameters
- vertices: Collection<Anchor>
Returns void
- Defined in Path.ts:828

visibility

get visibility(): "visible" | "hidden" | "collapse"
Returns "visible" | "hidden" | "collapse"
Inherited from ColoredShapeBase.visibility
- Defined in ShapeBase.ts:352
set visibility(visible): void
Parameters
- visible: "visible" | "hidden" | "collapse"
Returns void
Inherited from ColoredShapeBase.visibility
- Defined in ShapeBase.ts:355

worldMatrix

get worldMatrix(): Matrix
Returns Matrix
Inherited from ColoredShapeBase.worldMatrix
- Defined in ShapeBase.ts:374
set worldMatrix(worldMatrix): void
Parameters
- worldMatrix: Matrix
Returns void
Inherited from ColoredShapeBase.worldMatrix
- Defined in ShapeBase.ts:379

X

get X(): G20
Returns G20
Inherited from ColoredShapeBase.X
- Defined in ShapeBase.ts:254
set X(X): void
Parameters
- X: G20 | [x: number, y: number] | {
  x: number;
  y: number;
  }
Returns void
Inherited from ColoredShapeBase.X
- Defined in ShapeBase.ts:257

Methods

center

center(): this
Returns this
- Defined in Path.ts:229

collapse

collapse(): this
Returns this
Inherited from ColoredShapeBase.collapse
- Defined in ShapeBase.ts:370

corner

corner(): Path
Returns Path
- Defined in Path.ts:248

dispose

dispose(): void
Returns void
Inherited from ColoredShapeBase.dispose
- Defined in ShapeBase.ts:158

flagReset

flagReset(dirtyFlag?): this
Parameters
- dirtyFlag: boolean = false
Returns this
- Defined in Path.ts:747

getBoundingBox

getBoundingBox(shallow?): {
    bottom?: number;
    left?: number;
    right?: number;
    top?: number;
}
Parameters
- Optionalshallow: boolean
Returns {
    bottom?: number;
    left?: number;
    right?: number;
    top?: number;
}
- Optionalbottom?: number
- Optionalleft?: number
- Optionalright?: number
- Optionaltop?: number
Overrides ColoredShapeBase.getBoundingBox
- Defined in Path.ts:275

getPointAt

getPointAt(t, anchor): Anchor
TODO: Bad name. This function is called for its side effects which are to modify the Anchor. Originally the function appears to promote a Vector and return an Anchor, but this is not used and the call always involves an Anchor. There is a return value but it is not being used.
Parameters
- t: number
  Percentage value describing where on the Path to estimate and assign coordinate values.
- anchor: Anchor
  Object to apply calculated x, y to. If none available returns new Object.
Returns Anchor
Description
Given a float t from 0 to 1, return a point or assign a passed obj's coordinates to that percentage on this Path's curve.
- Defined in Path.ts:367

hasBoundingBox

hasBoundingBox(): boolean
Returns boolean
Overrides ColoredShapeBase.hasBoundingBox
- Defined in Path.ts:354

hide

hide(): this
Returns this
Inherited from ColoredShapeBase.hide
- Defined in ShapeBase.ts:366

noFill

noFill(): this
A convenience method for setting the fill attribute to "none".

Returns this
Inherited from ColoredShapeBase.noFill
- Defined in ColoredShapeBase.ts:141

noStroke

noStroke(): this
A convenience method for setting the stroke attribute to "none".

Returns this
Inherited from ColoredShapeBase.noStroke
- Defined in ColoredShapeBase.ts:149

plot

plot(): this
Based on closed / curved and sorting of vertices, plot where all points should be and where the respective handles should be too.

Returns this
- Defined in Path.ts:500

render

render<T>(viewDOM, parentElement, svgElement): void
Type Parameters
- T
Parameters
- viewDOM: ViewDOM<T>
- parentElement: T
- svgElement: T
Returns void
Overrides ColoredShapeBase.render
- Defined in Path.ts:140

show

show(): this
Returns this
Inherited from ColoredShapeBase.show
- Defined in ShapeBase.ts:362

subdivide

subdivide(limit): this
Insert an anchor at the midpoint between every vertex.
Parameters
- limit: number
  How many times to recurse subdivisions.
Returns this
- Defined in Path.ts:517

update

update(): this
Returns this
Overrides ColoredShapeBase.update
- Defined in Path.ts:741

viewee

viewee(): unknown
Returns unknown
Inherited from ColoredShapeBase.viewee
- Defined in ShapeBase.ts:250

Class Path

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Path

Properties

Readonlyboard

parent

Readonlyzzz

Accessors

automatic

Returns boolean

Parameters

Returns void

beginning

Returns number

Parameters

Returns void

cap

Returns "butt" | "round" | "square"

See

Parameters

Returns void

closed

Returns boolean

Parameters

Returns void

curved

Returns boolean

Parameters

Returns void

dashes

Returns number[]

See

Parameters

Returns void

ending

Returns number

Parameters

Returns void

fillColor

Returns Color

Parameters

Returns void

fillOpacity

Returns number

Parameters

Returns void

id

Returns string

Parameters

Returns void

join

Returns | "round" | "arcs" | "bevel" | "miter" | "miter-clip"

Parameters

Returns void

length

Returns number

lengths

Returns number[]

mask

Returns Shape

Parameters

Returns void

matrix

Returns Matrix

miterLimit

Returns number

Parameters

Returns void

opacity

Returns number

Parameters

Returns void

`Readonly`board

`Readonly`zzz

Returns
| "round"
| "arcs"
| "bevel"
| "miter"
| "miter-clip"

Returns
| "none"
| "non-scaling-stroke"
| "non-scaling-size"
| "non-rotation"
| "fixed-position"