rlayers 3.2.0

The initial view parameters - {center, zoom}, reset only on full component reload

External view state with React semantics

CSS class

Width when not using CSS

Height when not using CSS

Do not include any default controls. Cannot be changed once set.

Do not include any default interactions. Cannot be changed once set.

View projection

Called immediately on click

Called on single click when the double click timer has expired

Called on double click

Called when the user starts panning the map

Called when the user stops panning the map

Called on every pointer move when dragging, e.preventDefault() can be used to stop OpenLayers from also panning the map

Called on every pointer movement, use with care

Called after a layer has been rendered

Called before layers are composed

Called after layers are composed

Called after completely rendering the map

Called on every change

A set of properties that can be accessed later by .get()/.getProperties()

Extent of the map, cannot be dynamically modified

Minimum resolution, cannot be dynamically modified

Maximum resolution, cannot be dynamically modified

If true, the view will always animate to the closest zoom level after an interaction; false means intermediary zoom levels are allowed.

Minimum zoom level

Maximum zoom level

Allow rotation of the map. Cannot be updated once the map is created.

Rotation constraint. false means no constraint. true means no constraint, but snap to zero near zero. A number constrains the rotation to that number of values. For example, 4 will constrain the rotation to 0, 90, 180, and 270 degrees. Cannot be updated once the map is created.

Center of the map

Zoom level, 0 is the whole world, 28 is maximum resolution

Optional resolution in meters per pixel

When set, it takes precedence over the zoom level

OpenLayers geometry, mutually exclusive with feature

OpenLayers style

A set of properties that can be accessed later by .get()/.getProperties()

Bind the RFeature to an OpenLayers Feature, mutually exclusive with geometry

When bound, the RFeature will automatically update its state when the Feature changes

geometry is usually a better choice for a dynamic feature

Called immediately on click

Called on single click when the double click timer has expired

Called on double click

Called on every pointer move when dragging, e.preventDefault() can be used to stop OpenLayers from also panning the map

Called when the object is released

Called on every pointer movement over the RFeature, use sparingly

Called once when the pointer moves over the RFeature

Called once when the pointer moves out of the RFeature

Called on every change

Content to be displayed

CSS class

Automatically pan the map when the element is rendered

Offset the overlay on the x and y axes relative to the containing feature

Anchor point

Automatically position the overlay so that it fits in the viewport

Called immediately on click

Trigger action, 'click' or 'hover'

Delay in 'hover' mode

Continuous tracking

Tracking options (W3C standard)

Projection for the returned coordinates

Called on every change

Called on error

The current map

The current layer

The current vector layer

The current RFeature

The current location

The current style

The current style array

The current RMap component

The current RLayer component

The current RLayerVector component

The current RLayerVectorTile component

The current RFeature component

URL for loading features can be a function of type FeatureUrlFunction , requires format

Width of the frame around the viewport that shall be rendered too so that the symbols, whose center is outside of the viewport, but are partially inside, can be rendered

this property currently does not support dynamic updates

OpenLayers features that will be loaded

This property currently does not support dynamic updates.

Prefer nesting JSX components inside the layer in this case.

Format of the features when url is used

this property currently does not support dynamic updates

Use a custom loader instead of XHR

OpenLayers default style for features without style

OpenLayers option to specify LoadingStrategy default is all strategy

Wrap features around the antimeridian. Cannot be dynamically updated once the layer is created.

Default onClick handler for loaded features

Called when a feature is added, not called for features already present at creation, ie loaded via features or url

use onFeaturesLoadEnd for features loaded via url

Called upon initiating the request for new features

Called when the external features have been loaded from url

e.features will contain the new features

This callback is invoked before the features are loaded

Called on failure while loading features

onPointerMove handler for all loaded features

onPointerEnter handler for all loaded features

onPointerLeave handler for all loaded features

Clustering distance

Blurring

Radius

Weight function for each RFeature, weight goes from 0 to 1

OpenLayers features that will be loaded

This property currently does not support dynamic updates.

Prefer using nested JSX components in this case.

Triggered when all currently visible tiles have finished loading

Called when a tile starts loading

Called when tile loading results in an error

Stadia Maps layer name

API key

Retina screen mode, @default false

An URL for loading the tiles with the usual {x}{y}{z} semantics

An URL for loading the tiles with the usual {x}{y}{z} semantics

Custom OpenLayers TileGrid for sources that do not cover the world or use non-standard zoom levels Take care to pass a constant object, because otherwise the layer must be recreated at every render (ie pass a constant variable, not an anonymous {})

By default, OpenLayers uses interpolation to smooth images when zooming. Setting this value to true will override that.

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.

An URL for loading the tiles with the usual {x}{y}{z} semantics

Custom OpenLayers TileGrid for sources that do not cover the world or use non-standard zoom levels Take care to pass a constant object, because otherwise the layer must be recreated at every render (ie pass a constant variable, not an anonymous {})

By default, OpenLayers uses interpolation to smooth images when zooming. Setting this value to true will override that.

Custom element for rendering

An URL for a remote MBTiles file

Use multiple SQLite workers, refer to the ol-mbtiles for more information

Use a specific HTTP backend, refer to the ol-mbtiles for more information

Cache size in KBytes to use for SQLite

Maximum SQLite page size in bytes, reduce to 1024 if you have optimized your files

Optional list of layers to be retrieved

Style to be used for rendering the features You can use a dynamic style, but the property value must stay the same ie switching from a static OpenLayers style to a RefObject is not supported

