CanvasRenderingContext2D: drawImage() Methode
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Die CanvasRenderingContext2D.drawImage()
-Methode der Canvas-2D-API bietet verschiedene Möglichkeiten, ein Bild auf die Leinwand zu zeichnen.
Syntax
drawImage(image, dx, dy)
drawImage(image, dx, dy, dWidth, dHeight)
drawImage(image, sx, sy, sWidth, sHeight, dx, dy, dWidth, dHeight)
Parameter
image
-
Ein Element, das in den Kontext gezeichnet werden soll. Die Spezifikation erlaubt jede Canvasbildquelle, insbesondere, ein
HTMLImageElement
, einSVGImageElement
, einHTMLVideoElement
, einHTMLCanvasElement
, einImageBitmap
, einOffscreenCanvas
, oder einVideoFrame
. sx
Optional-
Die x-Koordinate der oberen linken Ecke des Teilrechtecks des Quell
image
, das in den Zielkontext gezeichnet werden soll. Verwenden Sie die 3- oder 5-Argument-Syntax, um dieses Argument auszulassen. sy
Optional-
Die y-Koordinate der oberen linken Ecke des Teilrechtecks des Quell
image
, das in den Zielkontext gezeichnet werden soll. Verwenden Sie die 3- oder 5-Argument-Syntax, um dieses Argument auszulassen. sWidth
Optional-
Die Breite des Teilrechtecks des Quell
image
, das in den Zielkontext gezeichnet werden soll. Wenn nicht angegeben, wird das gesamte Rechteck von den Koordinatensx
undsy
bis zur unteren rechten Ecke des Bildes verwendet. Verwenden Sie die 3- oder 5-Argument-Syntax, um dieses Argument auszulassen. Ein negativer Wert dreht das Bild. sHeight
Optional-
Die Höhe des Teilrechtecks des Quell
image
, das in den Zielkontext gezeichnet werden soll. Verwenden Sie die 3- oder 5-Argument-Syntax, um dieses Argument auszulassen. Ein negativer Wert dreht das Bild. dx
-
Die x-Koordinate im Ziel-Canvas, an der die obere linke Ecke des Quell
image
platziert werden soll. dy
-
Die y-Koordinate im Ziel-Canvas, an der die obere linke Ecke des Quell
image
platziert werden soll. dWidth
-
Die Breite, mit der das
image
im Ziel-Canvas gezeichnet werden soll. Dies ermöglicht eine Skalierung des gezeichneten Bildes. Wenn nicht angegeben, wird das Bild beim Zeichnen in der Breite nicht skaliert. Beachten Sie, dass dieses Argument nicht in der 3-Argument-Syntax enthalten ist. dHeight
-
Die Höhe, mit der das
image
im Ziel-Canvas gezeichnet werden soll. Dies ermöglicht eine Skalierung des gezeichneten Bildes. Wenn nicht angegeben, wird das Bild beim Zeichnen in der Höhe nicht skaliert. Beachten Sie, dass dieses Argument nicht in der 3-Argument-Syntax enthalten ist.
Rückgabewert
Keiner (undefined
).
Ausnahmen
InvalidStateError
DOMException
-
Wird ausgelöst, wenn das Bild keine Bilddaten hat oder wenn die Breite oder Höhe des Canvas oder des Quellrechtecks null ist.
TypeMismatchError
DOMException
-
Wird ausgelöst, wenn ein
null
oderundefined
Bild als Parameter übergeben wird.
Beispiele
Zeichnen eines Bildes auf das Canvas
Dieses Beispiel zeichnet ein Bild auf das Canvas unter Verwendung der drawImage()
-Methode.
HTML
<canvas id="canvas"></canvas>
<div style="display:none;">
<img
id="source"
src="https://mdn.github.io/shared-assets/images/examples/rhino.jpg"
width="300"
height="227" />
</div>
JavaScript
Das Quellbild wird von den Koordinaten (33, 71) mit einer Breite von 104 und einer Höhe von 124 entnommen. Es wird auf das Canvas bei (21, 20) gezeichnet, wo es eine Breite von 87 und eine Höhe von 104 erhält.
const canvas = document.getElementById("canvas");
const ctx = canvas.getContext("2d");
const image = document.getElementById("source");
image.addEventListener("load", (e) => {
ctx.drawImage(image, 33, 71, 104, 124, 21, 20, 87, 104);
});
Ergebnis
Verständnis der Größe des Quell-Elements
Die drawImage()
-Methode verwendet die intrinsische Größe in CSS-Pixeln des Quell-Elements beim Zeichnen.
Zum Beispiel, wenn Sie ein Image
laden und die optionalen Größenparameter in seinem Konstruktor angeben, müssen Sie die naturalWidth
- und naturalHeight
-Eigenschaften der erstellten Instanz verwenden, um Dinge wie Zuschneiden und Skalieren richtig zu berechnen, anstatt element.width
und element.height
. Dasselbe gilt für videoWidth
und videoHeight
, wenn das Element ein <video>
-Element ist, und so weiter.
HTML
<canvas id="canvas"></canvas>
JavaScript
const canvas = document.getElementById("canvas");
const ctx = canvas.getContext("2d");
const image = new Image(60, 45); // Using optional size for image
image.onload = drawImageActualSize; // Draw when image has loaded
// Load an image of intrinsic size 300x227 in CSS pixels
image.src = "https://mdn.github.io/shared-assets/images/examples/rhino.jpg";
function drawImageActualSize() {
// Use the intrinsic size of image in CSS pixels for the canvas element
canvas.width = this.naturalWidth;
canvas.height = this.naturalHeight;
// Will draw the image as 300x227, ignoring the custom size of 60x45
// given in the constructor
ctx.drawImage(this, 0, 0);
// To use the custom size we'll have to specify the scale parameters
// using the element's width and height properties - lets draw one
// on top in the corner:
ctx.drawImage(this, 0, 0, this.width, this.height);
}
Ergebnis
Spezifikationen
Specification |
---|
HTML Standard # dom-context-2d-drawimage-dev |
Browser-Kompatibilität
BCD tables only load in the browser
Hinweise
drawImage()
funktioniert nur korrekt auf einemHTMLVideoElement
, wenn dessenHTMLMediaElement.readyState
größer als 1 ist (d.h. das seek-Ereignis ausgelöst wird, nachdem diecurrentTime
-Eigenschaft gesetzt wurde).drawImage()
verwendet immer die intrinsische Größe in CSS-Pixeln des Quell-Elements beim Zeichnen, Zuschneiden und/oder Skalieren.- In einigen älteren Browserversionen ignoriert
drawImage()
alle EXIF-Metadaten in Bildern, einschließlich der Ausrichtung. Dieses Verhalten ist besonders auf iOS-Geräten problematisch. Sie sollten die Ausrichtung selbst erkennen undrotate()
verwenden, um sie richtig darzustellen.
Siehe auch
- Das Interface, das diese Methode definiert:
CanvasRenderingContext2D