Skip to content

OffscreenCanvasRenderingContext2D ​

class OffscreenCanvasRenderingContext2D extends JavaScriptObject

Annotations: @Native.new("OffscreenCanvasRenderingContext2D")

Properties ​

canvas no setter ​

OffscreenCanvas? get canvas
Implementation
dart
OffscreenCanvas? get canvas native;

direction read / write ​

String? get direction
Implementation
dart
String? get direction native;

set direction(String? value) native;

fillStyle read / write ​

Object? get fillStyle
Implementation
dart
Object? get fillStyle native;

set fillStyle(Object? value) native;

filter read / write ​

String? get filter
Implementation
dart
String? get filter native;

set filter(String? value) native;

font read / write ​

String? get font
Implementation
dart
String? get font native;

set font(String? value) native;

globalAlpha read / write ​

num? get globalAlpha
Implementation
dart
num? get globalAlpha native;

set globalAlpha(num? value) native;

globalCompositeOperation read / write ​

String? get globalCompositeOperation
Implementation
dart
String? get globalCompositeOperation native;

set globalCompositeOperation(String? value) native;

hashCode no setter inherited ​

int get hashCode

Inherited from Interceptor.

Implementation
dart
int get hashCode => Primitives.objectHashCode(this);

imageSmoothingEnabled read / write ​

bool? get imageSmoothingEnabled
Implementation
dart
bool? get imageSmoothingEnabled native;

set imageSmoothingEnabled(bool? value) native;

imageSmoothingQuality read / write ​

String? get imageSmoothingQuality
Implementation
dart
String? get imageSmoothingQuality native;

set imageSmoothingQuality(String? value) native;

lineCap read / write ​

String? get lineCap
Implementation
dart
String? get lineCap native;

set lineCap(String? value) native;

lineDashOffset read / write ​

num? get lineDashOffset
Implementation
dart
num? get lineDashOffset native;

set lineDashOffset(num? value) native;

lineJoin read / write ​

String? get lineJoin
Implementation
dart
String? get lineJoin native;

set lineJoin(String? value) native;

lineWidth read / write ​

num? get lineWidth
Implementation
dart
num? get lineWidth native;

set lineWidth(num? value) native;

miterLimit read / write ​

num? get miterLimit
Implementation
dart
num? get miterLimit native;

set miterLimit(num? value) native;

runtimeType no setter inherited ​

Type get runtimeType

Inherited from Interceptor.

Implementation
dart
Type get runtimeType =>
    getRuntimeTypeOfInterceptorNotArray(getInterceptor(this), this);

shadowBlur read / write ​

num? get shadowBlur
Implementation
dart
num? get shadowBlur native;

set shadowBlur(num? value) native;

shadowColor read / write ​

String? get shadowColor
Implementation
dart
String? get shadowColor native;

set shadowColor(String? value) native;

shadowOffsetX read / write ​

num? get shadowOffsetX
Implementation
dart
num? get shadowOffsetX native;

set shadowOffsetX(num? value) native;

shadowOffsetY read / write ​

num? get shadowOffsetY
Implementation
dart
num? get shadowOffsetY native;

set shadowOffsetY(num? value) native;

strokeStyle read / write ​

Object? get strokeStyle
Implementation
dart
Object? get strokeStyle native;

set strokeStyle(Object? value) native;

textAlign read / write ​

String? get textAlign
Implementation
dart
String? get textAlign native;

set textAlign(String? value) native;

textBaseline read / write ​

String? get textBaseline
Implementation
dart
String? get textBaseline native;

set textBaseline(String? value) native;

Methods ​

arc() ​

void arc(
  num x,
  num y,
  num radius,
  num startAngle,
  num endAngle,
  bool? anticlockwise,
)
Implementation
dart
void arc(
  num x,
  num y,
  num radius,
  num startAngle,
  num endAngle,
  bool? anticlockwise,
) native;

arcTo() ​

void arcTo(num x1, num y1, num x2, num y2, num radius)
Implementation
dart
void arcTo(num x1, num y1, num x2, num y2, num radius) native;

beginPath() ​

void beginPath()
Implementation
dart
void beginPath() native;

bezierCurveTo() ​

void bezierCurveTo(num cp1x, num cp1y, num cp2x, num cp2y, num x, num y)
Implementation
dart
void bezierCurveTo(
  num cp1x,
  num cp1y,
  num cp2x,
  num cp2y,
  num x,
  num y,
) native;

clearRect() ​

void clearRect(num x, num y, num width, num height)
Implementation
dart
void clearRect(num x, num y, num width, num height) native;

clip() ​

void clip([Path2D? path])
Implementation
dart
void clip([Path2D? path]) native;

