terriajs

TerriaJS

TerriaJS is a library for building rich, web-based geospatial data explorers, used to drive National Map, Digital Earth Australia Map, NSW Spatial Digital Twin and NEII Viewer (and many others). It uses Cesium and WebGL for a full 3D globe in the browser with no plugins. It gracefully falls back to 2D with Leaflet on systems that can't run Cesium. It can handle catalogs of tens of thousands of layers, with dozens of geospatial file and web service types supported. It is almost entirely JavaScript in the browser, meaning it can even be deployed as a static website, making it simple and cheap to host.

---

We have just released a brand new version of Terria — verson 8!

We've put together a list of things we've removed from version 8 and some steps to help you migrate to the new version in our migration guide

Not ready to move to version 8 yet? You can find terriajs version 7 here: https://github.com/TerriaJS/terriajs/tree/terriajs7

---

Features

• Nested catalog of layers which can be independently enabled to create mashups of many layers.
• Supports GeoJSON, KML, CSV (point and region-mapped), GPX, GeoRSS, CZML and zipped shapefile file types natively.
• Supports WMS, WFS, WMTS, Esri MapServer, Esri FeatureServer, Bing Maps, Carto Maps, Cesium Ion Imagery, OpenStreetMap-style raster tiles, Mapbox, SDMX, 3D Tiles and GTFS and Sensor Observation Service item types.
• Supports querying WMS, WFS, Esri MapServer, CSW, CKAN, Socrata, OpenDataSoft and SDMX services for groups of items.
• 3D globe (Cesium) or 2D mode (Leaflet). 3D objects supported in CZML format.
• Time dimensions supported for CSV, CZML, WMS. Automatically animate layers, or slide the time control forward and backward.
• Drag-and-drop files from your desktop to the browser, for instant visualisation (no file upload to server required).
• All ASGS (Australian Statistical Geographic Standard) region types (LGA, SA2, commonwealth electoral district etc) supported for CSV region mapping, plus several others: Primary Health Networks, Statistical Local Areas, ISO 3 letter country codes, etc.
• Users can generate a reusable URL link of their current map view, to quickly share mashups of web-hosted data.
• The interface is internationalised and translations are available for French, Italian and Japanese. Partial translations have also been contributed for other languages (see TerriaJS weblate)

Who's using TerriaJS?

Sites developed by Data61

• National Map
• NSW Spatial Digital Twin
• Digital Earth Australia Map
• Digital Earth Africa Map
• NEII Viewer
• GeoGLAM Rangeland and Pasture Productivity

Not Data61

Sites we're aware of that are using TerriaJS. These are not endorsements or testimonials.

• AURIN Map
• Portale del suolo
• Find & Connect Map of Children's Homes
• GeoPlatform Mapping

Technical

• NodeJS v16, v18 and v20 are supported
• Built in TypeScript & ES2020+ JavaScript, compiled with Babel to ES5.
• Supports modern browsers (recent versions of Microsoft Edge, Mozilla Firefox & Google Chrome).
• TerriaJS Server component runs in NodeJS and provides proxying for web services that don't support CORS or require authentication. Instead of using TerriaJS-Sever proxy service, an alternative proxying service URL can be specified. See Specify an alternative proxy server URL
• Dependencies are managed in NPM and assembled using WebPack.

Getting Started

The easiest way to build your own Terria-based map is using the TerriaMap starting point. This gives you the HTML structure, server and build processes you need to get a site up and running immediately.

See Getting Started in the Documentation for all the details.

Components and naming

• Terria™ is the overall name for the spatial data platform and the team that built TerriaJS.
• TerriaJS is this TypeScript/JavaScript library consisting of the 2D/3D map, catalog management and many spatial data connectors.
• Cesium is the 3D WebGL rendering library used by TerriaJS, which provides many low-level functions for loading and displaying imagery and spatial formats such as GeoJSON and KML.
• TerriaMap is a complete website starting point, using TerriaJS.
• TerriaJS-Server is a NodeJS-based server that provides proxying and support services for TerriaJS.
• NationalMap is the flagship Terria deployment, and the origin of the TerriaJS library.

Related components

• TerriaMapStatic, a pre-built version of TerriaMap, which can be deployed as a static HTML website, such as on Github Pages.

Big Thanks

Hosting and contribution framework for community translations of TerriaJS provided by Weblate under the Libre plan for open source software. See our translation progress for different languages:

Join the community

Get in touch!

• Join the Github Discussion
• Raise issues in the Github issue tracker

Publishing TerriaJS

From main using GitHub Actions (preferred method):

• Checkout and pull main branch of terriajs, run yarn install if necessary.
• Bump the version number in package.json.
• Review and edit CHANGES.md.
  • Ensure that entries for new changes are written in the right section by diffing against the last version. Make sure the section name matches the version you set in package.json above.
  • e.g. git diff 8.2.25 HEAD -- CHANGES.md (where 8.2.25 is the previous published version)
  • Or using GitHub web interface https://github.com/TerriaJS/terriajs/compare/8.2.25...main (change the version and master/next to match the previous release and branch)
  • Finalise the heading of the version to be released with version number and date.
  • Add a heading above for upcoming changes to be documented under.
• Commit and push your changes on a branch and make a PR to main branch.
• Get someone to review and merge the PR.
• Wait for slack notification of successful/failed publish.
• 😄

Publishing to npm without the GitHub Action (not for standard releases):

This method should not be used to publish versions at the tip of main or another branch that is often used for releases. To publish a new version of TerriaJS to npm with this method, you'll need to be listed as a collaborator here. Existing collaborators can add new ones. Then:

• Checkout and pull the branch of terriajs to be deployed, run yarn install if necessary.
• Bump the version number in package.json. Follow semver.
• Appropriately update CHANGES.md, ensuring that changes are listed in their correct sections.
• Commit and push your changes and make a PR to the branch to be deployed.
• Get someone to review and merge the PR.
• Fetch and checkout the merge commit made by merging the PR.
• rm -rf wwwroot/build
• Make sure you don't have any changes in your working directory.
• gulp lint release
• npm publish --tag your-tag (for a release not at the tip of main a tag must be set, and it must not be latest or next. For releases on old versions you could use e.g. 6-5-x or 6-x-x as a tag, for upcoming features a short name could be used)
• Ensure that CHANGES.md on main is also updated to list the release and clearly note the nature and reason for release.

The above will publish a new version to npm and also tag that version on GitHub.

Changelog

8.7.10 - 2024-11-29

• Add OpenStreetMap as a basemap option.
• Update to node-notifier 10.0.1 to fix security vulnerabilities.
• Remove unused ts-loader dependency.
• Remove unused class-list dependency.
• TSify ConsoleAnalytics module.
• Update to gulp 5.0 to fix security vulnerabilities.
  • Gulp 5 defaults to encoding copied files as utf-8, had turn off encoding by setting encoding: false to correctly copy binary assets from dependencies.
• Update to dompurify 2.5.7 to fix security vulnerabilities.
• Update to @mapbox/togeojson 0.16.2 to fix security vulnerabilities.
• Remove unused simple-statistics dependency.
• Update to pretty-quick 4.0.0 to fix security vulnerabilities.