OpenLayers Explorer

Namespace: olexp

olexp

Classes

Explorer

Methods

<static> destroy(explorer)

Destroy all w2ui and openlayer resources. The explorer is no longer valid after calling this method.

Parameters:
Name Type Description
explorer olexp.ExplorerAPI

Explorer API object

Type Definitions

ExplorerAPI

The objects exposed by the Explorer API

Type:
  • object
Properties:
Name Type Description
details external:jQuery.fn.w2grid

Layer details panels. Display the details of the later that is currently selected in the outline sidebar.
layout external:jQuery.fn.w2layout

Explorer layout object. Contains the map, toolbar, and navigation panels. Can maintain up to 3 additional panels that are stretchable and resizable.
manager olexp.manager.ManagerAPI

Explorer item manager
map external:ol.Map

ol3 map object used to add layers, overlays, controls, etc.
navigation external:jQuery.fn.w2layout

Layer manager navigation panel. The panel that contains the outline sidebar and detail grid.
options olexp.ExplorerOptions

Explorer options object that contains the options argument passed to the explorer constructor.
outline external:jQuery.fn.w2sidebar

Layer manager outline panel that allows the user to manage the ordering and properties of the map layers.
toolbar external:jQuery.fn.w2toolbar

Explorer toolbar that contains map and layers controls.

ExplorerOptions

Explorer constructor options to override default behavior.

Type:
  • object
Properties:
Name Type Argument Description
controls object <optional>

Enables built-in toolbar controls

Properties
Name Type Argument Default Description
editsettings boolean <optional>
 true

Enable settings editor control
exportmap boolean <optional>
 true

Enable map exporting control
graticule boolean <optional>
 true

Enable graticule control
layercontrol boolean <optional>
 true

Enable Layer Control control
layermanager boolean <optional>
 true

Enable Layer Manager control
layermenu boolean <optional>
 true

Enable Layer Menu control
measure boolean <optional>
 true

Enable measurement control
toolbarhide boolean <optional>
 true

Enable toolbar hide control
details external:jQuery.fn.w2layout.panels <optional>

Options for details panel. Below are only those different from w2ui defaults.

Properties
Name Type Argument Default Description
hidden boolean <optional>
 true

Visibility
resizable boolean <optional>
 true

Resizability
size string <optional>
 '25%'

Size
type string <optional>
 'preview'

Type of panel
layers external:jQuery.fn.w2sidebar.nodes <optional>

Options for layers node. Below are only those different from w2ui defaults.

Properties
Name Type Argument Default Description
expanded boolean <optional>
 true

Indicate if initially expanded
group boolean <optional>
 true

Indicate if a group
img string <optional>
 'icon-folder'

CSS selector of node image
text string <optional>
 'Layers'

Node text
map external:jQuery.fn.w2layout.panels <optional>

Options for map panel. Below are only those different from w2ui defaults.

Properties
Name Type Argument Default Description
type string <optional>
 'main'

Type of panel
navigation external:jQuery.fn.w2layout.panels <optional>

Options for navigation panel. Below are only those different from w2ui defaults.

Properties
Name Type Argument Default Description
resizable boolean <optional>
 true

Resizability
size string <optional>
 '15%'

Size
type string <optional>
 'left'

Type of panel
olcontrols object <optional>

Enables OpenLayers map controls

Properties
Name Type Argument Default Description
fullscreen boolean <optional>
 true

Enable full screen
mouseposition boolean <optional>
 true

Enable mouse position
overviewmap boolean <optional>
 true

Enable overview map
rotate boolean <optional>
 true

Enable rotation
scaleline boolean <optional>
 true

Enable scale line
zoom boolean <optional>
 true

Enable zoom
zoomslider boolean <optional>
 true

Enable zoom slider
zoomtoextent boolean <optional>
 true

Enable zoom to extent
olinteractions object <optional>

Enables OpenLayers map interactions

Properties
Name Type Argument Default Description
draganddrop boolean <optional>
 true

Enable drag-n-drop
olmap external:ol.Map <optional>

Options for ol3 map. Below are only those different from ol3 defaults.

Properties
Name Type Argument Default Description
controls array <optional>
 []

Controls initially added to the map.
view external:ol.View | undefined <optional>
 new ol.View({center: [0,0], zoom: 4})

The map's initial view.
outline external:jQuery.fn.w2layout.panels <optional>

Options for outline panel. Below are only those different from w2ui defaults.

Properties
Name Type Argument Default Description
type string <optional>
 'main'

Type of panel
overlays external:jQuery.fn.w2sidebar.nodes <optional>

Options for overlays node. Below are only those different from w2ui defaults.

Properties
Name Type Argument Default Description
expanded boolean <optional>
 true

Indicate if initially expanded
group boolean <optional>
 true

Indicate if a group
img string <optional>
 'icon-folder'

CSS selector of node image
text string <optional>
 'Overlays'

Node text
settings olexp.ExplorerSettings <optional>

Advanced settings for customizing various controls and menus look and feel.
toolbar external:jQuery.fn.w2layout.panels <optional>

Options for toolbar panel. Below are only those different from w2ui defaults.

Properties
Name Type Argument Default Description
size string <optional>
 '40'

Size
style string <optional>
 'padding: 5px;'

Additional CSS style
type string <optional>
 'top'

Type of panel

ExplorerSettings

Advanced settings for customizing various controls and menus look and feel.

Type:
  • object
Properties:
Name Type Argument Description
control object <optional>

olexp.control settings

Properties
Name Type Argument Description
EditSettings object <optional>

