rlayers
TypeScript icon, indicating that this package has built-in type declarations

2.3.2 • Public • Published

rlayers - React Components for OpenLayers 6+

logo

License: ISC npm version Node.js CI codecov downloads

© OpenStreetMap contributors Kartendaten: © OpenStreetMap-Mitwirkende, SRTM | Kartendarstellung: © OpenTopoMap (CC-BY-SA)

rlayers is an opinionated set of React components for OpenLayers.

It's design policy is:

  • Fully Typescript-typed
  • Do everything that faces the user the React way and not the OpenLayers way - onClick and onPointerEnter/onPoinerLeave handlers are typical examples
  • If it does not face the user, it does not need to be React way - internally it uses inheritance, following the OpenLayers classes, over composition
  • Simple things should be simple to do, performance optimizations should not get in the way unless needed
  • If taking shortcuts when updating the components, always err on the safe side but do provide an override method that allows to come close to the raw OpenLayers performance
  • Expose all the advanced OpenLayers features
  • Try to be as much SSR-friendly as possible (this feature is currently in POC stage, see below)
  • The current target is OpenLayers 6+
  • Avoid dependencies when built except for React and OpenLayers (the examples have some dependencies) - currently the single one is lru-cache at 8Kbytes

Long term support of this project

The birth of this project is related to a huge extortion in the geography community linked to a sexual harassment affair covered up by the French Judiciary. It is maintained as a free service to the geography community so that it can remain as a remainder to a number of companies - including Camptocamp, ESRI, Mapbox and Makina Corpus - that the most noble way to claim size bragging rights is to produce good software. You can safely use this framework in your projects, be assured that it will be maintained very well and for many years to come. It's companion project on the server-side is gdal-async.

Alternatives

<- Light-Weight --- Feature-Rich ->

pigeon-maps - react-leaflet - rlayers

Among the completely free and open source alternatives for creating maps with React, on a scale going from the most light-weight to the most feature-rich solution, rlayers is the right-most one.

It offers the full power OpenLayers - dynamic reprojections, comprehensive event handlers, a very rich set of supported formats, interfaces and layer types and a very good performance for very complex maps. This comes at the price of a quite significant total bundle size.

Installation

npm --save install rlayers ol react react-dom

Compatibility Matrix

OpenLayers and React are peer dependencies and should be installed separately.

React is supported from version 16.8.0.


rlayers Unit-tested OpenLayers versions Unit-tested React versions
1.0 (obsolete) 6.0 16.8, 16.14, 17.0.2
1.1 (obsolete) 6.6, 6.7, 6.8, 6.9 16.8, 16.14, 17.0.2
1.2 (obsolete) 6.6, 6.7, 6.8, 6.9 16.8, 16.14, 17.0.2
1.3 (obsolete) 6.10, 6.11, 6.12, 6.13, 6.14, 6.14.1 16.8, 16.14, 17.0.2, 18.0.0
1.4 (obsolete) 6.10, 6.11, 6.12, 6.13, 6.14, 6.14.1, 6.15, 6.15.1, 7.0.0, 7.1.0, 7.2.0, 7.2.2, 7.3.0 16.8, 16.14, 17.0.2, 18.0.0, 18.1.0, 18.2.0
1.5 (obsolete) 6.10, 6.11, 6.12, 6.13, 6.14, 6.14.1, 6.15, 6.15.1, 7.0.0, 7.1.0, 7.2.0, 7.2.2, 7.3.0, 7.4.0 16.8, 16.14, 17.0.2, 18.0.0, 18.1.0, 18.2.0
2.0 (obsolete) 6.10, 6.11, 6.12, 6.13, 6.14, 6.14.1, 6.15, 6.15.1, 7.0.0, 7.1.0, 7.2.0, 7.2.2, 7.3.0, 7.4.0, 7.5.1 16.8, 16.14, 17.0.2, 18.0.0, 18.1.0, 18.2.0
2.1 (obsolete) 6.10, 6.11, 6.12, 6.13, 6.14, 6.14.1, 6.15, 6.15.1, 7.0.0, 7.1.0, 7.2.0, 7.2.2, 7.3.0, 7.4.0, 7.5.1, 8.0.0, 8.1.0 16.8, 16.14, 17.0.2, 18.0.0, 18.1.0, 18.2.0
2.2 (obsolete) 6.10, 6.11, 6.12, 6.13, 6.14, 6.14.1, 6.15, 6.15.1, 7.0.0, 7.1.0, 7.2.0, 7.2.2, 7.3.0, 7.4.0, 7.5.1, 8.0.0, 8.1.0, 8.2.0 16.8, 16.14, 17.0.2, 18.0.0, 18.1.0, 18.2.0
2.3 (@latest) 6.10, 6.11, 6.12, 6.13, 6.14, 6.14.1, 6.15, 6.15.1, 7.0.0, 7.1.0, 7.2.0, 7.2.2, 7.3.0, 7.4.0, 7.5.1, 8.0.0, 8.1.0, 8.2.0, 9.0.0, 9.1.0 16.8, 16.14, 17.0.2, 18.0.0, 18.1.0, 18.2.0, 18.3.1

