Cannot read properties of null (reading 'getContext') in JS

avatar
Borislav Hadzhiev

Last updated: Mar 3, 2024
2 min

banner

# Cannot read properties of null (reading 'getContext') in JS

The "Cannot read properties of null (reading 'getContext')" error occurs for 2 reasons:

  1. Calling the getContext method on a non-existent canvas element.
  2. Inserting the JS script tag above the HTML where the canvas element is declared.

cannot read property getcontext of null

Here is an example of how the error occurs.

index.js
const canvas = document.getElementById('does-not-exist'); console.log(canvas); // ๐Ÿ‘‰๏ธ null // โ›”๏ธ Uncaught TypeError: Cannot read properties of null (reading 'getContext') const ctx = canvas.getContext('2d');
The code for this article is available on GitHub

We attempted to call the getContext() method on a null value which caused the error.

# Make sure the DOM element exists before calling getContext()

Make sure you're providing the correct id when trying to get the canvas element.

The error often occurs when providing an invalid id to the getElementById method.

index.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8" /> </head> <body> <!-- โœ… id should match your JS code --> <canvas id="canvas" width="500" height="500"></canvas> <script src="index.js"></script> </body> </html>

The id in your HTML code should be the same as the id you pass in the call to the document.getElementById() method.

# Place the JS script tag at the bottom of the body tag

Place the JS script tag at the bottom of the body tag, after the canvas element has been created.

index.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8" /> </head> <body> <!-- โŒ BAD - script is run before canvas is created โŒ --> <script src="index.js"></script> <canvas id="canvas" width="500" height="500"></canvas> </body> </html>
The code for this article is available on GitHub

The index.js script is run before the canvas element is created, so you can't access the element inside the index.js file.

index.js
const canvas = document.getElementById('canvas'); console.log(canvas); // ๐Ÿ‘‰๏ธ null // โ›”๏ธ Cannot read properties of null (reading 'getContext') const ctx = canvas.getContext('2d');

You should place the JS script tag at the bottom of the body, after the DOM elements have been declared.

index.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8" /> </head> <body> <canvas id="canvas" width="500" height="500"></canvas> <h2>bobbyhadz.com</h2> <!-- โœ… GOOD - canvas is already created โœ… --> <script src="index.js"></script> </body> </html>

place js script tag at bottom of body tag

The code for this article is available on GitHub

Now you can access the canvas element inside of the index.js file.

index.js
const canvas = document.getElementById('canvas'); console.log(canvas); // ๐Ÿ‘‰๏ธ canvas#canvas // โœ… works const ctx = canvas.getContext('2d'); console.log(ctx); // ๐Ÿ‘‰๏ธ CanvasRenderingContext2D

access canvas element inside index js successfully

The code for this article is available on GitHub

HTML code is parsed from top to bottom, so the script tag has to be placed at the bottom of the body tag, after all of the DOM elements it needs to access.

# Conclusion

The "Cannot read properties of null (reading 'getContext')" error occurs when calling the getContext method on a null value.

To solve the error, make sure the JS script tag is loaded after the HTML is declared and the id of the element exists in the DOM.

I wrote a book in which I share everything I know about how to become a better, more efficient programmer.
book cover
You can use the search field on my Home Page to filter through all of my articles.

Copyright ยฉ 2024 Borislav Hadzhiev