Class GraphicsBoard<E, T>

constructor

• new GraphicsBoard<E, T>(elementOrId, elementDOM, viewDOM, viewFactory, options?): GraphicsBoard<E, T>

• Type Parameters

  • E
  • T

  Parameters

  • elementOrId: string | E
  • elementDOM: ElementDOM<E, T>
  • viewDOM: ViewDOM<T>
  • viewFactory: ViewFactory<T>
  • options: GraphicsBoardOptions = {}

  Returns GraphicsBoard<E, T>

Readonlydefaults

crazy

• get crazy(): boolean

• Returns boolean

frameCount

• get frameCount(): number

• Returns number

goofy

• get goofy(): boolean

• Returns boolean

height

• get height(): number

• Returns number

• set height(height): void

• Parameters

  • height: number

  Returns void

ratio

• get ratio(): number

• Returns number

• set ratio(ratio): void

• Parameters

  • ratio: number

  Returns void

scene

• get scene(): Group

• Returns Group

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

width

• get width(): number

• Returns number

• set width(width): void

• Parameters

  • width: number

  Returns void

add

• add(...shapes): this

• Parameters

  • Rest...shapes: Shape[]

  Returns this

appendTo

• appendTo(container): this

• Parameters

  • container: E

  Returns this

arc

• arc(options?): ArcSegment

• Parameters

  • options: ArcSegmentOptions = {}

  Returns ArcSegment

arrow

• arrow(axis, options?): Arrow

• Parameters

  • axis: VectorLike
  • options: ArrowOptions = {}

  Returns Arrow

circle

• circle(options?): Circle

• Parameters

  • options: CircleOptions = {}

  Returns Circle

curve

• curve(closed, points, options?): Path

• Parameters

  • closed: boolean
  • points: (G20 | Anchor | [x: number, y: number])[]
  • options: PathOptions = {}

  Returns Path

dispose

• dispose(): void

• Returns void

ellipse

• ellipse(options?): Ellipse

• Parameters

  • options: EllipseOptions = {}

  Returns Ellipse

getBoundingBox

• getBoundingBox(): Readonly<{
      bottom: number;
      left: number;
      right: number;
      top: number;
  }>

• Returns Readonly<{
      bottom: number;
      left: number;
      right: number;
      top: number;
  }>

getElapsedTime

• getElapsedTime(fractionalDigits?): number

• A number representing how much time has elapsed since the last frame in milliseconds.

  Parameters

  • fractionalDigits: number = 3

  Returns number

group

• group(...shapes): Group

• Parameters

  • Rest...shapes: Shape[]

  Returns Group

line

• line(point1, point2, options?): Line

• Parameters

  • point1: VectorLike
  • point2: VectorLike
  • options: LineOptions = {}

  Returns Line

path

• path(closed, points, options?): Path

• Parameters

  • closed: boolean
  • points: (G20 | Anchor | [x: number, y: number])[]
  • options: PathOptions = {}

  Returns Path

point

• point(position, options?): Point

• Parameters

  • position: VectorLike
  • options: PointOptions = {}

  Returns Point

polygon

• polygon(points?, options?): Polygon

• Parameters

  • points: VectorLike[] = []
  • options: PolygonOptions = {}

  Returns Polygon

rectangle

• rectangle(options?): Rectangle

• Parameters

  • options: RectangleOptions = {}

  Returns Rectangle

remove

• remove(...shapes): this

• Parameters

  • Rest...shapes: Shape[]

  Returns this

text

• text(message, options?): Text

• Parameters

  • message: string
  • options: TextOptions = {}

  Returns Text

update

• update(): void

• Update positions and calculations in one pass before rendering.

  Returns void