Global

Members

absolutelyPostioned :boolean

Whether the map-logo is absolutely postioned or not

Type:
  • boolean
Source:

addAllLayersText :String

Optional text to be shown in button to add all layers

Type:
  • String
Source:

addressdetails :Number

Include a breakdown of the address into elements.

Type:
  • Number
Source:

addSelectedLayersText :String

Optional text to be shown in button to add selected layers

Type:
  • String
Source:

alignment :String

The alignment of the sub components.

Type:
  • String
Source:

allowDeselect :Boolean

Whether it's allowed to deselect a children or not.

Type:
  • Boolean
Source:

animate :Boolean

Whether the zoom in shall be animated. Defaults to true.

Type:
  • Boolean
Source:

animateOptions

The options for the zoom in animation. By default zooming in will take 1000 milliseconds and an in-and-out easing (which starts slow, speeds up, and then slows down again) will be used.

Source:

animationDuration :Number

The duration of the animation in milliseconds. Pass 0 to avoid animation. Default is 300.

Type:
  • Number
Source:

animationDuration :Number

The duration of the animation in milliseconds. Pass 0 to avoid animation. Default is 300.

Type:
  • Number
Source:

attributeBlacklist :Array

A list of attribute names to hide in the table.

Type:
  • Array
Source:

attributeFilter :Array

Optional array of attribute names to filter

Type:
  • Array
Source:

attributeNameColumnTitle :String

Optional title of the attribute name column

Type:
  • String
Source:

attributeNameColumnWidthInPercent :String

Optional value in percent representing the width of the attribute name column The width of attribute value column wil be calculated depending in this

Type:
  • String
Source:

attributeNames :Object

Optional object containing a mapping of attribute names in OL feature to custom ones

Type:
  • Object
Source:

attributeValueColumnTitle :String

Optional title of the attribute value column

Type:
  • String
Source:

bounded :Number

Restrict the results to only items contained with the bounding box. Restricting the results to the bounding box also enables searching by amenity only. For example a search query of just "[pub]" would normally be rejected but with bounded=1 will result in a list of items matching within the bounding box.

Type:
  • Number
Source:

(constant) buttonCoords

Setup

Source:

cancelText :String

Optional text to be shown in cancel button

Type:
  • String
Source:

children :Object

The children of the MapProvider.

Type:
  • Object
Source:

children :Object

The children.

Type:
  • Object
Source:

children :Object

The children of this group. Typically a set of ToggleButtons.

Type:
  • Object
Source:

children :Array

The children.

Type:
  • Array
Source:

children :node

The children to show in the Window.

Type:
  • node
Source:

children :Node

The children of the CircleMenuItem. Should be just one Node.

Type:
  • Node
Source:

children :node

The children to show in the Window.

Type:
  • node
Source:

children :Element

The children to render.

Type:
  • Element
Source:

children :node

The children to show in the Window.

Type:
  • node
Source:

children :Node

The children of the CircleMenu. Most common are buttons.

Type:
  • Node
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

A class name string to use on surrounding div.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

Optional CSS class to add to the table.

Type:
  • String
Source:

className :String

Optional CSS class

Type:
  • String
Source:

className :String

Optional additional className that will be added to rnd.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

An additional className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

className :String

The className which should be added.

Type:
  • String
Source:

clickToDrawText :String

Tooltip which will be shown on map mouserover after measurement button was activated.

Type:
  • String
Source:

closable :boolean

Whether to allow closing or not.

Type:
  • boolean
Source:

collapseTooltip :String

The tooltip of the collapse button.

Type:
  • String
Source:

collapsible :boolean

Whether to allow collasping or not.

Type:
  • boolean
Source:

columnDefs :Object

Custom column definitions to apply to the given column (mapping via key). See https://ant.design/components/table/#Column.

Type:
  • Object
Source:

continueAngleMsg :String

Tooltip which will be shown after angle measurement button was toggled and at least one click in the map is occured.

Type:
  • String
Source:

continueLineMsg :String

Tooltip which will be shown after line measurement button was toggled and at least one click in the map is occured.

Type:
  • String
Source:

continuePolygonMsg :String

Tooltip which will be shown after polygon measurement button was toggled and at least one click in the map is occured.

Type:
  • String
Source:

countrycodes :String

Limit search results to a specific country (or a list of countries).