When using dynamic styles with React 18, you may get a warning in the console in debug mode: https://github.com/mmomtchev/rlayers/issues/40. You can safely ignore it as has no functional consequences - React 18, including the concurrent renderer, is fully supported.

Usage

rlayers is a set of reusable React components that can be nested in various ways to create map applications for the web through React composition in the true spirit of React. The components are based on a simplified model of the OpenLayers classes: for example the layers and the sources abstraction levels have been fused into one single level and the map and the view are also represented by a single component.

In order to avoid confusion between the OpenLayers classes and the rlayers classes which sometimes have the same names - all rlayers classes are prefixed with R. If a class begins with R, it is from rlayers, otherwise it is an OpenLayers class.

The most important element is the <RMap>. Every other element, except <RStyle>, requires a parent to function - an <RLayer> must be part of a map, an <RFeature> must be part of an <RLayerVector>, an <RControl> must also be part of a map.

Simple step-by-step example

This is the simple overlay example - https://mmomtchev.github.io/rlayers/#/overlays

import React from 'react';
import {fromLonLat} from 'ol/proj';
import {Point} from 'ol/geom';
import 'ol/ol.css';

import {RMap, ROSM, RLayerVector, RFeature, ROverlay, RStyle} from 'rlayers';
import locationIcon from './svg/location.svg';

// Create a map, its size is set in the CSS class example-map
<RMap className='example-map' initial={{center: fromLonLat([2.364, 48.82]), zoom: 11}}>
    {/* Use an OpenStreetMap background */}
    <ROSM />
    {/* Create a single layer for holding vector features */}
    <RLayerVector zIndex={10}>
        {/* Create a style for rendering the features */}
        <RStyle.RStyle>
            {/* Consisting of a single icon, that is slightly offset
             * so that its center falls over the center of the feature */}
            <RStyle.RIcon src={locationIcon} anchor={[0.5, 0.8]} />
        </RStyle.RStyle>
        {/* Create a single feature in the vector layer */}
        <RFeature
            {/* Its geometry is a point geometry over the monument */}
            geometry={new Point(fromLonLat([2.295, 48.8737]))}
            {/* Bind an onClick handler */}
            onClick={(e) =>
                {/* e.map is the underlying OpenLayers map - we call getView().fit()
                to pan/zoom the map over the monument with a small animation */}
                e.map.getView().fit(e.target.getGeometry().getExtent(), {
                    duration: 250,
                    maxZoom: 15
                })
            }
        >
            {/* The icon is an SVG image that represents the feature on the map
            while an overlay allows us to add a normal HTML element over the feature */}
            <ROverlay className='example-overlay'>
                Arc de Triomphe
                <br />
                <em>&#11017; click to zoom</em>
            </ROverlay>
        </RFeature>
    </RLayerVector>
</RMap>

Check examples/static_pages.html for a fully self-contained static HTML page using rlayers.

You can also check the GPLed XC-DB for a larger and more complex project entirely implemented using React, Redux and rlayers.

Contexts

Composition works by using React Contexts. Every nested element uses the context of its nearest parent.

The underlying OpenLayers objects can be accessed using the useOL() hook - check the Geolocation example to see how.

Currently useOL() has an RContextType and can contain the following elements:

  • map provided by a map, every other element, except an RStyle must have a map parent
  • layer and source provided by all layers - not required for anything at the moment, but can be used to access the underlying OpenLayers objects
  • vectorlayer and vectorsource provided by vector layers only - required for <RFeature>
  • vectortilelayer provided by vector tile layers only
  • location and feature provided by a map feature - required for <ROverlay> and <RPopup>
  • style provided by a style definition - the only one which can be outside of a map

Additionally, useRLayersComponent() allows retrieving the containing rlayers component.

Accessing the underlying OpenLayers objects and API

The underlying OpenLayers objects can be accessed in a number of different ways:

  • Through the context objects by using React.Context.Consumer
  • In an event handler that is a normal function and not an arrow lambda, this will contain the rlayers component and this.context will contain the context - this is an alternative to using useOL()
  • In all event handlers, OpenLayers will pass the target object in event.target and the map in event.map - the popups example uses this method
  • And finally, accessing arbitrary elements, even outside their contexts, is possible by using React references - React.RefObjects. The high performance example contains an example of this. The underlying OpenLayers objects can be accessed through the ol property of every component. Additionaly, for layer objects, the underlying OpenLayers source can be accessed through source:
    const layerRef = React.createRef() as React.RefObject<RLayerVector>;
    Then after rendering:
    <RLayerVector ref={layerRef} />
    layerRef.current.ol will contain the OpenLayers layer and layerRef.current.source will contain the source. This is the only way of accessing the object outside its context.

Styles

Style definitions can be placed anywhere inside the DOM and can be referenced with a React reference. rlayers includes two special types for dealing with styles:

  • RStyleRef which is an alias to React.RefObject<RStyle> is a React reference to an <RStyle> element. It can be transparently used everywhere where a classical OpenLayers StyleLike is required
  • RStyleLike is the new union type that allows for StyleLike or a RStyleRef

A style placed inside a vector layer will be automatically applied to that vector layer.