Edit Settings control settings

Properties
Name Type Argument Default Description
form external:jQuery.fn.w2form.properties <optional>

w2form properties
hint string <optional>
 'Edit Controls'

Control button hover hint text
popup external:jQuery.fn.w2popup.properties <optional>

w2popup properties
span number <optional>
 6

Span size of control fields
ExportMap object <optional>

Export Map control settings

Properties
Name Type Argument Default Description
filename string <optional>
 'map.png'

Default filename of saved map
hint string <optional>
 'Export map'

Control button hover hint text
Graticule object <optional>

Graticule control settings

Properties
Name Type Argument Default Description
enable boolean <optional>
 false

Enable grid line display
form external:jQuery.fn.w2form.properties <optional>

w2form properties
hint string <optional>
 'Edit Controls'

Control button hover hint text
options object <optional>

ol.style.Stroke options
popup external:jQuery.fn.w2popup.properties <optional>

w2popup properties
span number <optional>
 6

Span size of control fields
LayerControlTile object <optional>

Layer Control Tile control settings

Properties
Name Type Argument Default Description
form external:jQuery.fn.w2form.properties <optional>

w2form properties
hint string <optional>
 'Edit Controls'

Control button hover hint text
popup external:jQuery.fn.w2popup.properties <optional>

w2popup properties
span number <optional>
 6

Span size of control fields
LayerControlVector object <optional>

Layer Control Vector control settings

Properties
Name Type Argument Default Description
form external:jQuery.fn.w2form.properties <optional>

w2form properties
hint string <optional>
 'Edit Controls'

Control button hover hint text
popup external:jQuery.fn.w2popup.properties <optional>

w2popup properties
span number <optional>
 6

Span size of control fields
LayerManager object <optional>

Layer Manager control settings

Properties
Name Type Argument Default Description
hintDetailsHide string <optional>
 'Hide details'

Hide details control button hover hint text
hintDetailsShow string <optional>
 'Show details'

Show details control button hover hint text
hintMoveDown string <optional>
 'Move item down'

Move item down control button hover hint text
hintMoveUp string <optional>
 'Move item up'

Move item up control button hover hint text
hintOutlineHide string <optional>
 'Hide outline'

Hide outline control button hover hint text
hintOutlineShow string <optional>
 'Show outline'

Show outline control button hover hint text
LayerMenu object <optional>

Layer Menu control settings

Properties
Name Type Argument Default Description
arrow string <optional>
 true

Display arrow for drop down menu
hint string <optional>
 'Item Properties'

Control button hover hint text
text string <optional>
 ''

Button text
Measurement object <optional>

Measurement control settings

Properties
Name Type Argument Default Description
hintArea string <optional>
 'Measure area'

Area measurement control button hover hint text
hintLength string <optional>
 'Measure length'

Length measurement control button hover hint text
ToolbarHide object <optional>

Toolbar Hide control settings

Properties
Name Type Argument Default Description
hint string <optional>
 'Hide toolbar'

Hide toolbar control button hover hint text
measure object <optional>

olexp.measure settings

Properties
Name Type Argument Description
Tool object <optional>

Properties menu settings

Properties
Name Type Argument Default Description
continueLineMsg string <optional>
 'Click to continue drawing the line'

Message displayed to continue drawing line
continuePolygonMsg string <optional>
 'Click to continue drawing'

Message displayed to continue drawing polygon
helpTooltipOffset Array <optional>
 [20, 0]

Pixel offset of help tooltip
helpTooltipPositioning string <optional>
 'center-left'

Position of help tooltip
measuredStyle external:ol.style.Style <optional>

Style of a measurement vector after completed.
measuredStyle external:ol.style.Style <optional>

Style of a measurement vector during drawing.
measureTooltipOffset Array <optional>
 [0, -20]

Pixel offset of measuring tooltip
measureTooltipPositioning string <optional>
 'bottom-center'

Position of measuring tooltip
messageStart string <optional>
 'Click to start. Double click to stop.'

Message to display to start drawing.
menu object <optional>

olexp.menu settings

Properties
Name Type Argument Description
Properties object <optional>

Properties menu settings

Properties
Name Type Argument Default Description
field number <optional>
 35

Field size
form external:jQuery.fn.w2form.properties <optional>

w2form properties
popup external:jQuery.fn.w2popup.properties <optional>

w2popup properties
span number <optional>
 4

Span size of control fields
text string <optional>
 'Properties'

Context menu text
Remove object <optional>

Remove menu settings

Properties
Name Type Argument Default Description
text string <optional>
 'Remove'

Context menu text
Zoom object <optional>

Zoom menu settings

Properties
Name Type Argument Default Description
text string <optional>
 'Zoom'

Context menu text
ol object <optional>

olexp.ol settings

Properties
Name Type Argument Description
ToolbarShow object <optional>

ol3 map control settings

Properties
Name Type Argument Default Description
html string <optional>
 'T'

HTML to display in control
title string <optional>
 'Show toolbar'

Control hover hint
util object <optional>

olexp.util settings

Properties
Name Type Argument Description
cluster function <optional>

Function that returns ol.style.Style for a given cluster size.
Point external:ol.style.Style <optional>

Point style
LineString external:ol.style.Style <optional>

LineString style
Polygon external:ol.style.Style <optional>

Polygon style
MultiPoint external:ol.style.Style <optional>

MultiPoint style
MultiLineString external:ol.style.Style <optional>

MultiLineString style
MultiPolygon external:ol.style.Style <optional>

MultiPolygon style