should be the ISO 3166-1alpha2 code, e.g. gb for the United Kingdom, de for Germany, etc.

Type:
  • String
Source:

crsApiUrl :String

The API to query for CRS definitions default: http://epsg.io

Type:
  • String
Source:

decimalPlacesInTooltips

How many decimal places will be allowed for the measure tooltips. Default is 2.

Source:

defaultValue :Array.<String>|String

The default value(s). Default is 0

Type:
  • Array.<String> | String
Source:

defaultValue :Array.<String>|String

The default value(s).

Type:
  • Array.<String> | String
Source:

delta

The delta to zoom when clicked. Defaults to positive 1 essentially zooming-in. Pass negative numbers to zoom out.

Source:

diameter :Number

The diameter of the CircleMenu in pixels. Default is 100.

Type:
  • Number
Source:

digitizeLayerName :String

Name of system vector layer which will be used for digitize features.

Type:
  • String
Source:

dispatch :function

The dispatch function.

Type:
  • function
Source:

dispatch :function

The dispatch function.

Type:
  • function
Source:

draggable :boolean

Whether to allow dragging or not.

Type:
  • boolean
Source:

drawType :String

Whether the line, point, polygon, circle, rectangle or text shape should be drawn.

Type:
  • String
Source:

editType :String

Whether the digitize feature should be deleted, copied or modified. be drawn.

Type:
  • String
Source:

emptyTextPlaceholderText :String

The empty text set if no value is given / provided

Type:
  • String
Source:

extent :Array

The array extent[minx, miny, maxx, maxy] (the values must be in the maps coordination system) or instance of Ol SimpleGeometry that the map should zoom to.

Type:
  • Array
Source:

extraParams :Object

An object containing additional request params like "{HEIGHT: 400}" will be transformed to "&HEIGHT=400" an added to the GetLegendGraphic request.

Type:
  • Object
Source:

feature :OlFeature

Feature for which the properties should be shown

Type:
  • OlFeature
Source:

features :Array

The features to show in the grid and the map (if set).

Type:
  • Array
Source:

featureStyle :ol.Style|ol.FeatureStyleFunction

The default style to apply to the features.

Type:
  • ol.Style | ol.FeatureStyleFunction
Source:

fillColor :String

Fill color of the measurement feature.

Type:
  • String
Source:

filterFunction :function

An optional array-filter function that is applied to every layer and subLayer. Return false to exclude this layer from the layerTree or true to include it.

Compare MDN Docs for Array.prototype.filter: https://mdn.io/array/filter

Type:
  • function
Source:

fitOptions :Object

Options for fitting to the given extent. See http://openlayers.org/en/latest/apidoc/ol.View.html#fit

Type:
  • Object
Source:

follow :Boolean

Whether to follow the current position.

Type:
  • Boolean
Source:

fontIcon :String

The classname of an icon of an iconFont. Use either this or icon.

Type:
  • String
Source:

format :String

Output format.

Type:
  • String
Source:

formatString :String

The moment.js compliant format string for the slider tooltip.

Type:
  • String
Source:

height :number|string

The height of the panel.

Type:
  • number | string
Source:

highlightStyle :ol.Style|ol.FeatureStyleFunction

The highlight style to apply to the features.

Type:
  • ol.Style | ol.FeatureStyleFunction
Source:

icon :String

The font awesome icon name.

Type:
  • String
Source:

id :String

id of the component will be filled automatically if not provided

Type:
  • String
Source:

imageHeight :String

The image height

Type:
  • String
Source:

imageSrc :String

The imageSrc (required property).

Type:
  • String
Source:

imageSrc :String

The image src.

Type:
  • String
Source:

inputProps :Object

Object of props that should be passed to the input field.

Type:
  • Object
Source:

keyFunction :function

A Function that creates the rowkey from the given feature. Receives the feature as property. Default is: feature => feature.ol_uid

Type:
  • function
Source:

layer :ol.layer.Layer

The layer you want to display the legend of.

Type:
  • ol.layer.Layer
Source:

layer :ol.layer.Base

The layer to handle.

Type:
  • ol.layer.Base
Source:

layerName :String

The name of the vector layer presenting the features in the grid.

Type:
  • String
Source:

layerQueryableText :Object

Optional text to be shown in Tooltip for a layer that can be queried

