Path2D

Types

domMatrix2DInit

type domMatrix2DInit = WebAPI.DOM.domMatrix2DInit

Record fields

a

option<float>

b

option<float>

c

option<float>

d

option<float>

e

option<float>

f

option<float>

m11

option<float>

m12

option<float>

m21

option<float>

m22

option<float>

m41

option<float>

m42

option<float>

Values

addPath

Adds to the path the path given by the argument. Read more on MDN

let addPath: (
  WebAPI.CanvasTypes.path2D,
  ~path: WebAPI.CanvasTypes.path2D,
  ~transform: domMatrix2DInit=?,
) => unit

Parameters

WebAPI.CanvasTypes.path2DWebAPI.CanvasTypes.path2Doption<domMatrix2DInit>

Return type

unit

arc

Read more on MDN

let arc: (
  WebAPI.CanvasTypes.path2D,
  ~x: float,
  ~y: float,
  ~radius: float,
  ~startAngle: float,
  ~endAngle: float,
  ~counterclockwise: bool=?,
) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloatfloatfloatfloatoption<bool>

Return type

unit

arcTo

Read more on MDN

let arcTo: (
  WebAPI.CanvasTypes.path2D,
  ~x1: float,
  ~y1: float,
  ~x2: float,
  ~y2: float,
  ~radius: float,
) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloatfloatfloatfloat

Return type

unit

bezierCurveTo

Read more on MDN

let bezierCurveTo: (
  WebAPI.CanvasTypes.path2D,
  ~cp1x: float,
  ~cp1y: float,
  ~cp2x: float,
  ~cp2y: float,
  ~x: float,
  ~y: float,
) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloatfloatfloatfloatfloat

Return type

unit

closePath

Read more on MDN

let closePath: WebAPI.CanvasTypes.path2D => unit

Parameters

WebAPI.CanvasTypes.path2D

Return type

unit

ellipse

Read more on MDN

let ellipse: (
  WebAPI.CanvasTypes.path2D,
  ~x: float,
  ~y: float,
  ~radiusX: float,
  ~radiusY: float,
  ~rotation: float,
  ~startAngle: float,
  ~endAngle: float,
  ~counterclockwise: bool=?,
) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloatfloatfloatfloatfloatfloatoption<bool>

Return type

unit

fromPath2D

fromPath2D(path2D)

Creates a new Path2D by copying another Path2D.

let copiedPath = Path2D.fromPath2D(existingPath)

Read more on MDN

let fromPath2D: WebAPI.CanvasTypes.path2D => WebAPI.CanvasTypes.path2D

Parameters

WebAPI.CanvasTypes.path2D

Return type

WebAPI.CanvasTypes.path2D

fromString

fromString(string)

Creates a new Path2D from SVG path data text.

let path = Path2D.fromString("M0 0 L10 10")

Read more on MDN

let fromString: string => WebAPI.CanvasTypes.path2D

Parameters

string

Return type

WebAPI.CanvasTypes.path2D

lineTo

Read more on MDN

let lineTo: (WebAPI.CanvasTypes.path2D, ~x: float, ~y: float) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloat

Return type

unit

make

make()

Creates a new empty Path2D.

let path = Path2D.make()

Read more on MDN

let make: unit => WebAPI.CanvasTypes.path2D

Parameters

unit

Return type

WebAPI.CanvasTypes.path2D

moveTo

Read more on MDN

let moveTo: (WebAPI.CanvasTypes.path2D, ~x: float, ~y: float) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloat

Return type

unit

quadraticCurveTo

Read more on MDN

let quadraticCurveTo: (
  WebAPI.CanvasTypes.path2D,
  ~cpx: float,
  ~cpy: float,
  ~x: float,
  ~y: float,
) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloatfloatfloat

Return type

unit

rect

Read more on MDN

let rect: (
  WebAPI.CanvasTypes.path2D,
  ~x: float,
  ~y: float,
  ~w: float,
  ~h: float,
) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloatfloatfloat

Return type

unit

roundRect

Read more on MDN

let roundRect: (
  WebAPI.CanvasTypes.path2D,
  ~x: float,
  ~y: float,
  ~w: float,
  ~h: float,
  ~radii_: array<float>=?,
) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloatfloatfloatoption<array<float>>

Return type

unit

roundRect2

Read more on MDN

let roundRect2: (
  WebAPI.CanvasTypes.path2D,
  ~x: float,
  ~y: float,
  ~w: float,
  ~h: float,
  ~radii_: array<float>=?,
) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloatfloatfloatoption<array<float>>

Return type

unit

roundRect3

Read more on MDN

let roundRect3: (
  WebAPI.CanvasTypes.path2D,
  ~x: float,
  ~y: float,
  ~w: float,
  ~h: float,
  ~radii_: array<float>=?,
) => unit

Parameters

WebAPI.CanvasTypes.path2Dfloatfloatfloatfloatoption<array<float>>

Return type

unit