Width of the frame around the viewport that shall be rendered too so that the symbols, whose center is outside of the viewport, but are partially inside, can be rendered

this property currently does not support dynamic updates

onClick handler for loaded features

onPointerMove handler for loaded features

onPointerEnter handler for loaded features

onPointerLeave handler for loaded features

Called after each metadata change to signal that the metadata has been loaded

Called by OpenLayers when the layer is ready to start rendering

The internal texture cache size in Kb. This needs to be large enough to render two zoom levels worth of tiles.

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.

URL for the WMTS getCapabilites request

Layer name

Called by OpenLayers when the layer is ready to start rendering

Called each time the component is rerendered if/after the WMTS capabilities have been acquired

Is it user-collapsible (some licenses do not allow it) @default true

Initial state @default true

A new HTML target for the map after switching to full-screen, can be used for CSS customization

The button label

The button label when active

The mouse-over tip

User-collapsible @default true

State @default true

Label when collapsed

Label

Width if not using CSS

Height if not using CSS

Label

automatically hide the control when the orientation is straight north

Minimum width

Use bars instead of a line

Label

Units for the scale line: 'degrees', 'imperial', 'nautical', 'metric', 'us'

Animation duration

Animation duration

Zoom in label instead of +

Zoom out label instead of -

Zoom in tip

Zoom out tip

Amount to zoom at each step

render function to be passed the feature and the resolution for dynamic styles

a dynamic style cannot become a static style or the inverse

An optional cache size, valid only for dynamic styles

The cache hashing function, must return a unique string for every unique style computed by the rendering function

zIndex controls which features are drawn over which features when they overlap

Radius

color

Anchor. Default value is the icon center.

Units in which the anchor x value is specified. A value of 'fraction' indicates the x value is a fraction of the icon. A value of 'pixels' indicates the x value in pixels.

Units in which the anchor y value is specified. A value of 'fraction' indicates the x value is a fraction of the icon. A value of 'pixels' indicates the x value in pixels.

Color to tint the icon. If not specified, the icon will be left as is.

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you want to access pixel data with the Canvas renderer.

Image object for the icon. If the src option is not provided then the provided image must already be loaded. And in that case, it is required to provide the size of the image, with the imgSize option.

Offset, which, together with the size and the offset origin, define the sub-rectangle to use from the original icon image.

Origin of the offset: bottom-left , bottom-right , top-left or top-right .

Icon size in pixel. Can be used together with offset to define the sub-rectangle to use from the origin (sprite) icon image.

Image size in pixels. Only required if img is set and src is not, and for SVG images in Internet Explorer 11. The provided imgSize needs to match the actual size of the image.

Image source URI.

Opacity

Rotate with view

Rotation

Scale

Displacement

Radius of the polygon

Outer radius

Inner radius

Number of points/edges

Rotation angle in radians, 0 is up

color

width

Canvas line cap style: 'butt', 'round' or 'square'

Canvas line join style: 'bevel', 'round' or 'miter

Line dash pattern.

The text that will be displayed

Font

Horizontal offset

Vertical offset

Overflow

Scale

Rotation

Text alignment 'left' | 'right' | 'center' | 'start' | 'end'

Padding in pixels around the text, [ top, right, bottom, left ]

Text placement

Text baseline

Animation duration

Zoom delta

Called on every change

A CSS class to be used for the box

An optional OpenLayers condition

Minimum area that needs to be selected

An optional OpenLayers condition

Called when the user starts dragging

Called on selection (note that this is the OpenLayers event, not the constructor property)

An optional OpenLayers condition

Kinetic parameters

Called on every change

An optional OpenLayers condition

Animation duration

Called on every change

Optionnal CSS class for styling the box

An optional OpenLayers condition

Animation duration

Use interaction for zooming out

Minimum area that can be selected

Called on every change

Type of the geometry

An optionnal condition for triggering the interaction

An optional OpenLayers condition to allow the interaction to finish

An optional OpenLayers condition to activate freehand drawing

Style for rendering while drawing, supports only Openlayers styles. Once the interaction is finished, the resulting feature will adopt the style of its layer.

Do not trigger pointer events while the interaction is active

Maximum number of points allowed per feature

Minimum number of points allowed per feature

Snap tolerance in pixels

Called on draw start

Called on draw end

Called on draw cancel

An optional OpenLayers condition

Animation duration

Pan delta

Called on every change

An optional OpenLayers condition

Animation duration

Zoom delta

Called on every change

An optionnal condition for triggering the interaction

An optional OpenLayers condition to allow removal of the feature

An optional OpenLayers condition to allow adding of a vertex

Style for rendering while drawing, supports only Openlayers styles. Once the interaction is finished, the resulting feature will adopt the style of its layer.

Snap tolerance in pixels

True hit detection based on feature shape

Called on modify start

Called on modify end

An optional OpenLayers condition

Zoom speed

Animation duration in ms

Center of zoom is the mouse position

Allow only integer zoom levels

Called on every change

Minimum angle in radians for rotation

Animation duration

Called on every change

Animation duration

Called on every change

Called on down event (click or touch) if it returns true, a drag sequence is started

Called on every move event while dragging

Called on every event, use with care

Called on every pointer move, use with care

Called on up event (end of click or touch)

Translatable features

Translatable layers

Filter translatable features

Hit-detection tolerance in pixels

Called when the translation is released

Called when the translation is started

Called on every pointer move while the translation is active