Typedef

Static Public Summary
public	APIOptions: object
public	AnyLayerConfig: SilentGroupLayerConfig \| CategoryLayerConfig \| EmptyLayerConfig \| XYZLayerConfig \| OSMLayerConfig \| StamenLayerConfig \| BingLayerConfig \| WMTSLayerConfig \| WMSLayerConfig \| TileWMSLayerConfig \| GeoJSONLayerConfig \| KMLLayerConfig \| InternalLayerConfig
public	AnyLayerConfig: SilentGroupLayerConfig \| CategoryLayerConfig \| EmptyLayerConfig \| XYZLayerConfig \| OSMLayerConfig \| StamenLayerConfig \| BingLayerConfig \| WMTSLayerConfig \| WMSLayerConfig \| TileWMSLayerConfig \| GeoJSONLayerConfig \| KMLLayerConfig \| InternalLayerConfig
public	ArcGISRESTFeatureSourceOptions: module:ol/source/Vector~Options Please note that a 'BBOX' or 'TILE' loadingStrategy is required
public	ArrowButtonOptions: g4uControlOptions
public	BaseLayerMixinOptions: object
public	BingLayerConfig: g4uLayerOptions A bing maps Layer (See http://openlayers.org/en/latest/apidoc/ol.source.BingMaps.html).
public	BingLayerConfig: g4uLayerOptions A bing maps Layer (See http://openlayers.org/en/latest/apidoc/ol.source.BingMaps.html).
public	ButtonActions: object
public	ButtonBoxOptions: object
public	ButtonConfig: object
public	CategoryLayerConfig: g4uLayerOptions The category contains other layer(s) and will appear as a category in the layer selector.
public	CategoryLayerConfig: g4uLayerOptions The category contains other layer(s) and will appear as a category in the layer selector.
public	CloseWindowButtonOptions: g4uControlOptions
public	CombinedZoomOptions: ComposedControlOptions
public	ComposedControlOptions: g4uControlOptions
public	Configs: object
public	ControlFactoryOptions: Object
public	ControlsConfig: object Inside of this object the controls are configured.
public	DrawButtonsOptions: g4uControlOptions
public	DropdownOptions: object
public	ElementPosition: object
public	EmptyLayerConfig: g4uLayerOptions The empty layer will show nothing (in case of a base layer a white background).
public	EmptyLayerConfig: g4uLayerOptions The empty layer will show nothing (in case of a base layer a white background).
public	Entry: Object
public	FeatureConfig: Object
public	FeatureConfig: Object
public	FeatureInteractionOptions: MapEventInteractionOptions
public	FeaturePopupOptions: object
public	FeatureTooltipOptions: object
public	Float: string[] \| string This describes the floating directions of an element.
public	G4UMapOptions: object
public	GeoJSONLayerConfig: g4uLayerOptions A GeoJSON Layer.
public	GeoJSONLayerConfig: g4uLayerOptions A GeoJSON Layer.
public	GeoLocationButtonOptions: g4uControlOptions
public	GroupButtonConfig: ButtonConfig
public	HelpButtonOptions: g4uControlOptions
public	HideableElement: Object
public	InfoButtonOptions: g4uControlOptions
public	InternalLayerConfig: g4uLayerOptions A layer whichs contents are completly defined in the config file.
public	InternalLayerConfig: g4uLayerOptions A layer whichs contents are completly defined in the config file.
public	InternalSourceConfig: SourceConfig An internal source whose features are defined directly in the config file.
public	InternalSourceConfig: SourceConfig An internal source whose features are defined directly in the config file.
public	KMLLayerConfig: g4uLayerOptions A KML Layer.
public	KMLLayerConfig: g4uLayerOptions A KML Layer.
public	KineticOptions: object
public	L10NOptions: object
public	LanguageSwitcherButtonOptions: g4uControlOptions
public	LanguageSwitcherMenuOptions: g4uControlOptions
public	LayerButton: object
public	LayerButtonConfig: ButtonConfig
public	LayerConfig: object
public	LayerSelectorOptions: g4uControlOptions
public	LayerSelectorOptions: g4uControlOptions
public	LinkButtonOptions: g4uControlOptions
public	LinkGeneratorButtonOptions: g4uControlOptions
public	LinkGeneratorOptions: g4uControlOptions
public	Localizable: Object<string, string> \| string
public	LogoOptions: g4uControlOptions
public	MapConfig: Object
public	MapEventInteractionOptions: object
public	MarkerOptions: object
public	MaximizeButtonOptions: g4uControlOptions
public	MeasurementButtonOptions: g4uControlOptions
public	MessageConstructorOptions: MessageDisplayOptions
public	MessageDisplayOptions: MessageReducedDisplayOptions
public	MessageReducedDisplayOptions: object
public	MobileLayoutOptions: object
public	MousePositionOptions: g4uControlOptions
public	MoveOptions: object
public	OSMLayerConfig: g4uLayerOptions An OSM Layer (See http://openlayers.org/en/latest/apidoc/ol.source.OSM.html).
public	OSMLayerConfig: g4uLayerOptions An OSM Layer (See http://openlayers.org/en/latest/apidoc/ol.source.OSM.html).
public	OnTopOptions: object
public	OverviewMapOptions: g4uControlOptions
public	PopupContent: object
public	PositionedElement: HideableElement
public	PositioningOptions: object
public	ProjectionConfig: Object
public	QuerySourceOptions: SourceServerVectorOptions
public	SearchConnectorOptions: Object
public	SearchControlModuleOptions: object
public	SearchControlOptions: g4uControlOptions
public	SearchViewOptions: Object
public	ShieldOptions: object
public	ShiftableComposedControlOptions: ComposedControlOptions
public	ShowWMSFeatureInfoOptions: Object
public	SilentGroupLayerConfig: g4uLayerOptions The silent group can display a group of layers which appears as a single in the layer selector.
public	SilentGroupLayerConfig: g4uLayerOptions The silent group can display a group of layers which appears as a single in the layer selector.
public	SingleMoveOptions: FitOptions
public	SourceConfig: Object A source config.
public	SourceConfig: Object A source config.
public	SourceServerVectorOptions: module:ol/source/Vector~Options
public	StamenLayerConfig: g4uLayerOptions A stamen Layer (See http://openlayers.org/en/latest/apidoc/ol.source.Stamen.html).
public	StamenLayerConfig: g4uLayerOptions A stamen Layer (See http://openlayers.org/en/latest/apidoc/ol.source.Stamen.html).
public	StaticOverviewMapOptions: ControlOptions
public	StyleLike: string \| StyleObject \| ol.style.Style
public	StyleObject: Object
public	TileWMSLayerConfig: g4uLayerOptions A WMS Layer which is called like a tiled layer.
public	TileWMSLayerConfig: g4uLayerOptions A WMS Layer which is called like a tiled layer.
public	URLAPIOptions: object
public	URLConfig: object
public	URLLike: URLConfig \| Localizable \| URL
public	URLParameter: object
public	VectorLayerOptions: object
public	VectorSourceConfig: SourceConfig A vector source config.
public	VectorSourceConfig: SourceConfig A vector source config.
public	WMSFeatureInfoOptions: object
public	WMSLayerButtonConfig: ButtonConfig
public	WMSLayerConfig: g4uLayerOptions A WMS Layer.
public	WMSLayerConfig: g4uLayerOptions A WMS Layer.
public	WMSSSourceConfig: SourceConfig A wms source config.
public	WMTSLayerConfig: g4uLayerOptions A WMTS Layer.
public	WMTSLayerConfig: g4uLayerOptions A WMTS Layer.
public	WMTSSSourceConfig: SourceConfig A wmts source config.
public	WMTSSSourceConfig: SourceConfig A wmts source config.
public	WindowDecoratorOptions: g4uControlOptions
public	WindowOptions: object
public	XYZLayerConfig: g4uLayerOptions A XYZ Layer (See http://openlayers.org/en/latest/apidoc/ol.source.XYZ.html).
public	XYZLayerConfig: g4uLayerOptions A XYZ Layer (See http://openlayers.org/en/latest/apidoc/ol.source.XYZ.html).
public	ZoomOptions: g4uControlOptions
public	g4uControlOptions: object
public	g4uLayerOptions: Object Common config for all layers.
public	g4uLayerOptions: Object Common config for all layers.
public	g4uViewOptions: Object

Static Public

public APIOptions: object source

Properties:

Name	Type	Attribute	Description
drawStyle	StyleLike	optional default: '#drawStyle'

public AnyLayerConfig: SilentGroupLayerConfig | CategoryLayerConfig | EmptyLayerConfig | XYZLayerConfig | OSMLayerConfig | StamenLayerConfig | BingLayerConfig | WMTSLayerConfig | WMSLayerConfig | TileWMSLayerConfig | GeoJSONLayerConfig | KMLLayerConfig | InternalLayerConfig source

public ArcGISRESTFeatureSourceOptions: module:ol/source/Vector~Options source

Please note that a 'BBOX' or 'TILE' loadingStrategy is required

Properties:

Name	Type	Attribute	Description
params	object	optional	the params to be passed to the ArcGIS REST Feature Service. The params f, returnGeometry, geometry, geometryType, inSR and outSr can not be set as they are filled automatically. The SR parameters will be set to the projection of the source if one is given. geometry and geometryType will always be an 'esriGeometryEnvelope'. f will be 'json' and returnGeometry 'true'. The parameters spatialRel and outFields can be altered and default to 'esriSpatialRelIntersects' and '*'.
dataType	string	optional default: json	can be 'json' or 'jsonp'

public ArrowButtonOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
pixelDelta	number	optional default: 128	how many pixels should one click move the map
initExtent	ol.Extent \| undefined	optional default: undefined	the initial Extent to move the map back to (center button)
animationDuration	number	optional default: 100	duration of the animation
animated	boolean	optional default: true	if the move should be done with an animation or without
labels	{up: string, right: string, down: string, left: string, center: string}\|{}	optional default: {}	unicode labels for the buttons (only shown if pictures are not loaded)

public BaseLayerMixinOptions: object source

Properties:

Name	Type	Attribute	Description
groupLayer	GroupLayer		the group this baseLayer belongs to

public BingLayerConfig: g4uLayerOptions source

A bing maps Layer (See http://openlayers.org/en/latest/apidoc/ol.source.BingMaps.html).

Properties:

Name	Type	Attribute	Description
type	"Bing"
source	SourceConfig

public BingLayerConfig: g4uLayerOptions source

A bing maps Layer (See http://openlayers.org/en/latest/apidoc/ol.source.BingMaps.html).

Properties:

Name	Type	Attribute	Description
type	"Bing"
source	SourceConfig

public ButtonActions: object source

Properties:

Name	Type	Attribute	Description
toggleActive	*
toggleDisabled	*
toggleLoading	*

public ButtonBoxOptions: object source

Properties:

Name	Type	Attribute	Description
className	string	optional default: 'g4u-menu'
addClass	string	optional	adds a classname
content	HTMLElement \| jQuery	optional	the content of the body of the button box
collapsible	boolean	optional
collapsed	boolean	optional
rtl	boolean	optional
titleButton	boolean	optional default: false	displays an extra button with a title firing an 'title:click' event
title	string	optional	the title appearing on the button

public ButtonConfig: object source

Properties:

Name	Type	Attribute	Description
window	object	optional	open a window if the button gets clicked
class	string	optional	add a css class to the button
accordion	[]	optional	accordionmenu items

public CategoryLayerConfig: g4uLayerOptions source

The category contains other layer(s) and will appear as a category in the layer selector.

Properties:

Name	Type	Attribute	Description
type	"Category"
layers	AnyLayerConfig[]

public CategoryLayerConfig: g4uLayerOptions source

The category contains other layer(s) and will appear as a category in the layer selector.

Properties:

Name	Type	Attribute	Description
type	"Category"
layers	AnyLayerConfig[]

public CloseWindowButtonOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
label	string	optional

public CombinedZoomOptions: ComposedControlOptions source

Properties:

Name	Type	Attribute	Description
buttons	boolean	optional default: true	visibility of the zoombuttons
slider	boolean	optional default: true	visibility of the zoomslider
buttonImportance	number	optional	importance of the buttons
sliderImportance	number	optional	importance of the slider
zoomInTipLabel	string	optional
zoomOutTipLabel	string	optional

public ComposedControlOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
containerClassName	string	optional
squeeze	boolean	optional default: false
minHeight	number	optional default: 50

public Configs: object source

Properties:

Name	Type	Attribute	Description
client	string \| object		the client config
layer	string \| object		the layer config
translations	string \| object		the translations
styles	string \| object	optional	the style map

public ControlFactoryOptions: Object source

Properties:

Name	Type	Attribute	Description
localiser	L10N
map	G4UMap

public ControlsConfig: object source

Inside of this object the controls are configured. Normally they are referenced by their type, but if you have multiple controls of one type you can specify a name under which it is referenced. Then you have to specify the controlType in the configuration object.

Example: let 'example' be the chosen name for an attribution control. Then we can reference it in onMap or any contains property as 'example'. The configuration object is now named 'example' but needs to have an 'controlType' property which needs to be set to 'attribution'.

   "controls": {
     "onMap": ["example"],
     "example": {
       "controlType": "attribution",
       ...
     }
   }

Properties:

Name	Type	Attribute	Description
onMap	string[]		All controls mentioned in this array will be added directly to the map.
arrowButtons	ArrowButtonOptions	optional
attribution	AttributionOptions	optional
combinedZoom	CombinedZoomOptions	optional
geolocationButton	GeoLocationButtonOptions	optional
helpButton	HelpButtonOptions	optional
infoButton	InfoButtonOptions	optional
languageSwitcherButton	LanguageSwitcherButtonOptions	optional
languageSwitcherMenu	LanguageSwitcherMenuOptions	optional
layerSelector	LayerSelectorOptions	optional
linkButton	LinkButtonOptions	optional
logo	LogoOptions	optional
measurementButton	MeasurementButtonOptions	optional
mobileControls	ShiftableComposedControlOptions	optional
mousePosition	MousePositionOptions	optional
overviewMap	OverviewMapOptions	optional
printButton	g4uControlOptions	optional
scaleLine	ScaleLineOptions	optional
singleDrawButton	DrawButtonsOptions	optional
toolbox	ComposedControlOptions	optional
layerMenu	ComposedControlOptions	optional

public DrawButtonsOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
editStyle	StyleLike	optional default: '#defaultStyle'
finishedStyle	StyleLike	optional default: '#defaultStyle'

public DropdownOptions: object source

Properties:

Name	Type	Attribute	Description
className	string	optional default: 'g4u-dropdown'
ghostentry	string	optional default: 'no entries'	This text is shown if the dropdown has no entries
slideDuration	number	optional default: 400	standard slideDuration

public ElementPosition: object source

Properties:

Name	Type	Attribute	Description
$actualElement	jQuery
$oldParent	jQuery
oldIndex	number

public EmptyLayerConfig: g4uLayerOptions source

The empty layer will show nothing (in case of a base layer a white background).

Properties:

Name	Type	Attribute	Description
type	"Empty"

public EmptyLayerConfig: g4uLayerOptions source

The empty layer will show nothing (in case of a base layer a white background).

Properties:

Name	Type	Attribute	Description
type	"Empty"

public Entry: Object source

Properties:

Name	Type	Attribute	Description
$element	jQuery
value	*

public FeatureConfig: Object source

Properties:

Name	Type	Attribute	Description
id	string \| number
style	StyleLike	optional
geometryWKT	string	optional
geometry	Geometry	optional

public FeatureConfig: Object source

Properties:

Name	Type	Attribute	Description
id	string \| number
style	StyleLike	optional
geometryWKT	string	optional
geometry	Geometry	optional

public FeatureInteractionOptions: MapEventInteractionOptions source

Properties:

Name	Type	Attribute	Description
hitTolerance	number	optional default: 0

public FeaturePopupOptions: object source

Properties:

Name	Type	Attribute	Description
className	string	optional default: 'g4u-featurepopup'
offset	number[]	optional default: [0,0]
positioning	OverlayPositioning	optional default: 'center-center'
iconSizedOffset	number[]	optional default: [0,0]
centerOnPopup	boolean	optional default: false
animated	boolean	optional default: true
popupModifier	string[]	optional	default popupModifiers to use
draggable	boolean	optional default: false

public FeatureTooltipOptions: object source

Properties:

Name	Type	Attribute	Description
className	string	optional default: 'g4u-featuretooltip'
offset	number[]	optional default: [0,0]
positioning	ol.OverlayPositioning	optional default: 'center-center'
popupModifier	string[]	optional default: []

public Float: string[] | string source

This describes the floating directions of an element. It can be an array, then it will move from the center to the first specified direction and after that it moves in the second direction. If it is set to 'fixed' it is not positioned via Positioning.

public G4UMapOptions: object source

Properties:

Name	Type	Attribute	Description
localiser	L10N	optional
popupModifiers	object<string, PopupModifier>	optional

public GeoJSONLayerConfig: g4uLayerOptions source

A GeoJSON Layer.

Properties:

Name	Type	Attribute	Description
type	"GeoJSON"
source	VectorSourceConfig
style	StyleLike	optional

public GeoJSONLayerConfig: g4uLayerOptions source

A GeoJSON Layer.

Properties:

Name	Type	Attribute	Description
type	"GeoJSON"
source	VectorSourceConfig
style	StyleLike	optional

public GeoLocationButtonOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
animated	boolean	optional	if the move on the map to the geoposition should be animated
style	StyleLike	optional default: '#defaultStyle'
maxZoom	number	optional
followLocation	boolean	optional default: false
active	boolean	optional default: false

public GroupButtonConfig: ButtonConfig source

Properties:

Name	Type	Attribute	Description
type	"group"
title	Localizable
groupButton	string	optional default: "onlyMenu"	can be "noButton", "onlyMenu" or "activate" "noButton": the group itself will have no button, the contained buttons are displayed on the same level "onlyMenu": the group has a button which can be clicked to open/close the submenu with the contained layers "activate": the group has 2 buttons. One will open/close the submenu, the other will de-/activate all layers
items	string	optional default: "normal"	can be "normal" or "exclusive" "normal": all contained layers can be activated independently "exclusive": activating one layer in this group will deactivate the others.
unselectable	boolean	optional default: true	specifies if a button can be unselected
collapsible	boolean	optional default: true
collapsed	boolean	optional default: true

public HelpButtonOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
configControls	object	optional default: {}
fileName	string		of the json with the helptexts
active	boolean	optional default: false

public HideableElement: Object source

Properties:

Name	Type	Attribute	Description
control	Control
importance	number
order	number
float	Float	optional	first and second direction or special value 'fixed'
hideableChildren	HideableElement[]	optional

public InfoButtonOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
contentURL	URLLike		url providing content to be shown
attribution	boolean	optional default: true
active	boolean	optional default: false

public InternalLayerConfig: g4uLayerOptions source

A layer whichs contents are completly defined in the config file.

Properties:

Name	Type	Attribute	Description
type	"Intern"
source	InternalSourceConfig
style	StyleLike	optional

public InternalLayerConfig: g4uLayerOptions source

A layer whichs contents are completly defined in the config file.

Properties:

Name	Type	Attribute	Description
type	"Intern"
source	InternalSourceConfig
style	StyleLike	optional

public InternalSourceConfig: SourceConfig source

An internal source whose features are defined directly in the config file.

Properties:

Name	Type	Attribute	Description
features	FeatureConfig[]

public InternalSourceConfig: SourceConfig source

An internal source whose features are defined directly in the config file.

Properties:

Name	Type	Attribute	Description
features	FeatureConfig[]

public KMLLayerConfig: g4uLayerOptions source

A KML Layer.

Properties:

Name	Type	Attribute	Description
type	"KML"
source	VectorSourceConfig
style	StyleLike	optional

public KMLLayerConfig: g4uLayerOptions source

A KML Layer.

Properties:

Name	Type	Attribute	Description
type	"KML"
source	VectorSourceConfig
style	StyleLike	optional

public KineticOptions: object source

Properties:

Name	Type	Attribute	Description
decay	number	optional
minVelocity	number	optional
delay	number	optional

public L10NOptions: object source

Properties:

Name	Type	Attribute	Description
defaultLanguage	string	optional default: 'en'
currentLanguage	string	optional
languageFile	string	optional default: 'files/l10n.commented.json'
availableLanguages	string[]	optional

public LanguageSwitcherButtonOptions: g4uControlOptions source

public LanguageSwitcherMenuOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
showLongLanguage	boolean	optional default: false
active	boolean	optional default: false

public LayerButton: object source

Properties:

Name	Type	Attribute	Description
title	string
checked	boolean	optional	if QUERY_LAYERS are set and checked is true, the featureInfo appears turned on.
LAYERS	string[]
QUERY_LAYERS	string[]	optional

public LayerButtonConfig: ButtonConfig source

Properties:

Name	Type	Attribute	Description
type	"layer"
title	Localizable	optional	if not set, the title of the layer will be chosen
refId	string \| number		the id of the layer
exclusive	string		all layers with the same exclusive value are mutually exclusive active

public LayerConfig: object source

Properties:

Name	Type	Attribute	Description
menus	object<string, ButtonConfig>
layers	AnyLayerConfig[]

public LayerSelectorOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
collapsible	boolean	optional default: true	if the menu should be collapsible
collapsed	boolean	optional default: false	if the menu starts collapsed
minVisibleEntries	number	optional default: 6	amount of minimal visible elements
layerGroupName	string		the name of the layerGroup this selector is connected to. For example 'baseLayers'
minLayerAmount	number	optional default: 1	the minimum number of layers which should be visible to show this selector

public LayerSelectorOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
collapsible	boolean	optional default: true	if the menu should be collapsible
collapsed	boolean	optional default: false	if the menu starts collapsed
minVisibleEntries	number	optional default: 6	amount of minimal visible elements
menuName	string		the name of the layerMenu this selector is connected to. For example 'baseLayers'
minLayerAmount	number	optional default: 1	the minimum number of layers which should be visible to show this selector
checkboxes	boolean	optional default: false	if the layerbuttons should have trailing checkboxes

public LinkButtonOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
url	string	optional
linkTarget	string	optional	set the link target (e.g. '_blank')

public LinkGeneratorButtonOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
baseURL	string	optional	the baseUrl of the link. Defaults to the current location.
style	StyleLike	optional default: '#defaultStyle'	The style of the marker.

public LinkGeneratorOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
baseURL	string	optional	the baseUrl of the link. Defaults to the current location.
type	string	optional default: 'url'	possible values are 'url', 'link' and 'iframe' 'url' can be copied 'link' can be clicked 'iframe' can be copied

public Localizable: Object<string, string> | string source

public LogoOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
src	string	optional default: 'images/g4u-logo.png'	path to the image
width	number	optional
height	number	optional
opacity	number	optional
mode	string	optional default: 'both'	possible values: print, screen, both

public MapConfig: Object source

Properties:

Name	Type	Attribute	Description
proxy	string	optional	A proxy url. It should have an {url} string which will be replaced with the proxied url. Example: 'proxy.php?csurl={url}'.
userActionTracking	Boolean	optional default: false	if checked the map tracks certain user actions and fires 'userActionTracking' events that contain this information. Tracked actions are: move, layer activation, clicks on features, printing, measurements.
languageSettings	L10NOptions	optional	settings regarding the display language.
interfaceProjection	string	optional default: 'EPSG:4326'	the projection the interface will use to interact with the user or the api.
mapProjection	string	optional	the projection that is used internally. Will be infered from map data if not set.
measurementProjection	string	optional	the projection measurements will calculated in.
enableContextMenu	boolean	optional default: false	enables the contextMenu outside of textinput fields
view	g4uViewOptions		View options.
scaleIcons	number	optional	a default scaling for all used feature icons
hitTolerance	number	optional default: 0	a default hit tolerance that will be used for all interactions (except show wms feature info).
manageStyles	boolean	optional default: true	set this to false to disable style managing. This disables scaleIcons, mobileScaleIcons, feature hiding and adjustable style opacity
mobileLayout	MobileLayoutOptions	optional	special layout options for mobile use.
additionalProjections	ProjectionConfig[]	optional	if any other projections than 'EPSG:4326' or 'EPSG:3857' are needed they can be specified here.
api	APIOptions	optional	API-Options
featurePopup	FeaturePopupOptions	optional	Options regarding the feature popup.
featureTooltip	FeatureTooltipOptions	optional	Options regarding the feature tooltip.
showWMSFeatureInfo	ShowWMSFeatureInfoOptions	optional	Options regarding WMS GetFeatureInfo.
interactions	Object<string, boolean>	optional	Specifies which map interactions should be turned on by default. Possible interactions are: 'doubleClickZoom', 'dragPan' (to which the {KineticOptions} are applied), 'dragRotate', 'dragZoom', 'keyboardPan', 'keyboardZoom', 'mouseWheelZoom', 'pinchRotate', 'pinchZoom'
kinetic	KineticOptions \| boolean	optional	This influences the DragPan behaviour. If set to false no kinetic options are applied, if not set, the defaults are used.
move	MoveOptions	optional	Options regarding the behaviour of movements on the maps.
positioning	PositioningOptions	optional	Options regarding the positioning of the controls.
loadingStrategy	string	optional default: 'ALL'	Global default loading strategy. Can have the values 'BBOX' or 'ALL'.
ignoreLayerAvailability	boolean	optional default: false	If set all layers are added to the map, regardless of their available config option.
cssFile	string	optional	a cssFile to load and insert in the head dynamically.
cssTemplate	Color[]	optional	if 3 colors are given, the colors used in the text of the loaded cssFile will be replaced by this colors. The colors in the cssFile need to be pure red, blue and green.
styleMap	Object<string, StyleObject>	optional	the style objects which will be mapped to certain identifiers. It is recommended that identifiers start with a #. The {{StyleObject}} with the identifier '#defaultStyle' will be used as a default Style in the whole Software.
controls	ControlsConfig

public MapEventInteractionOptions: object source

Properties:

Name	Type	Attribute	Description
type	string	optional default: singleclick	the map event type to listen to

public MarkerOptions: object source

Properties:

Name	Type	Attribute	Description
style	StyleLike	optional default: '#defaultStyle'

public MaximizeButtonOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
baseURL	URLLike	optional
URLParameters	object<string, string>	optional

public MeasurementButtonOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
style	StyleLike	optional default: '#defaultStyle'
type	string		geometry type ('LineString', 'Polygon')
dimension	number	optional default: 1	1 for lines, 2 for polygons
atDrawEnd	string	optional	if set to 'newMeasurement' the control will start a new measurement after completing a measurement. if set to 'closeWindow' the window will be closed.
active	boolean	optional default: false

public MessageConstructorOptions: MessageDisplayOptions source

Properties:

Name	Type	Attribute	Description
arrowShow	boolean	optional default: true	whether to show an arrow pointing at the element
arrowSize	number	optional default: 5	Arrow size in pixels
autoHide	boolean	optional default: true	whether to auto-hide the notification
autoHideDelay	number	optional default: 15000	milliseconds before hide (if autoHide is set)
className	string \| string[]	optional default: 'error'	default class
position	string	optional default: bottom left	notification position relative to element
gap	number	optional default: 2	padding between element and notification
hideAnimation	string	optional default: slideUp	hide animation type
hideDuration	number	optional default: 200	hide animation duration in milliseconds
showAnimation	string	optional default: slideDown	show animation type
showDuration	number	optional default: 400	show animation duration in miliseconds
style	string	optional default: bootstrap	default style

public MessageDisplayOptions: MessageReducedDisplayOptions source

Properties:

Name	Type	Attribute	Description
className	string \| string[]	optional	default class

public MessageReducedDisplayOptions: object source

Properties:

Name	Type	Attribute	Description
autoHide	boolean	optional	whether to auto-hide the notification
autoHideDelay	number	optional	milliseconds before hide (if autoHide is set)
position	string	optional	notification position relative to element

public MobileLayoutOptions: object source

Properties:

Name	Type	Attribute	Description
mediaQueries	string[]		these will enable the mobile layout including removing the g4u-desktop class from the ol-viewport and adding the g4u-mobile class
scaleIcons	number	optional default: 1	a value to scale all icons by
animations	boolean	optional default: true	if animations should be disabled
hitTolerance	number	optional

public MousePositionOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
coordinateFormat	function	optional

public MoveOptions: object source

Properties:

Name	Type	Attribute	Description
map	G4UMap
pixelPadding	number	optional default: 50	a default padding around the target extent in pixels
meterMinSize	number	optional default: 500	the minimal size of the target extent in meters
animationDuration	number	optional default: 2000
animations	boolean	optional default: true
bouncing	boolean	optional default: false	if the animation should bounce or not

public OSMLayerConfig: g4uLayerOptions source

An OSM Layer (See http://openlayers.org/en/latest/apidoc/ol.source.OSM.html).

Properties:

Name	Type	Attribute	Description
type	"OSM"
source	SourceConfig

public OSMLayerConfig: g4uLayerOptions source

An OSM Layer (See http://openlayers.org/en/latest/apidoc/ol.source.OSM.html).

Properties:

Name	Type	Attribute	Description
type	"OSM"
source	SourceConfig

public OnTopOptions: object source

Properties:

Name	Type	Attribute	Description
findParentWindow	boolean	optional default: false

public OverviewMapOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
tipLabel	Localizable	optional
layerGroup	ol.layer.Group	optional

public PopupContent: object source

Properties:

Name	Type	Attribute	Description
name	string
description	string

public PositionedElement: HideableElement source

Properties:

Name	Type	Attribute	Description
float	string[]		first and second direction or special value 'fixed'
minWidth	number
minHeight	number
size	{width: number, height: number}

public PositioningOptions: object source

Properties:

Name	Type	Attribute	Description
padding	number	optional default: 5
spacing	number	optional default: 10
viewport	HTMLElement

public ProjectionConfig: Object source

Properties:

Name	Type	Attribute	Description
code	string
definition	string

public QuerySourceOptions: SourceServerVectorOptions source

Properties:

Name	Type	Attribute	Description
queryValues	String[]	optional default: []

public SearchConnectorOptions: Object source

Properties:

Name	Type	Attribute	Description
type	string
serviceURL	URLLike
localiser	L10N

public SearchControlModuleOptions: object source

Properties:

Name	Type	Attribute	Description
connectors	object<string, SearchConnector>

public SearchControlOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
amountDropdownEntries	number	optional default: 4	number of entries shown in the dropdown
autocompleteStart	number	optional default: 2	count of letters after which the autocomplete starts. if set to -1 autocomplete is disabled
autocompleteDelay	number	optional default: 300
slideDuration	number	optional default: 400	time it takes for the dropdown to slide down
connector	SearchConnectorOptions		options of the connector to use. At the moment 'nominatim' is delivered within this module.
style	StyleLike	optional	of the search results
animated	boolean	optional	affects the move to the search results.
placeholder	string	optional	text to be seen in the input field if the user has made no input yet
ghostentry	string	optional	text to be seen in the dropdown if the autocomplete or search didn't find
deactivateMobileSearch	string	optional default: 'exactResult'	other possible values are 'never' and 'anyResult'

public SearchViewOptions: Object source

Properties:

Name	Type	Attribute	Description
style	StyleLike	optional	of the search results

public ShieldOptions: object source

Properties:

Name	Type	Attribute	Description
map	G4UMap
className	string	optional default: 'g4u-shield'

public ShiftableComposedControlOptions: ComposedControlOptions source

Properties:

Name	Type	Attribute	Description
visibleControls	number		specifies amount visible controls

public ShowWMSFeatureInfoOptions: Object source

Properties:

Name	Type	Attribute	Description
style	StyleLike	optional default: '#defaultStyle'
seperator	String	optional default: ' '
showClickable	String	optional default: 'layerAtPixel'	can be 'everywhere', 'layerAtPixel' or 'nowhere'
animated	boolean	optional

public SilentGroupLayerConfig: g4uLayerOptions source

The silent group can display a group of layers which appears as a single in the layer selector.

Properties:

Name	Type	Attribute	Description
type	"SilentGroup"
layers	AnyLayerConfig[]

public SilentGroupLayerConfig: g4uLayerOptions source

The silent group can display a group of layers which appears as a single in the layer selector.

Properties:

Name	Type	Attribute	Description
type	"SilentGroup"
layers	AnyLayerConfig[]

public SingleMoveOptions: FitOptions source

Properties:

Name	Type	Attribute	Description
animated	boolean	optional	if specified overwrites the default settings
padding	number[] \| string	optional	if not set the default value (pixelPadding) is used
minSize	number	optional	if not set the default value (meterMinSize) is used

public SourceConfig: Object source

A source config.

Properties:

Name	Type	Attribute	Description
attribution	Localizable	optional
url	URLLike

public SourceConfig: Object source

A source config.

Properties:

Name	Type	Attribute	Description
attribution	Localizable	optional
url	URLLike

public SourceServerVectorOptions: module:ol/source/Vector~Options source

Properties:

Name	Type	Attribute	Description
type	string		the format to use
url	URLLike
urlProjection	module:ol/proj~ProjectionLike	optional	coordinates will be inserted into the url in this format. defaults to the sourceProjection
defaultStyle	StyleLike	optional	a default style to fallback to
extractStyles	boolean	optional default: true	if styles should get extracted from the KML
cache	boolean	optional default:	true, false for dataType 'script' and 'jsonp'
refresh	number	optional	if set the layer will refresh itself in the specified time (in ms)
localiser	L10N
localised	boolean
styling	Styling

public StamenLayerConfig: g4uLayerOptions source

A stamen Layer (See http://openlayers.org/en/latest/apidoc/ol.source.Stamen.html).

Properties:

Name	Type	Attribute	Description
type	"Stamen"
source	SourceConfig

public StamenLayerConfig: g4uLayerOptions source

A stamen Layer (See http://openlayers.org/en/latest/apidoc/ol.source.Stamen.html).

Properties:

Name	Type	Attribute	Description
type	"Stamen"
source	SourceConfig

public StaticOverviewMapOptions: ControlOptions source

Properties:

Name	Type	Attribute	Description
url	String		to the static picture
extent	Number[]		of the shown image
projection	ol.ProjectionLike		used

public StyleLike: string | StyleObject | ol.style.Style source

public StyleObject: Object source

public TileWMSLayerConfig: g4uLayerOptions source

A WMS Layer which is called like a tiled layer. Good for performance. Check the {{WMSSSourceConfig}}.

Properties:

Name	Type	Attribute	Description
type	"TileWMS"
source	WMSSSourceConfig
buttons	LayerButton[]	optional	If this is set, the layer appears as multiple buttons in the layerselector
categoryButton	boolean	optional default: false	If the buttons option is set, this options specifies if the buttons should appear as a category or not.

public TileWMSLayerConfig: g4uLayerOptions source

A WMS Layer which is called like a tiled layer. Good for performance. Check the {{WMSSSourceConfig}}.

Properties:

Name	Type	Attribute	Description
type	"TileWMS"
source	WMSSSourceConfig
buttons	LayerButton[]	optional	If this is set, the layer appears as multiple buttons in the layerselector
categoryButton	boolean	optional default: false	If the buttons option is set, this options specifies if the buttons should appear as a category or not.

public URLAPIOptions: object source

Properties:

Name	Type	Attribute	Description
map	G4UMap
excluded	string[]	optional	parameters to exclude
init	object	optional	set all properties to this initial values
mode	string	optional default: 'both'	possible values: 'js', 'url', 'both'

public URLConfig: object source

Properties:

Name	Type	Attribute	Description
url	Localizable
useProxy	boolean	optional
proxy	string	optional
cache	boolean	optional default: true
username	string	optional	only implemented for wms at the moment
password	string	optional	only implemented for wms at the moment

public URLLike: URLConfig | Localizable | URL source

public URLParameter: object source

Properties:

Name	Type	Attribute	Description
keys	string[]		an array of keys this URLParameter reacts to. If any of this are contined in the URL the setToMap function of this parameter is called.
setEvent	string	optional	if this event is thrown by the map the setToMap function will be called.
SetToMapFunction	function	optional	this function should adjust the map state according to the given keys.
GetFromMapFunction	function	optional	this function is called to get the needed values from the map to create the needed URL Parameter(s). This function needs to return an object with key value pairs representing the values to be written in the URL

public VectorLayerOptions: object source

Properties:

Name	Type	Attribute	Description
mutators	string[]	optional default: []	list of mutators (changes featurepopup content) to use for this layer.

public VectorSourceConfig: SourceConfig source

A vector source config.

Properties:

Name	Type	Attribute	Description
loadingStrategy	string	optional	"BBOX" or "ALL"
bboxRatio	number	optional	only applies if loadingStrategy is BBOX. If bigger than 1 this much more will be loaded around a bbox.
localised	boolean	optional default: false	if set to true the loader will send accept-language headers.

public VectorSourceConfig: SourceConfig source

A vector source config.

Properties:

Name	Type	Attribute	Description
loadingStrategy	string	optional default: 'ALL'	Either 'BBOX', 'ALL' or 'TILE' If BBOX or TILE the given url has to contain the parameters {minx}, {miny}, {maxx}, {maxy}.
bboxRatio	number	optional default: 1	If set the bbox loading strategy will increase the load extent by this factor
urlProjection	ProjectionLike	optional	coordinates will be inserted into the url in this format. defaults to the sourceProjection
localised	boolean	optional default: false	if set to true the loader will send accept-language headers.

public WMSFeatureInfoOptions: object source

Properties:

Name	Type	Attribute	Description
params	object<string, string>	optional	the params to be used with the GetFeatureInfo call. Needs to include INFO_FORMAT. If the layer does not use the buttons options than needs to include QUERY_LAYERS.
checkable	boolean	optional default: false	If the layer does not use the buttons options, this options specifies if an extra button on the layer button appears to toggle the feature info.
checked	boolean	optional default: true	If the layer does not use the buttons options and checkable is true, this option specifies if the feature info button appears activated or not.
iframe	[number, number]	optional default: false	load in iframe of this size

public WMSLayerButtonConfig: ButtonConfig source

Properties:

Name	Type	Attribute	Description
type	"WMS"
title	Localizable
refId	string \| number		the id of the layer
LAYERS	string[]
QUERY_LAYERS	string[]	optional
checked	boolean	optional	if QUERY_LAYERS are set and checked is true, the featureInfo appears turned on.

public WMSLayerConfig: g4uLayerOptions source

A WMS Layer. Check the {{WMSSSourceConfig}}.

Properties:

Name	Type	Attribute	Description
type	"WMS"
source	WMSSSourceConfig
buttons	LayerButton[]	optional	If this is set, the layer appears as multiple buttons in th layerselector
categoryButton	boolean	optional default: false	If the buttons option is set, this options specifies if the buttons should appear as a category or not.

public WMSLayerConfig: g4uLayerOptions source

A WMS Layer. Check the {{WMSSSourceConfig}}.

Properties:

Name	Type	Attribute	Description
type	"WMS"
source	WMSSSourceConfig
buttons	LayerButton[]	optional	If this is set, the layer appears as multiple buttons in th layerselector
categoryButton	boolean	optional default: false	If the buttons option is set, this options specifies if the buttons should appear as a category or not.

public WMSSSourceConfig: SourceConfig source

A wms source config.

Properties:

Name	Type	Attribute	Description
params	object		required. needs to contain a `LAYERS` parameter. For other parameters see: http://openlayers.org/en/latest/apidoc/ol.source.ImageWMS.html -> Constructor options -> params
featureInfo	WMSFeatureInfoOptions

public WMTSLayerConfig: g4uLayerOptions source

A WMTS Layer. Check the {{WMTSSSourceConfig}}.

Properties:

Name	Type	Attribute	Description
type	"WMTS"
source	WMTSSSourceConfig

public WMTSLayerConfig: g4uLayerOptions source

A WMTS Layer. Check the {{WMTSSSourceConfig}}.

Properties:

Name	Type	Attribute	Description
type	"WMTS"
source	WMTSSSourceConfig

public WMTSSSourceConfig: SourceConfig source

A wmts source config. See https://openlayers.org/en/latest/apidoc/module-ol_source_WMTS-WMTS.html.

Properties:

Name	Type	Attribute	Description
config	object		Needs to contain a `layer` parameter. For other parameters see: https://openlayers.org/en/latest/apidoc/module-ol_source_WMTS.html#.optionsFromCapabilities. required.
autoConfig	boolean	optional default: false	if autoConfig is set to true, guide4you makes a GetCapabilities-Request to automatically configure the WMTS. If not set a tileGrid has to be provided. See https://openlayers.org/en/latest/apidoc/module-ol_source_WMTS-WMTS.html.

public WMTSSSourceConfig: SourceConfig source

A wmts source config. See https://openlayers.org/en/latest/apidoc/module-ol_source_WMTS-WMTS.html.

Properties:

Name	Type	Attribute	Description
config	object		Needs to contain a `layer` parameter. For other parameters see: https://openlayers.org/en/latest/apidoc/module-ol_source_WMTS.html#.optionsFromCapabilities. required.
autoConfig	boolean	optional default: false	if autoConfig is set to true, guide4you makes a GetCapabilities-Request to automatically configure the WMTS. If not set a tileGrid has to be provided. See https://openlayers.org/en/latest/apidoc/module-ol_source_WMTS-WMTS.html.

public WindowDecoratorOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
component	Control

public WindowOptions: object source

Properties:

Name	Type	Attribute	Description
parentClassName	string		an additional html class name to use
draggable	boolean	optional default: false
id	string	optional	an html id for the outer window element
className	string	optional	an alternative html class name to use instead of 'g4u-window', not recommended
map	G4UMap	optional	the map the window should be shown on. The viewport will be set as the context of the window
$context	jQuery	optional	context the window is shown in
visible	boolean	optional default: false	the visibility of the window on start up
fixedPosition	boolean	optional default: false	if the window is movable or not

public XYZLayerConfig: g4uLayerOptions source

A XYZ Layer (See http://openlayers.org/en/latest/apidoc/ol.source.XYZ.html).

Properties:

Name	Type	Attribute	Description
type	"XYZ"
source	SourceConfig

public XYZLayerConfig: g4uLayerOptions source

A XYZ Layer (See http://openlayers.org/en/latest/apidoc/ol.source.XYZ.html).

Properties:

Name	Type	Attribute	Description
type	"XYZ"
source	SourceConfig

public ZoomOptions: g4uControlOptions source

Properties:

Name	Type	Attribute	Description
zoomInTipLabel	Localizable	optional
zoomOutTipLabel	Localizable	optional

public g4uControlOptions: object source

Properties:

Name	Type	Attribute	Description
controlType	string	optional	the type of the control. If not given the name of the control is used
importance	number	optional	how important the control is on the map. the higher this value is, the longer it will be kept on the map if the viewport gets smaller.
activeGroup	string	optional	if controls are in the same active group only one of them can be active at the same time
className	string	optional
element	HTMLElement
localiser	L10N		the localiser to use by the control.
controlName	string		the name of the control.
singleButton	boolean	optional default: false	if the control only consists of one button
target	String \| HTMLElement \| jQuery	optional
title	Localizable	optional	not used by every control
tipLabel	Localizable	optional	not used by every control
float	Float	optional
windowed	boolean	optional default: false	whether the control resides inside a window or not

public g4uLayerOptions: Object source

Common config for all layers.

Properties:

Name	Type	Attribute	Description
type	LayerType		The layer type.
id	string \| number		unique in the whole config
title	Localizable	optional
available	Boolean	optional	if set to false, the layer will not appear on the map or the layer selector.
availableMobile	Boolean	optional	overwrites available in mobile mode
visible	Boolean	optional default: false	If set to `true` the layer will be visible on startup.
alwaysVisible	Boolean	optional	overwrites visible, available and mobileAvailable
minZoom	number	optional	the minimal zoom from where the layer should be enabled
maxZoom	number	optional	the minimal zoom from where the layer should be enabled
style	StyleLike	optional

public g4uLayerOptions: Object source

Common config for all layers.

Properties:

Name	Type	Attribute	Description
type	LayerType		The layer type.
id	string \| number		unique in the whole config
title	Localizable	optional
available	Boolean	optional	if set to false, the layer will not appear on the map or the layer selector.
availableMobile	Boolean	optional	overwrites available in mobile mode
visible	Boolean	optional default: false	If set to `true` the layer will be visible on startup.
alwaysVisible	Boolean	optional	overwrites visible, available and mobileAvailable
minZoom	number	optional	the minimal zoom from where the layer should be enabled
maxZoom	number	optional	the minimal zoom from where the layer should be enabled
style	StyleLike	optional

public g4uViewOptions: Object source

Properties:

Name	Type	Attribute	Description
center	ol.Coordinate		the initial center of the map
extent	ol.Extent	optional	the max extent the center can lay in
resolution	number	optional
zoom	number	optional
rotation	number	optional
fit	number	optional	an extent to fit the map initialy to, overwrites center settings
projection	ol.ProjectionLike	optional