A style can either be static or dynamic. A static style depends only on its properties. A dynamic style is a function that takes an OpenLayers Feature object as its input and returns a Style. A dynamic style creates a new object for every rendered feature, so this must be taken into account. A simple caching mechanism is also provided, based on a user-supplied hash function. It can greatly improve performance when the majority of the features use relatively few different styles.

You can refer to

Classical OpenLayers StyleLike objects are supported too, but this is not the React way. Still, if you need every last bit of performance, writing an optimized OpenLayers style function is the best solution.

Performance

React is a wonderful framework that makes it very easy to write complex web applications without having to manually handle all the interdependencies between the various components. This is the reason why it is called React - components automatically React to changes in other components. In the true spirit of React, rlayers prefers to err on the safe side - always updating when there is a chance that the component needs updating - making it easy on the beginner who wants simple interface while still allowing the experienced engineer to achieve the performance he needs.

When high performance is required, particular care must be taken that the component properties do not change without a reason. This is especially true when the pointermove event is used. In these cases one should avoid using anonymous objects, arrays or functions as properties.

Take for example this:

<RFeature
    geometry={new Point(fromLonLat([2.295, 48.858])}
    onClick={(e: MapBrowserEvent) => process(e.target)}
/>

This is a feature that will be re-evaluated at every frame. Its geometry appears to be a constant, but it is in fact an anonymous object that is created at every frame - even if it always holds the same value. Passing a constant is one way around this, but the true React way is using the two tools React provides: React.useMemo and React.useCallback. They memoize the value and take care to always return a reference to the same object unless one of the listed dependencies is modified.

This is a much better performing code that won't rerender the feature component:

<RFeature
    geometry={React.useMemo(new Point(fromLonLat([2.295, 48.858]), [/* no deps */])}
    onClick={React.useCallback((e: MapBrowserEvent) => process(e.target), [/* no deps */])}
/>

Anonymous objects, arrays and especially lambdas in the properties of a component are prime candidates for memoization. Sometimes, you can also memoize whole components or groups of components - for a very significant performance boost.

Generally, if you are binding code to the pointermove event and your performance is not good enough, this is the first thing you should be looking at - which components update at every pointermove and why.

These 3 examples run code on various high-frequency events, take a look at them:

  • Clustering runs the styling function every time the map is panned or zoomed
  • Drop a pin runs code on every pointermove that carefully avoids rerendering
  • Geo data updates components at every pointerenter/pointerleave
  • The high performance example is a complex example that runs lots of code and updates components at every pointermove

Also, when searching for features listening on pointermove/pointerenter/pointerleave events, rlayers 2.0.0 and later, is able to eliminate very early feature layers that do not contain features listenening for those events. If your map contains a large number of features, and only a handful of these use pointermove events - try to group them in a separate layer.

Examples

The examples can be found here: https://mmomtchev.github.io/rlayers/

Next.js

When using with Next.js, you have to install next-transpile-modules:

npm install --save next-transpile-modules

And then create the following next.config.js:

const withTranspile = require('next-transpile-modules')(['ol', 'rlayers']);
module.exports = withTranspile({experimental: {esmExternals: 'loose'}});

It is known to work with Next.js 10 to Next.js 13. You can check rlayers-npm-tests repository for examples for working configurations.

Server-Side Rendering

Server-side rendering of map components is difficult - there is still no comprehensive solution. Besides the obvious complexities of rendering on canvas outside the browser, one of the major issues is that server-side rendering runs before the browser layout flowing - and thus must work independent of layout and resolution.

The best solution is to use a WMS-compatible server (such as Geoserver) and to serve prerendered maps over WMS - eventually replacing the initial image by a canvas.

An intermediate solution, which does not require extensive server-side investment (such as Geoserver), but is limited to static layout(s), is to prerender one (or one per screen size) image to be used as a temporary place-holder until the map is loading. In this case, at least some devices, will get an ugly looking map for the first few seconds.

Pushing the initial tiles is also an option:

  • when combined with a WMS-server it could deliver pixel-perfect maps with on the first HTTP request
  • without a WMS-server it could still avoid doing a large number of HTTP requests on the first load

Currently, server-side rendering of raster layers on fixed map sizes has reached POC status and an online demo is accessible at https://rlayers-ssr.meteo.guru/. The code can be found in the ssr branch of this project. The next.js project can be found at https://github.com/mmomtchev/rlayers-ssr-demo.git. This is still not a user-friendly, install-and-run project. Take a look at pages/index.js if you want see how it is meant to be used.

As of March 2022, SSR support is stale and I am not working on it anymore.

Google Maps API Support

The Google Maps API is not open and although it is now supported out-of-the-box by OpenLayers starting from version 9.0, it requires a paid subscription (with an eventual trial period). Adding Google Maps support is not possible unless someone is willing to sponsor it.

API

You can browse the full documentation at https://mmomtchev.github.io/rlayers/api.

License

ISC

Package Sidebar

Install

npm i rlayers

Weekly Downloads

1,718

Version

2.3.2

License

ISC

Unpacked Size

21.2 MB

Total Files

927

Last publish

Collaborators

  • mmomtchev