Type:
  • Object
Source:

layers :Array

The layers that should be handled. Default is: [].

Type:
  • Array
Source:

layerTextTemplateFn :function

Function returning a span with the textual representation of this layer Default: Title of the layer and its abstract (if available)

Type:
  • function
Source:

limit :Number

Limit the number of returned results.

Type:
  • Number
Source:

map :ol.Map

The map the features should be rendered on. If not given, the features will be rendered in the table only.

Type:
  • ol.Map
Source:

map :ol.Map

Instance of OL map this component is bound to.

Type:
  • ol.Map
Source:

map :ol.Map|Promise

The map can be either an OlMap or a Promise that resolves with an OlMap if your map is created asynchronously.

Type:
  • ol.Map | Promise
Source:

map :OlMap

Instance of OL map this component is bound to.

Type:
  • OlMap
Source:

map :OlMap

Instance of OL map this component is bound to.

Type:
  • OlMap
Source:

map :Ol.Map

The map

Type:
  • Ol.Map
Source:

map :OlMap

Instance of OL map this component is bound to.

Type:
  • OlMap
Source:

map :OlMap

Instance of OL map this component is bound to.

Type:
  • OlMap
Source:

map :OlMap

Optional instance of OlMap which is used if onLayerAddToMap is not provided

Type:
  • OlMap
Source:

map :Object

The ol.map where the map will zoom to.

Type:
  • Object
Source:

(constant) mapPromise

Create the OlMap (you could do some asynchronus stuff here).

Source:

max :String

The maximum value.

Type:
  • String
Source:

measureLayerName :String

Name of system vector layer which will be used to draw measurement results.

Type:
  • String
Source:

measureTooltipCssClasses

CSS classes we'll assign to the popups and tooltips from measuring. Overwrite this object to style the text of the popups / overlays, if you don't want to use default classes.

Source:

measureType :String

Whether line, area or angle will be measured.

Type:
  • String
Source:

min :String

The minimum value.

Type:
  • String
Source:

minChars :Number

The minimal amount of characters entered in the input to start a search.

Type:
  • Number
Source:

modalPromptCancelButtonText :String

Text string for Cancel button of the modal.

Type:
  • String
Source:

modalPromptOkButtonText :String

Text string for OK button of the modal.

Type:
  • String
Source:

modalPromptTitle :String

Title for modal used for input of labels for digitize features.

Type:
  • String
Source:

multipleDrawing :Boolean

Used to allow / disallow multiple drawings at a time on the map. Default is false. TODO known issue: only label of the last drawn feature will be shown!

Type:
  • Boolean
Source:

name :String

The name of this group.

Type:
  • String
Source:

nodeTitleRenderer :function

A function that can be used to pass a custom node title. It can return any renderable element (String, Number, Element etc.) and receives the layer instance of the current tree node.

Type:
  • function
Source:

nominatimBaseUrl :String

The Nominatim Base URL. See http://wiki.openstreetmap.org/wiki/Nominatim

Type:
  • String
Source:

onCancel :function

Optional function that is called if cancel button is clicked

Type:
  • function
Source:

onChange :function

Called when the value changes.

Type:
  • function
Source:

onChange :function

The onChange handler for the upload input field.

Type:
  • function
Source:

onChange :function

Callback function for onChange.

Type:
  • function
Source:

onDrawEnd

Listener function for the 'drawend' event of an ol.interaction.Draw. See http://openlayers.org/en/latest/apidoc/ol.interaction.Draw.Event.html for more information.

Source:

onDrawStart

Listener function for the 'drawstart' event of an ol.interaction.Draw. See http://openlayers.org/en/latest/apidoc/ol.interaction.Draw.Event.html for more information.

Source:

onError :function

Will be called if geolocation fails.

Type:
  • function
Source:

onGeolocationChange :function

Will be called when position changes. Receives an object with the properties position, accuracy, heading and speed

Type:
  • function
Source:

onLayerAddToMap :function

Optional function being called when onAddSelectedLayers or onAddAllLayers is triggered

Type:
  • function
Source:

onResize :function

Function called when onResize is triggered by react-rnd

Type:
  • function
Source:

onResizeStart :function

Function called when onResizeStart is triggered by react-rnd

Type:
  • function
Source:

onResizeStop :function

Function called when onResizeStop is triggered by react-rnd

