The getLineDash() method of the Canvas 2D API's CanvasRenderingContext2D interface gets the current line dash pattern.



Return value

An Array of numbers that specify distances to alternately draw a line and a gap (in coordinate space units). If the number, when setting the elements, is odd, the elements of the array get copied and concatenated. For example, setting the line dash to [5, 15, 25] will result in getting back [5, 15, 25, 5, 15, 25].


Getting the current line dash setting

This example demonstrates the getLineDash() method.


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


As set by setLineDash(), strokes consist of lines that are 10 units wide, with spaces of 20 units in between each line.

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

ctx.setLineDash([10, 20]);
console.log(ctx.getLineDash());  // [10, 20]

// Draw a dashed line
ctx.moveTo(0, 50);
ctx.lineTo(300, 50);



Specification Status Comment
HTML Living Standard
The definition of 'CanvasRenderingContext2D.getLineDash' in that specification.
Living Standard  

Browser compatibility

Update compatibility data on GitHub
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
getLineDashChrome Full support YesEdge Full support 12Firefox Full support 27IE Full support 11Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support 27Opera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes


Full support  
Full support

Gecko-specific notes

  • Starting with Gecko 7.0 (Firefox 7.0 / Thunderbird 7.0 / SeaMonkey 2.4), the non-standard and deprecated property mozDash has been implemented to set and get a dash list. This property will be deprecated and removed in the future, see bug 931389. Use getLineDash() instead.

WebKit-specific notes

  • In WebKit-based browsers (e.g., Safari), the non-standard and deprecated property webkitLineDash is implemented besides this method. Use getLineDash() instead.

See also