Merge pull request #1625 from joshrudesill/master

Updated parameter names in context class to match MDN parameter names
This commit is contained in:
Anton Lavrenov 2023-08-09 18:38:32 -05:00 committed by GitHub
commit c0bf5c9a0a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 108 additions and 93 deletions

View File

@ -61,6 +61,7 @@
"devDependencies": { "devDependencies": {
"@parcel/transformer-image": "2.8.3", "@parcel/transformer-image": "2.8.3",
"@size-limit/preset-big-lib": "^8.2.4", "@size-limit/preset-big-lib": "^8.2.4",
"@types/jest": "^29.5.3",
"@types/mocha": "^10.0.1", "@types/mocha": "^10.0.1",
"canvas": "^2.11.2", "canvas": "^2.11.2",
"chai": "4.3.7", "chai": "4.3.7",

View File

@ -309,22 +309,23 @@ export class Context {
* @name Konva.Context#arc * @name Konva.Context#arc
*/ */
arc( arc(
a0: number, x: number,
a1: number, y: number,
a2: number, radius: number,
a3: number, startAngle: number,
a4: number, endAngle: number,
a5?: boolean counterClockwise?: boolean
) { ) {
this._context.arc(a0, a1, a2, a3, a4, a5); this._context.arc(x, y, radius, startAngle, endAngle, counterClockwise);
} }
/** /**
* arcTo function. * arcTo function.
* @method * @method
* @name Konva.Context#arcTo * @name Konva.Context#arcTo
*
*/ */
arcTo(a0: number, a1: number, a2: number, a3: number, a4: number) { arcTo(x1: number, y1: number, x2: number, y2: number, radius: number) {
this._context.arcTo(a0, a1, a2, a3, a4); this._context.arcTo(x1, y1, x2, y2, radius);
} }
/** /**
* beginPath function. * beginPath function.
@ -339,23 +340,24 @@ export class Context {
* @method * @method
* @name Konva.Context#bezierCurveTo * @name Konva.Context#bezierCurveTo
*/ */
bezierCurveTo( bezierCurveTo(
a0: number, cp1x: number,
a1: number, cp1y: number,
a2: number, cp2x: number,
a3: number, cp2y: number,
a4: number, x: number,
a5: number y: number
) { ) {
this._context.bezierCurveTo(a0, a1, a2, a3, a4, a5); this._context.bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y);
} }
/** /**
* clearRect function. * clearRect function.
* @method * @method
* @name Konva.Context#clearRect * @name Konva.Context#clearRect
*/ */
clearRect(a0: number, a1: number, a2: number, a3: number) { clearRect(x: number, y: number, width: number, height: number) {
this._context.clearRect(a0, a1, a2, a3); this._context.clearRect(x, y, width, height);
} }
/** /**
* clip function. * clip function.
@ -380,12 +382,12 @@ export class Context {
* @method * @method
* @name Konva.Context#createImageData * @name Konva.Context#createImageData
*/ */
createImageData(a0, a1) { createImageData(width, height) {
var a = arguments; var a = arguments;
if (a.length === 2) { if (a.length === 2) {
return this._context.createImageData(a0, a1); return this._context.createImageData(width, height);
} else if (a.length === 1) { } else if (a.length === 1) {
return this._context.createImageData(a0); return this._context.createImageData(width);
} }
} }
/** /**
@ -393,16 +395,16 @@ export class Context {
* @method * @method
* @name Konva.Context#createLinearGradient * @name Konva.Context#createLinearGradient
*/ */
createLinearGradient(a0: number, a1: number, a2: number, a3: number) { createLinearGradient(x0: number, y0: number, x1: number, y1: number) {
return this._context.createLinearGradient(a0, a1, a2, a3); return this._context.createLinearGradient(x0, y0, x1, y1);
} }
/** /**
* createPattern function. * createPattern function.
* @method * @method
* @name Konva.Context#createPattern * @name Konva.Context#createPattern
*/ */
createPattern(a0: CanvasImageSource, a1: string | null) { createPattern(image: CanvasImageSource, repetition: string | null) {
return this._context.createPattern(a0, a1); return this._context.createPattern(image, repetition);
} }
/** /**
* createRadialGradient function. * createRadialGradient function.
@ -410,14 +412,14 @@ export class Context {
* @name Konva.Context#createRadialGradient * @name Konva.Context#createRadialGradient
*/ */
createRadialGradient( createRadialGradient(
a0: number, x0: number,
a1: number, y0: number,
a2: number, r0: number,
a3: number, x1: number,
a4: number, y1: number,
a5: number r1: number
) { ) {
return this._context.createRadialGradient(a0, a1, a2, a3, a4, a5); return this._context.createRadialGradient(x0, y0, r0, x1, y1, r1);
} }
/** /**
* drawImage function. * drawImage function.
@ -425,25 +427,35 @@ export class Context {
* @name Konva.Context#drawImage * @name Konva.Context#drawImage
*/ */
drawImage( drawImage(
a0: CanvasImageSource, image: CanvasImageSource,
a1: number, sx: number,
a2: number, sy: number,
a3?: number, sWidth?: number,
a4?: number, sHeight?: number,
a5?: number, dx?: number,
a6?: number, dy?: number,
a7?: number, dWidth?: number,
a8?: number dHeight?: number
) { ) {
// this._context.drawImage(...arguments); // this._context.drawImage(...arguments);
var a = arguments, var a = arguments,
_context = this._context; _context = this._context;
if (a.length === 3) { if (a.length === 3) {
_context.drawImage(a0, a1, a2); _context.drawImage(image, sx, sy);
} else if (a.length === 5) { } else if (a.length === 5) {
_context.drawImage(a0, a1, a2, a3, a4); _context.drawImage(image, sx, sy, sWidth, sHeight);
} else if (a.length === 9) { } else if (a.length === 9) {
_context.drawImage(a0, a1, a2, a3, a4, a5, a6, a7, a8); _context.drawImage(
image,
sx,
sy,
sWidth,
sHeight,
dx,
dy,
dWidth,
dHeight
);
} }
} }
/** /**
@ -452,16 +464,25 @@ export class Context {
* @name Konva.Context#ellipse * @name Konva.Context#ellipse
*/ */
ellipse( ellipse(
a0: number, x: number,
a1: number, y: number,
a2: number, radiusX: number,
a3: number, radiusY: number,
a4: number, rotation: number,
a5: number, startAngle: number,
a6: number, endAngle: number,
a7?: boolean counterclockwise?: boolean
) { ) {
this._context.ellipse(a0, a1, a2, a3, a4, a5, a6, a7); this._context.ellipse(
x,
y,
radiusX,
radiusY,
rotation,
startAngle,
endAngle,
counterclockwise
);
} }
/** /**
* isPointInPath function. * isPointInPath function.
@ -531,48 +552,48 @@ export class Context {
* @method * @method
* @name Konva.Context#getImageData * @name Konva.Context#getImageData
*/ */
getImageData(a0: number, a1: number, a2: number, a3: number) { getImageData(sx: number, sy: number, sw: number, sh: number) {
return this._context.getImageData(a0, a1, a2, a3); return this._context.getImageData(sx, sy, sw, sh);
} }
/** /**
* lineTo function. * lineTo function.
* @method * @method
* @name Konva.Context#lineTo * @name Konva.Context#lineTo
*/ */
lineTo(a0: number, a1: number) { lineTo(x: number, y: number) {
this._context.lineTo(a0, a1); this._context.lineTo(x, y);
} }
/** /**
* moveTo function. * moveTo function.
* @method * @method
* @name Konva.Context#moveTo * @name Konva.Context#moveTo
*/ */
moveTo(a0: number, a1: number) { moveTo(x: number, y: number) {
this._context.moveTo(a0, a1); this._context.moveTo(x, y);
} }
/** /**
* rect function. * rect function.
* @method * @method
* @name Konva.Context#rect * @name Konva.Context#rect
*/ */
rect(a0: number, a1: number, a2: number, a3: number) { rect(x: number, y: number, width: number, height: number) {
this._context.rect(a0, a1, a2, a3); this._context.rect(x, y, width, height);
} }
/** /**
* putImageData function. * putImageData function.
* @method * @method
* @name Konva.Context#putImageData * @name Konva.Context#putImageData
*/ */
putImageData(a0: ImageData, a1: number, a2: number) { putImageData(imageData: ImageData, dx: number, dy: number) {
this._context.putImageData(a0, a1, a2); this._context.putImageData(imageData, dx, dy);
} }
/** /**
* quadraticCurveTo function. * quadraticCurveTo function.
* @method * @method
* @name Konva.Context#quadraticCurveTo * @name Konva.Context#quadraticCurveTo
*/ */
quadraticCurveTo(a0: number, a1: number, a2: number, a3: number) { quadraticCurveTo(cpx: number, cpy: number, x: number, y: number) {
this._context.quadraticCurveTo(a0, a1, a2, a3); this._context.quadraticCurveTo(cpx, cpy, x, y);
} }
/** /**
* restore function. * restore function.
@ -587,8 +608,8 @@ export class Context {
* @method * @method
* @name Konva.Context#rotate * @name Konva.Context#rotate
*/ */
rotate(a0: number) { rotate(angle: number) {
this._context.rotate(a0); this._context.rotate(angle);
} }
/** /**
* save function. * save function.
@ -603,24 +624,24 @@ export class Context {
* @method * @method
* @name Konva.Context#scale * @name Konva.Context#scale
*/ */
scale(a0: number, a1: number) { scale(x: number, y: number) {
this._context.scale(a0, a1); this._context.scale(x, y);
} }
/** /**
* setLineDash function. * setLineDash function.
* @method * @method
* @name Konva.Context#setLineDash * @name Konva.Context#setLineDash
*/ */
setLineDash(a0: number[]) { setLineDash(segments: number[]) {
// works for Chrome and IE11 // works for Chrome and IE11
if (this._context.setLineDash) { if (this._context.setLineDash) {
this._context.setLineDash(a0); this._context.setLineDash(segments);
} else if ('mozDash' in this._context) { } else if ('mozDash' in this._context) {
// verified that this works in firefox // verified that this works in firefox
(<any>this._context['mozDash']) = a0; (<any>this._context['mozDash']) = segments;
} else if ('webkitLineDash' in this._context) { } else if ('webkitLineDash' in this._context) {
// does not currently work for Safari // does not currently work for Safari
(<any>this._context['webkitLineDash']) = a0; (<any>this._context['webkitLineDash']) = segments;
} }
// no support for IE9 and IE10 // no support for IE9 and IE10
@ -639,14 +660,14 @@ export class Context {
* @name Konva.Context#setTransform * @name Konva.Context#setTransform
*/ */
setTransform( setTransform(
a0: number, a: number,
a1: number, b: number,
a2: number, c: number,
a3: number, d: number,
a4: number, e: number,
a5: number f: number
) { ) {
this._context.setTransform(a0, a1, a2, a3, a4, a5); this._context.setTransform(a, b, c, d, e, f);
} }
/** /**
* stroke function. * stroke function.
@ -665,31 +686,24 @@ export class Context {
* @method * @method
* @name Konva.Context#strokeText * @name Konva.Context#strokeText
*/ */
strokeText(a0: string, a1: number, a2: number, a3?: number) { strokeText(text: string, x: number, y: number, maxWidth?: number) {
this._context.strokeText(a0, a1, a2, a3); this._context.strokeText(text, x, y, maxWidth);
} }
/** /**
* transform function. * transform function.
* @method * @method
* @name Konva.Context#transform * @name Konva.Context#transform
*/ */
transform( transform(a: number, b: number, c: number, d: number, e: number, f: number) {
a0: number, this._context.transform(a, b, c, d, e, f);
a1: number,
a2: number,
a3: number,
a4: number,
a5: number
) {
this._context.transform(a0, a1, a2, a3, a4, a5);
} }
/** /**
* translate function. * translate function.
* @method * @method
* @name Konva.Context#translate * @name Konva.Context#translate
*/ */
translate(a0: number, a1: number) { translate(x: number, y: number) {
this._context.translate(a0, a1); this._context.translate(x, y);
} }
_enableTrace() { _enableTrace() {
var that = this, var that = this,