Type:
  • function
Source:

onRowClick :function

Optional callback function, that will be called on rowclick.

Type:
  • function
Source:

onRowMouseOut :function

Optional callback function, that will be called on rowmouseout.

Type:
  • function
Source:

onRowMouseOver :function

Optional callback function, that will be called on rowmouseover.

Type:
  • function
Source:

onRowSelectionChange :function

Optional callback function, that will be called if the selection changes.

Type:
  • function
Source:

onSelect :function

An onSelect function which gets called with the selected item as it is returned by nominatim.

Type:
  • function
Source:

onSelect :String

A function

Type:
  • String
Source:

onSelectionChange :function

Optional function that is called if selection has changed.

Type:
  • function
Source:

onZoomLevelSelect :function

The onZoomLevelSelect function. Pass a function if you want something different than the resolution of the passed map.

Type:
  • function
Source:

orientation :String

The orientation of the children. Either vertical (default) or horizontal.

Type:
  • String
Source:

parentId :String

The id of the parent component default: app

Type:
  • String
Source:

polygon_geojson :Number

Output geometry of results in geojson format.

Type:
  • Number
Source:

position :Array.<Number>

An array containing the x and y coordinates of the CircleMenus Center.

Type:
  • Array.<Number>
Source:

predefinedCrsDefinitions :Array

An array of predefined crs definitions habving at least value (name of CRS) and code (e.g. EPSG-code of CRS) property

Type:
  • Array
Source:

pressed

Whether the measure button is pressed.

Source:

radius :Number

The radius of the CircleMenu in pixels.

Type:
  • Number
Source:

renderOption :function

A render function which gets called with the selected item as it is returned by nominatim. It must return an AutoComplete.Option.

Type:
  • function
Source:

resizeOpts :object

The enableResizing property is used to set the resizable permission of a resizable component. The permission of top, right, bottom, left, topRight, bottomRight, bottomLeft, topLeft direction resizing. If omitted, all resizer are enabled. If you want to permit only right direction resizing, set { top:false, right:true, bottom:false, left:false, topRight:false, bottomRight:false, bottomLeft:false, topLeft:false }.

Type:
  • object
Source:

resolutions :Array

The resolutions.

Type:
  • Array
Source:

rotationAngle :Number

The rotation Angle in degree.

Type:
  • Number
Source:

rowClassName :String|function

Optional CSS class to add to each table row or a function that is evaluated for each record

Type:
  • String | function
Source:

scales :Array

The scales.

Type:
  • Array
Source:

segmentAngles

Optional Segement of angles where to show the children. Default is [0, 360].

Source:

selectable :Boolean

Whether rows and features should be selectable or not.

Type:
  • Boolean
Source:

selectedName :String

The value fo the name attribute of the children to select/press initially.

Type:
  • String
Source:

selectFillColor :String

Fill color of selected digitize feature.

Type:
  • String
Source:

selectStrokeColor :String

Stroke color of selected digitize feature.

Type:
  • String
Source:

selectStyle :ol.Style|ol.FeatureStyleFunction

The select style to apply to the features.

Type:
  • ol.Style | ol.FeatureStyleFunction
Source:

showMarker :Boolean

Whether to show a map marker at the current position.

Type:
  • Boolean
Source:

showMeasureInfoOnClickedPoints :Boolean

Determines if a marker with current measurement should be shown every time the user clicks while drawing. Default is false.

Type:
  • Boolean
Source:

strokeColor :String

Stroke color of the measurement feature.

Type:
  • String
Source:

style :OlStyleStyle

Style object for drawn feature.

Type:
  • OlStyleStyle
Source:

style :Boolean

An object containing style informations. Applied to Toolbar.

Type:
  • Boolean
Source:

style :Object

The style object

Type:
  • Object
Source:

style :Object

The style object

Type:
  • Object
Source:

style :Object

The style object

Type:
  • Object
Source:

style :Object

The style object passed to the AutoComplete.

Type:
  • Object
Source:

syncWithMap :Boolean

Set to false to not listen to the map moveend event.

Type:
  • Boolean
Source:

title :string

The title text to be shown in the window Header.

Type:
  • string
Source:

title :string

The title text to be shown in the window header.

Type:
  • string
Source:

titleBarHeight :number

The height of the TitleBar.

Type:
  • number