closePath() ​

void closePath()
Implementation
dart
void closePath() native;

commit() ​

Future<dynamic> commit()
Implementation
dart
Future commit() => promiseToFuture(JS("", "#.commit()", this));

createImageData() ​

ImageData createImageData(
  dynamic data_OR_imagedata_OR_sw, [
  int? sh_OR_sw,
  dynamic imageDataColorSettings_OR_sh,
  Map<dynamic, dynamic>? imageDataColorSettings,
])
Implementation
dart
ImageData createImageData(
  data_OR_imagedata_OR_sw, [
  int? sh_OR_sw,
  imageDataColorSettings_OR_sh,
  Map? imageDataColorSettings,
]) {
  if ((data_OR_imagedata_OR_sw is ImageData) &&
      sh_OR_sw == null &&
      imageDataColorSettings_OR_sh == null &&
      imageDataColorSettings == null) {
    var imagedata_1 = convertDartToNative_ImageData(data_OR_imagedata_OR_sw);
    return convertNativeToDart_ImageData(_createImageData_1(imagedata_1));
  }
  if (sh_OR_sw != null &&
      (data_OR_imagedata_OR_sw is int) &&
      imageDataColorSettings_OR_sh == null &&
      imageDataColorSettings == null) {
    return convertNativeToDart_ImageData(
      _createImageData_2(data_OR_imagedata_OR_sw, sh_OR_sw),
    );
  }
  if ((imageDataColorSettings_OR_sh is Map) &&
      sh_OR_sw != null &&
      (data_OR_imagedata_OR_sw is int) &&
      imageDataColorSettings == null) {
    var imageDataColorSettings_1 = convertDartToNative_Dictionary(
      imageDataColorSettings_OR_sh,
    );
    return convertNativeToDart_ImageData(
      _createImageData_3(
        data_OR_imagedata_OR_sw,
        sh_OR_sw,
        imageDataColorSettings_1,
      ),
    );
  }
  if (imageDataColorSettings != null &&
      (imageDataColorSettings_OR_sh is int) &&
      sh_OR_sw != null &&
      data_OR_imagedata_OR_sw != null) {
    var imageDataColorSettings_1 = convertDartToNative_Dictionary(
      imageDataColorSettings,
    );
    return convertNativeToDart_ImageData(
      _createImageData_4(
        data_OR_imagedata_OR_sw,
        sh_OR_sw,
        imageDataColorSettings_OR_sh,
        imageDataColorSettings_1,
      ),
    );
  }
  throw new ArgumentError("Incorrect number or type of arguments");
}

createLinearGradient() ​

CanvasGradient createLinearGradient(num x0, num y0, num x1, num y1)
Implementation
dart
CanvasGradient createLinearGradient(num x0, num y0, num x1, num y1) native;

createPattern() ​

CanvasPattern? createPattern(dynamic image, String repetitionType)
Implementation
dart
CanvasPattern? createPattern(
  &#47;*CanvasImageSource*&#47; image,
  String repetitionType,
) native;

createRadialGradient() ​

CanvasGradient createRadialGradient(
  num x0,
  num y0,
  num r0,
  num x1,
  num y1,
  num r1,
)
Implementation
dart
CanvasGradient createRadialGradient(
  num x0,
  num y0,
  num r0,
  num x1,
  num y1,
  num r1,
) native;

drawImage() ​

void drawImage(
  dynamic image,
  num sx_OR_x,
  num sy_OR_y, [
  num? sw_OR_width,
  num? height_OR_sh,
  num? dx,
  num? dy,
  num? dw,
  num? dh,
])
Implementation
dart
void drawImage(
  &#47;*CanvasImageSource*&#47; image,
  num sx_OR_x,
  num sy_OR_y, [
  num? sw_OR_width,
  num? height_OR_sh,
  num? dx,
  num? dy,
  num? dw,
  num? dh,
]) native;

ellipse() ​

void ellipse(
  num x,
  num y,
  num radiusX,
  num radiusY,
  num rotation,
  num startAngle,
  num endAngle,
  bool? anticlockwise,
)
Implementation
dart
void ellipse(
  num x,
  num y,
  num radiusX,
  num radiusY,
  num rotation,
  num startAngle,
  num endAngle,
  bool? anticlockwise,
) native;

fill() ​

void fill([dynamic path_OR_winding, String? winding])
Implementation
dart
void fill([path_OR_winding, String? winding]) native;

fillRect() ​

void fillRect(num x, num y, num width, num height)
Implementation
dart
void fillRect(num x, num y, num width, num height) native;

fillText() ​

void fillText(String text, num x, num y, [num? maxWidth])
Implementation
dart
void fillText(String text, num x, num y, [num? maxWidth]) native;

getImageData() ​

ImageData getImageData(int sx, int sy, int sw, int sh)
Implementation
dart
ImageData getImageData(int sx, int sy, int sw, int sh) {
  return convertNativeToDart_ImageData(_getImageData_1(sx, sy, sw, sh));
}

getLineDash() ​

List<num> getLineDash()
Implementation
dart
List<num> getLineDash() native;

isPointInPath() ​

bool isPointInPath(
  dynamic path_OR_x,
  num x_OR_y, [
  dynamic winding_OR_y,
  String? winding,
])
Implementation
dart
bool isPointInPath(
  path_OR_x,
  num x_OR_y, [
  winding_OR_y,
  String? winding,
]) native;

isPointInStroke() ​

bool isPointInStroke(dynamic path_OR_x, num x_OR_y, [num? y])
Implementation
dart
bool isPointInStroke(path_OR_x, num x_OR_y, [num? y]) native;

lineTo() ​

void lineTo(num x, num y)
Implementation
dart
void lineTo(num x, num y) native;

measureText() ​

TextMetrics measureText(String text)
Implementation
dart
TextMetrics measureText(String text) native;

moveTo() ​

void moveTo(num x, num y)
Implementation
dart
void moveTo(num x, num y) native;

noSuchMethod() inherited ​

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart
class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Interceptor.

Implementation
dart
dynamic noSuchMethod(Invocation invocation) {
  throw NoSuchMethodError.withInvocation(this, invocation);
}

putImageData() ​

void putImageData(
  ImageData imagedata,
  int dx,
  int dy, [
  int? dirtyX,
  int? dirtyY,
  int? dirtyWidth,
  int? dirtyHeight,
])
Implementation
dart
void putImageData(
  ImageData imagedata,
  int dx,
  int dy, [
  int? dirtyX,
  int? dirtyY,
  int? dirtyWidth,
  int? dirtyHeight,
]) {
  if (dirtyX == null &&
      dirtyY == null &&
      dirtyWidth == null &&
      dirtyHeight == null) {
    var imagedata_1 = convertDartToNative_ImageData(imagedata);
    _putImageData_1(imagedata_1, dx, dy);
    return;
  }
  if (dirtyHeight != null &&
      dirtyWidth != null &&
      dirtyY != null &&
      dirtyX != null) {
    var imagedata_1 = convertDartToNative_ImageData(imagedata);
    _putImageData_2(
      imagedata_1,
      dx,
      dy,
      dirtyX,
      dirtyY,
      dirtyWidth,
      dirtyHeight,
    );
    return;
  }
  throw new ArgumentError("Incorrect number or type of arguments");
}

quadraticCurveTo() ​

void quadraticCurveTo(num cpx, num cpy, num x, num y)
Implementation
dart
void quadraticCurveTo(num cpx, num cpy, num x, num y) native;

rect() ​

void rect(num x, num y, num width, num height)
Implementation
dart
void rect(num x, num y, num width, num height) native;

resetTransform() ​

void resetTransform()
Implementation
dart
void resetTransform() native;

restore() ​

void restore()
Implementation
dart
void restore() native;

rotate() ​

void rotate(num angle)
Implementation
dart
void rotate(num angle) native;

save() ​

void save()
Implementation
dart
void save() native;

scale() ​

void scale(num x, num y)
Implementation
dart
void scale(num x, num y) native;

setLineDash() ​

void setLineDash(List<num> dash)
Implementation
dart
void setLineDash(List<num> dash) native;

setTransform() ​

void setTransform(num a, num b, num c, num d, num e, num f)
Implementation
dart
void setTransform(num a, num b, num c, num d, num e, num f) native;

stroke() ​

void stroke([Path2D? path])
Implementation
dart
void stroke([Path2D? path]) native;

strokeRect() ​

void strokeRect(num x, num y, num width, num height)
Implementation
dart
void strokeRect(num x, num y, num width, num height) native;

strokeText() ​

void strokeText(String text, num x, num y, [num? maxWidth])
Implementation
dart
void strokeText(String text, num x, num y, [num? maxWidth]) native;

toString() inherited ​

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Interceptor.

Implementation
dart
String toString() => Primitives.objectToHumanReadableString(this);

transform() ​

void transform(num a, num b, num c, num d, num e, num f)
Implementation
dart
void transform(num a, num b, num c, num d, num e, num f) native;

translate() ​

void translate(num x, num y)
Implementation
dart
void translate(num x, num y) native;

Operators ​

operator ==() inherited ​

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Interceptor.

Implementation
dart
bool operator ==(Object other) => identical(this, other);