Back to Content

CanvasRenderingContext2D: lineTo() method

files/en-us/web/api/canvasrenderingcontext2d/lineto/index.md

latest2.2 KB
Original Source

{{APIRef("Canvas API")}}

The {{domxref("CanvasRenderingContext2D")}} method lineTo(), part of the Canvas 2D API, adds a straight line to the current sub-path by connecting the sub-path's last point to the specified (x, y) coordinates.

Like other methods that modify the current path, this method does not directly render anything. To draw the path onto a canvas, you can use the {{domxref("CanvasRenderingContext2D.fill", "fill()")}} or {{domxref("CanvasRenderingContext2D.stroke", "stroke()")}} methods.

Syntax

js-nolint
lineTo(x, y)

Parameters

  • x
    • : The x-axis coordinate of the line's end point.
  • y
    • : The y-axis coordinate of the line's end point.

Return value

None ({{jsxref("undefined")}}).

Examples

Drawing a straight line

This example draws a straight line using the lineTo() method.

HTML

html
<canvas id="canvas"></canvas>

JavaScript

The line begins at (30, 50) and ends at (150, 100).

js
const canvas = document.getElementById("canvas");
const ctx = canvas.getContext("2d");

ctx.beginPath(); // Start a new path
ctx.moveTo(30, 50); // Move the pen to (30, 50)
ctx.lineTo(150, 100); // Draw a line to (150, 100)
ctx.stroke(); // Render the path

Result

{{ EmbedLiveSample('Drawing_a_straight_line', 700, 180) }}

Drawing connected lines

Each call of lineTo() (and similar methods) automatically adds to the current sub-path, which means that all the lines will all be stroked or filled together. This example draws a letter 'M' with a single contiguous line.

HTML

html
<canvas id="canvas"></canvas>

JavaScript

js
const canvas = document.getElementById("canvas");
const ctx = canvas.getContext("2d");

ctx.moveTo(90, 130);
ctx.lineTo(95, 25);
ctx.lineTo(150, 80);
ctx.lineTo(205, 25);
ctx.lineTo(210, 130);
ctx.lineWidth = 15;
ctx.stroke();

Result

{{ EmbedLiveSample('Drawing_connected_lines', 700, 180) }}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • The interface defining this method: {{domxref("CanvasRenderingContext2D")}}
  • {{domxref("CanvasRenderingContext2D.moveTo()")}}
  • {{domxref("CanvasRenderingContext2D.stroke()")}}