Source:

titleText :String

Optional text to be shown in panel title

Type:
  • String
Source:

tools

Source:

tools :Array.<object>

Additional elements to show at the right side of the Titlebar.

Type:
  • Array.<object>
Source:

tooltip :String

The tooltip to be shown on hover.

Type:
  • String
Source:

tooltipPlacement :String

The position of the tooltip.

Type:
  • String
Source:

trackingoptions :Object

The openlayers tracking options.

Type:
  • Object
Source:

useRange :Boolean

Whether to allow range selection.

Type:
  • Boolean
Source:

userMenu :Element

The react element representing the user menu

Type:
  • Element
Source:

userName :String

The user aname.

Type:
  • String
Source:

value :Array.<String>|String

The current value(s).

Type:
  • Array.<String> | String
Source:

viewbox :String

The preferred area to find search results in ,,,.

Type:
  • String
Source:

width :number|string

The width of the panel.

Type:
  • number | string
Source:

wmsLayer :Object

Object containing layer information

Type:
  • Object
Source:

wmsLayers :Array

Array containing layers (e.g. Capability.Layer.Layer of ol capabilities parser)

Type:
  • Array
Source:

zoomLevel :Number

The zoomLevel.

Type:
  • Number
Source:

zoomToExtent :Boolean

Whether the map should center on the current feature's extent on init or not.

Type:
  • Boolean
Source:

Methods

clearDrawFeatures()

Source:

clearOperationFeatures()

Source:

componentDidMount()

The componentDidMount function

Source:

doRender()

The wrapper is needed to reRender the DomTree. Don't worry about it. You probably won't need it in your application.

Source:

doRender()

Source:

doRender()

wrapper function for render

Source:

getInitials() → {String}

Determine initials for a given user name. The username will be splitted by a whitespace and the first character of each part (capital letter) is added to the initials. e.g. 'John Doe' leads to 'JD'

Source:
Returns:

initials if the user name.

Type
String

getOptionsFromMap: Helper function generate Option scale components based on an existing instance of Ol.Map()

Source:

isVisibleComponent(WrappedComponent, options) → {Component}

The HOC factory function.

Wrapped components will be checked against the activeModules array of the state: If the wrapped component (identified by it's name) is included in the state, it will be rendered, if not, it wont.

Parameters:
Name Type Description
WrappedComponent Component

The component to wrap and enhance.
options Object

The options to apply.
Source:
Returns:

The wrapped component.

Type
Component

mappify(WrappedComponent) → {Component}

The HOC factory function.

Wrapped components will receive the map from the context as a prop.

Parameters:
Name Type Description
WrappedComponent Component

The component to wrap and enhance.
Source:
Returns:

The wrapped component.

Type
Component

onChange(e)

The onChange handler of the input fields.

Parameters:
Name Type Description
e event

The change event of the input field.
Source:

onChange(pressed, evt)

A simple handler.

Parameters:
Name Type Description
pressed *
evt *
Source:

onClick()

fetch capabilities document onClick and re-render on success

Source:

onSelect(selected)

The default onSelect method if no onSelect prop is given. It zooms to the selected item.

Parameters:
Name Type Description
selected object

The selected item as it is returned by nominatim.
Source:

pushScaleOption: Helper function to create a Option scale component based on a resolution and the Ol.View(resolution, mv)

Parameters:
Name Type Description
resolution Number

map cresolution to generate the option for
mv Ol.View

The map view
Source:

renderOption(item) → {AutoComplete.Option}

Create an AutoComplete.Option from the given data.

Parameters:
Name Type Description
item Object

The tuple as an object.
Source:
Returns:

The returned option

Type
AutoComplete.Option

setProjection()

set map projection and perform client-side raster reprojection from OSM (EPSG:3857) to arbitrary projection given in crsObj

original code of setProjection can be found here: https://openlayers.org/en/latest/examples/reprojection-by-code.html

Source:

timeLayerAware(WrappedComponent, layers) → {React.Component}

HOC that updates layers based on the wrapped components time instant or interval. Can for example be used with the TimeSlider component.

Parameters:
Name Type Description
WrappedComponent React.Component

a component with an onChange prop
layers Array

array of layer configurations
Source:
Returns:

a time layer aware component

Type
React.Component

triggerRerenderingWithInvertedVisibility()

Source: