Class Polygon

Readonlyboard

parent

Readonlyzzz

automatic

• get automatic(): boolean

• Returns boolean

• set automatic(automatic): void

• Parameters

  • automatic: boolean

  Returns void

beginning

• get beginning(): number

• Returns number

• set beginning(beginning): void

• Parameters

  • beginning: number

  Returns void

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

• set cap(cap): void

• Parameters

  • cap: "butt" | "round" | "square"

  Returns void

closed

• get closed(): boolean

• Returns boolean

• set closed(closed): void

• Parameters

  • closed: boolean

  Returns void

curved

• get curved(): boolean

• Returns boolean

• set curved(curved): void

• Parameters

  • curved: boolean

  Returns void

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.

• set dashes(dashes): void

• Parameters

  • dashes: number[]

  Returns void

ending

• get ending(): number

• Returns number

• set ending(ending): void

• Parameters

  • ending: number

  Returns void

fillColor

• get fillColor(): Color

• Returns Color

• set fillColor(fill): void

• Parameters

  • fill: Color

  Returns void

fillOpacity

• get fillOpacity(): number

• Returns number

• set fillOpacity(fillOpacity): void

• Parameters

  • fillOpacity: number

  Returns void

id

• get id(): string

• Returns string

• set id(id): void

• Parameters

  • id: string

  Returns void

join

• get join():
      | "round"
      | "arcs"
      | "bevel"
      | "miter"
      | "miter-clip"

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

• set join(join): void

• Parameters

  • join:
        | "round"
        | "arcs"
        | "bevel"
        | "miter"
        | "miter-clip"

  Returns void

length

• get length(): number

• Returns number

lengths

• get lengths(): number[]

• Returns number[]

mask

• get mask(): Shape

• Returns Shape

• set mask(mask): void

• Parameters

  • mask: Shape

  Returns void

matrix

• get matrix(): Matrix

• Returns Matrix

miterLimit

• get miterLimit(): number

• Returns number

• set miterLimit(miterlimit): void

• Parameters

  • miterlimit: number

  Returns void

opacity

• get opacity(): number

• Returns number

• set opacity(opacity): void

• Parameters

  • opacity: number

  Returns void

plumb

• get plumb(): boolean

• Returns boolean

• set plumb(plumb): void

• Parameters

  • plumb: boolean

  Returns void

R

• get R(): G20

• Returns G20

• set R(R): void

• Parameters

  • R: G20

  Returns void

scale

• get scale(): number

• Returns number

• set scale(scale): void

• Parameters

  • scale: number | [sx: number, sy: number]

  Returns void

skewX

• get skewX(): number

• Returns number

• set skewX(skewX): void

• Parameters

  • skewX: number

  Returns void

skewY

• get skewY(): number

• Returns number

• set skewY(skewY): void

• Parameters

  • skewY: number

  Returns void

strokeColor

• get strokeColor(): Color

• Returns Color

• set strokeColor(stroke): void

• Parameters

  • stroke: Color

  Returns void

strokeOpacity

• get strokeOpacity(): number

• Returns number

• set strokeOpacity(strokeOpacity): void

• Parameters

  • strokeOpacity: number

  Returns void

strokeWidth

• get strokeWidth(): number

• Returns number

• set strokeWidth(strokeWidth): void

• Parameters

  • strokeWidth: number

  Returns void

sx

• get sx(): number

• Returns number

• set sx(sx): void

• Parameters

  • sx: number

  Returns void

sy

• get sy(): number

• Returns number

• set sy(sy): void

• Parameters

  • sy: number

  Returns void

vectorEffect

• get vectorEffect():
      | "non-scaling-stroke"
      | "non-scaling-size"
      | "non-rotation"
      | "fixed-position"
      | "none"

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

• set vectorEffect(vectorEffect): void

• Parameters

  • vectorEffect:
        | "non-scaling-stroke"
        | "non-scaling-size"
        | "non-rotation"
        | "fixed-position"
        | "none"

  Returns void

vertices

• get vertices(): Collection<Anchor>

• Returns Collection<Anchor>

• set vertices(vertices): void

• Parameters

  • vertices: Collection<Anchor>

  Returns void

visibility

• get visibility(): "hidden" | "visible" | "collapse"

• Returns "hidden" | "visible" | "collapse"

• set visibility(visible): void

• Parameters

  • visible: "hidden" | "visible" | "collapse"

  Returns void

worldMatrix

• get worldMatrix(): Matrix

• Returns Matrix

• set worldMatrix(worldMatrix): void

• Parameters

  • worldMatrix: Matrix

  Returns void

X

• get X(): G20

• Returns G20

• set X(X): void

• Parameters

  • X: G20 | [x: number, y: number] | {
        x: number;
        y: number;
    }

  Returns void

center

• center(): this

• Returns this

collapse

• collapse(): this

• Returns this

corner

• corner(): this

• Returns this

dispose

• dispose(): void

• Returns void

flagReset

• flagReset(dirtyFlag?): this

• Parameters

  • OptionaldirtyFlag: boolean

  Returns this

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

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.

hasBoundingBox

• hasBoundingBox(): boolean

• Returns boolean

hide

• hide(): this

• Returns this

noFill

• noFill(): this

• A convenience method for setting the fill attribute to "none".

  Returns this

noStroke

• noStroke(): this

• A convenience method for setting the stroke attribute to "none".

  Returns this

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

render

• render<T>(viewDOM, parentElement, svgElement): void

• Type Parameters

  • T

  Parameters

  • viewDOM: ViewDOM<T>
  • parentElement: T
  • svgElement: T

  Returns void

show

• show(): this

• Returns this

subdivide

• subdivide(limit): this

• Insert an anchor at the midpoint between every vertex.

  Parameters

  • limit: number

    How many times to recurse subdivisions.

  Returns this

update

• update(): this

• Returns this

viewee

• viewee(): unknown

• Returns unknown