API Docs for: 1.0.0
Show:

Canvas.Context2d Class

Defined in: src/gallery-canvas/js/Context2d.js:15
Module: gallery-canvas

Wrapper for a canvas 2d context. It exposes the exact same api as the native 2d context, plus some extras, documented below. Just like Y.Node, use get() and set() to modify attributes.

Constructor

Canvas.Context2d

(
  • node
  • config
)

Defined in src/gallery-canvas/js/Context2d.js:15

Parameters:

  • node Y.Node

    the canvas element

  • config Object
    • pixelAlign=true Boolean

      Pass true to get thinner, cleaner strokes. Pass false to get the default rendering.

Item Index

Methods

Methods

get

(
  • name
)
Mixed

Defined in src/gallery-canvas/js/Context2d.js:54

Get an attribute. This accepts all attributes of the context and the special name "pixelAlign".

Parameters:

  • name String

    the attribute name

Returns:

Mixed:

the attribute value

line

(
  • dx
  • dy
)

Defined in src/gallery-canvas/js/Context2d.js:125

Move relative to the current pen location. This only works when the transformation matrix is constant!

Parameters:

  • dx Int
  • dy Int

move

(
  • dx
  • dy
)

Defined in src/gallery-canvas/js/Context2d.js:105

Move relative to the current pen location (set via moveTo or move). This only works when the transformation matrix is constant!

Parameters:

  • dx Int
  • dy Int

poly

(
  • list
)

Defined in src/gallery-canvas/js/Context2d.js:202

Draw a polygon from a set of deltas.

Parameters:

  • list Array

    List of deltas (dx,dy). You can omit values that are zero.

roundedRect

(
  • top
  • left
  • bottom
  • right
  • radius
)

Defined in src/gallery-canvas/js/Context2d.js:164

Define a rectangle with rounded corners. You must call stroke(), fill(), etc. afterwards.

Parameters:

  • top Int
  • left Int
  • bottom Int
  • right Int
  • radius Int

    radius of rounded corners

set

(
  • name
  • value
)

Defined in src/gallery-canvas/js/Context2d.js:75

Set an attribute. This accepts all attributes of the context and the special name "pixelAlign".

Parameters:

  • name String

    the attribute name

  • value Mixed

    the attribute value