References

summary
public	C Attributions
public	C Debug This class provides different debug behaviour based on the SWITCH_DEBUG build flag
public	C FeaturePopup Displays a Popup bound to a geographical position via an ol.Overlay
public	C FeatureTooltip Displays a tooltip if a feature with a name is hovered.
public	C G4UMap Definition of the map-object Main task of the constructor is to load and read out the configuration.
public	C L10N This class localizes texts by either selecting one from a dictionary (asynchron loaded JSON File) or choosing the right string from a selection.
public	C ListenerOrganizerMixin
public	C MessageDisplay Displays Messages
public	C Module Base class for modules.
public	C Move Moves the map.
public	C PopupModifierManager Allow the registration of PopupModifiers via the PopupModifier API.
public	C Styling This class coordinates the styling.
public	F multiplyExtent(extent: ol.Extent, value: number): ol.Extent returns an extent with the same center but width and height miltiplied by the given value
public	F createMapInternal(element: , args: , defaultConfigs: ):
public	F getRegisteredModules(): *
public	F registerModule(module: *)
public	F asObject(argument: *): Object return argument as object (if it is no object the value is {})
public	F asyncImageLoad(image: HTMLImageElement, origUrl: URL, finalUrl: string): Promise
public	F checkFor(configurationObject: Object, label: String): boolean Check for a label in a configuration object
public	F even(value: Object): Boolean Checks whether an argument can be interpreted as an even integer
public	F finishAllImages($object: jQuery): Promise finishs loading all images contained in the given jQuery object.
public	F getConfig(config: object, name: string): object Gets the subconfig or an empty object
public	F html2Text(stringWithHTML: *): string Takes a string with HTML and returns the containing resulting text.
public	F mixin(baseClass: , mixinClasses: ): class This creates a new class which inherits from the base class and mixes in every method (except any method named 'initialize') from the mixin class.
public	F mixinAsClass(mixinClass: *): class This returns a mixin as a normal class.
public	F odd(value: Object): Boolean Checks whether an argument can be interpreted as an even integer
public	F offset($one: jQuery, $other: jQuery): {top: number, left: number} calculates the distance between one and another jQuery element
public	F recursiveSelect($elem: jQuery, query: string): jQuery selects all matching elements and child elements
public	F showInteractionActivity(map: *)
public	F urlDirname(url: string): string A function that tries to get the dir url of an url
public	F urlIsAbsolute(url: string): boolean
public	F urlJoin(urlRoot: string, urlExt: string): string A function that adds urls
public	F urlNormalize(url: string): string A function that normalizes a url
public	F urlRelative(source: string, target: string): string A function that tries to get the relative url between to urles
public	F copy(object: Object): Object Copy an object
public	F copyDeep(object: Object): Object Deep copy an object
public	F merge(obj1: Object, obj2: Object): Object A simple object merge function.
public	F mergeDeep(obj1: Object, obj2: Object): Object A simple reverse object merge function.
public	F take(object: Object, prop: String): * Removes a property from an object and returns its value
public	F filterText(text: string): string Filters text from user input
public	F restoreText(text: string): string Restores the text
public	V olEventTypes: {"CHANGE": string, "CLICK": string, "DBLCLICK": string, "DRAGENTER": string, "DRAGOVER": string, "DROP": string, "ERROR": string, "KEYDOWN": string, "KEYPRESS": string, "LOAD": string, "MOUSEDOWN": string, "MOUSEMOVE": string, "MOUSEOUT": string, "MOUSEUP": string, "MOUSEWHEEL": string, "MSPOINTERDOWN": string, "RESIZE": string, "TOUCHSTART": string, "TOUCHMOVE": string, "TOUCHEND": string, "WHEEL": string}
public	V cssClasses: {"mousedown": string, "clickable": string, "crosshair": string, "hidden": string, "arrow": string, "mobile": string, "desktop": string, "move": string, "active": string, "mainButton": string, "hasTooltip": string, "upperCase": string, "collapsed": string}
public	V keyCodes: object<string, number> Descriptive identifiers for some keyCodes
public	T FeaturePopupOptions: object
public	T FeatureTooltipOptions: object
public	T Configs: object
public	T G4UMapOptions: object
public	T L10NOptions: object
public	T Localizable: Object<string, string> \| string
public	T MessageConstructorOptions: MessageDisplayOptions
public	T MessageDisplayOptions: MessageReducedDisplayOptions
public	T MessageReducedDisplayOptions: object
public	T MoveOptions: object
public	T SingleMoveOptions: FitOptions
public	T PopupContent: object
public	T ShowWMSFeatureInfoOptions: Object
public	T StyleLike: string \| StyleObject \| ol.style.Style
public	T StyleObject: Object
public	T URLConfig: object
public	T URLLike: URLConfig \| Localizable \| URL

api

summary
public	C FeatureAPI
public	C GeometryAPI
public	C KMLAPI
public	C MeasureAPI
public	C PlacesAPI
public	C PrintToScaleAPI
public	T APIOptions: object

configurators

summary
public	C ControlFactory A Factory that takes a control config as an object and returns the correspondig control.
public	C LayerConfigurator This is part of the MapConfigurator class
public	C LayerFactory
public	C MapConfigurator This class configures a map once the configureMap method is called.
public	C UIConfigurator This class configures the UI of a map according to its mapconfig
public	V LayerType: {"GROUP": string, "GEOJSON": string, "KML": string, "WMS": string, "TILEWMS": string, "WMTS": string, "OSM": string, "STAMEN": string, "INTERN": string, "EMPTY": string, "XYZ": string, "BING": string, "ARCGISRESTFEATURE": string}
public	T ControlFactoryOptions: Object
public	T ControlsConfig: object Inside of this object the controls are configured.
public	T AnyLayerConfig: SilentGroupLayerConfig \| CategoryLayerConfig \| EmptyLayerConfig \| XYZLayerConfig \| OSMLayerConfig \| StamenLayerConfig \| BingLayerConfig \| WMTSLayerConfig \| WMSLayerConfig \| TileWMSLayerConfig \| GeoJSONLayerConfig \| KMLLayerConfig \| InternalLayerConfig
public	T AnyLayerConfig: SilentGroupLayerConfig \| CategoryLayerConfig \| EmptyLayerConfig \| XYZLayerConfig \| OSMLayerConfig \| StamenLayerConfig \| BingLayerConfig \| WMTSLayerConfig \| WMSLayerConfig \| TileWMSLayerConfig \| GeoJSONLayerConfig \| KMLLayerConfig \| InternalLayerConfig
public	T BingLayerConfig: g4uLayerOptions A bing maps Layer (See http://openlayers.org/en/latest/apidoc/ol.source.BingMaps.html).
public	T BingLayerConfig: g4uLayerOptions A bing maps Layer (See http://openlayers.org/en/latest/apidoc/ol.source.BingMaps.html).
public	T CategoryLayerConfig: g4uLayerOptions The category contains other layer(s) and will appear as a category in the layer selector.
public	T CategoryLayerConfig: g4uLayerOptions The category contains other layer(s) and will appear as a category in the layer selector.
public	T EmptyLayerConfig: g4uLayerOptions The empty layer will show nothing (in case of a base layer a white background).
public	T EmptyLayerConfig: g4uLayerOptions The empty layer will show nothing (in case of a base layer a white background).
public	T FeatureConfig: Object
public	T FeatureConfig: Object
public	T GeoJSONLayerConfig: g4uLayerOptions A GeoJSON Layer.
public	T GeoJSONLayerConfig: g4uLayerOptions A GeoJSON Layer.
public	T InternalLayerConfig: g4uLayerOptions A layer whichs contents are completly defined in the config file.
public	T InternalLayerConfig: g4uLayerOptions A layer whichs contents are completly defined in the config file.
public	T InternalSourceConfig: SourceConfig An internal source whose features are defined directly in the config file.
public	T InternalSourceConfig: SourceConfig An internal source whose features are defined directly in the config file.
public	T KMLLayerConfig: g4uLayerOptions A KML Layer.
public	T KMLLayerConfig: g4uLayerOptions A KML Layer.
public	T LayerConfig: object
public	T OSMLayerConfig: g4uLayerOptions An OSM Layer (See http://openlayers.org/en/latest/apidoc/ol.source.OSM.html).
public	T OSMLayerConfig: g4uLayerOptions An OSM Layer (See http://openlayers.org/en/latest/apidoc/ol.source.OSM.html).
public	T SilentGroupLayerConfig: g4uLayerOptions The silent group can display a group of layers which appears as a single in the layer selector.
public	T SilentGroupLayerConfig: g4uLayerOptions The silent group can display a group of layers which appears as a single in the layer selector.
public	T SourceConfig: Object A source config.
public	T SourceConfig: Object A source config.
public	T StamenLayerConfig: g4uLayerOptions A stamen Layer (See http://openlayers.org/en/latest/apidoc/ol.source.Stamen.html).
public	T StamenLayerConfig: g4uLayerOptions A stamen Layer (See http://openlayers.org/en/latest/apidoc/ol.source.Stamen.html).
public	T TileWMSLayerConfig: g4uLayerOptions A WMS Layer which is called like a tiled layer.
public	T TileWMSLayerConfig: g4uLayerOptions A WMS Layer which is called like a tiled layer.
public	T VectorSourceConfig: SourceConfig A vector source config.
public	T VectorSourceConfig: SourceConfig A vector source config.
public	T WMSLayerConfig: g4uLayerOptions A WMS Layer.
public	T WMSLayerConfig: g4uLayerOptions A WMS Layer.
public	T WMTSLayerConfig: g4uLayerOptions A WMTS Layer.
public	T WMTSLayerConfig: g4uLayerOptions A WMTS Layer.
public	T WMTSSSourceConfig: SourceConfig A wmts source config.
public	T WMTSSSourceConfig: SourceConfig A wmts source config.
public	T XYZLayerConfig: g4uLayerOptions A XYZ Layer (See http://openlayers.org/en/latest/apidoc/ol.source.XYZ.html).
public	T XYZLayerConfig: g4uLayerOptions A XYZ Layer (See http://openlayers.org/en/latest/apidoc/ol.source.XYZ.html).
public	T g4uLayerOptions: Object Common config for all layers.
public	T g4uLayerOptions: Object Common config for all layers.
public	T KineticOptions: object
public	T MapConfig: Object
public	T MobileLayoutOptions: object
public	T ProjectionConfig: Object
public	T g4uViewOptions: Object
public	T Float: string[] \| string This describes the floating directions of an element.
public	T HideableElement: Object
public	T PositionedElement: HideableElement
public	T PositioningOptions: object

controls

summary
public	C ActivatableMixin
public	C ActiveGroup This class organizes controls in an active group in which only one control can bea active at a time.
public	C ArrowButtons ArrowButtons shows Buttons on the map which let you move in all 4 directions and a button to return to the initial position of the map.
public	C Attribution
public	C CombinedZoom This combines the two zoom controls (zoomslider and zoombuttons)
public	C Zoom
public	C ZoomSlider
public	C ComposedControl This is a class ComposedControl which provides some functionality for controls which are composed out of several other controls.
public	C ControlLogicMixin This class contains logic which should be part of any Control in the Software.
public	C GeolocationButton This class provides a button to center the view on your current geoposition.
public	C HelpButton Shows a help button.
public	C InfoButton This control opens a window with showing some specified info text
public	C LanguageSwitcherButton A button to switch the language that is being used.
public	C LanguageSwitcherMenu A button to switch the language that is being used.
public	C LayerSelector This control shows Buttons to let you select the layer you want to see on the map.
public	C LegendViewer
public	C LinkButton provides a button which links to another page
public	C Logo This is a class which provides a logo on the map.
public	C MeasurementButton Enables the user to draw lines or polygons on the map and displays the length or area.
public	C MobileControls This class represents the mobile menu containing all the controls.
public	C MousePosition
public	C OverviewMap
public	C PrintButton
public	C RewireMixin This class does all generic rewiring including catching the target and restyling the tooltips It is important to provide a className in the control because else it will not be possible to find the control in the ol-viewport
public	C ScaleLine
public	C ShiftableComposedControl This class displays only a given amount of the containing controls and arrows to switch through these
public	C SingleDrawButton Enables the user to draw, edit and erase geometries on the map
public	C WindowDecorator This class provides an easy wrap around an control to provide a button to open the control inside of a window.
public	C ZoomToBbox Zoom to a drawn Bbox
public	V Control: * This is a customized ol.control.Control class, all logic is in the ol.control.ControlLogic
public	T ArrowButtonOptions: g4uControlOptions
public	T CombinedZoomOptions: ComposedControlOptions
public	T ZoomOptions: g4uControlOptions
public	T ComposedControlOptions: g4uControlOptions
public	T g4uControlOptions: object
public	T GeoLocationButtonOptions: g4uControlOptions
public	T HelpButtonOptions: g4uControlOptions
public	T InfoButtonOptions: g4uControlOptions
public	T LanguageSwitcherButtonOptions: g4uControlOptions
public	T LanguageSwitcherMenuOptions: g4uControlOptions
public	T LayerButton: object
public	T LayerSelectorOptions: g4uControlOptions
public	T LinkButtonOptions: g4uControlOptions
public	T LogoOptions: g4uControlOptions
public	T MeasurementButtonOptions: g4uControlOptions
public	T MousePositionOptions: g4uControlOptions
public	T OverviewMapOptions: g4uControlOptions
public	T ShiftableComposedControlOptions: ComposedControlOptions
public	T DrawButtonsOptions: g4uControlOptions
public	T StaticOverviewMapOptions: ControlOptions
public	T WindowDecoratorOptions: g4uControlOptions

html

summary
public	C ButtonBox An Element to easily construct nested HTML Menus It contains of a button followed by a body below the button.
public	C CheckGroup
public	C Dropdown A HTML Dropdown select.
public	C History
public	C Shield A shield that sets itself in front of all other elements in a context if activated, hides itself if deactivated.
public	C Window A HTML Window
public	F addTooltip($element: jQuery, text: string)
public	F changeTooltip($element: jQuery, text: string)
public	F getInFront($element: jQuery, $context: jQuery) This function gets an $element inside a $context in fornt of all of them
public	T ButtonBoxOptions: object
public	T DropdownOptions: object
public	T Entry: Object
public	T ElementPosition: object
public	T OnTopOptions: object
public	T ShieldOptions: object
public	T WindowOptions: object

interactions

summary
public	C ClickableInteraction
public	T FeatureInteractionOptions: MapEventInteractionOptions
public	T MapEventInteractionOptions: object

layerSelector

summary
public	C Accordion
public	C Button
public	C Element
public	C GroupElement
public	C LayerButton
public	C MultiButton
public	C WMSLayerButton
public	F layerConfigConverter(layerConfig: ):
public	T ButtonActions: object
public	T ButtonConfig: object
public	T GroupButtonConfig: ButtonConfig
public	T LayerButtonConfig: ButtonConfig
public	T LayerSelectorOptions: g4uControlOptions
public	T WMSLayerButtonConfig: ButtonConfig

layers

summary
public	C BaseLayerMixin This mixin provides baselayer functionality to any layer
public	C EmptyImageLayer
public	C GroupLayer This Class is a Wrap around {ol.layer.Group} providing some extra functionality.
public	C LayerLoadProcessCountMixin A mixin to keep track the amount of load processes a source is currently waiting for
public	C ProvideMapMixin
public	C SilentGroupLayer
public	C VectorImageLayer
public	V ImageLayer: *
public	V TileLayer: *
public	T BaseLayerMixinOptions: object
public	T VectorLayerOptions: object

search

summary
public	C SearchControl
public	T SearchControlOptions: g4uControlOptions
public	T SearchControlModuleOptions: object
public	T SearchViewOptions: Object

search/connectors

summary
public	C G4USearchV2Connector
public	C G4UServerSearchConnector
public	C NominatimSearchConnector
public	C NominatimSearchConnector
public	T SearchConnectorOptions: Object

sources

summary
public	C ClusterSource
public	C TileWMSSource
public	C QueryVectorSource A source for a VectorLayer which address is controlled by the urlapi and which is not shown in the LayerSelector
public	C QueryWMSMixin A source for a VectorLayer which address is controlled by the urlapi and which is not shown in the LayerSelector
public	C SourceServerVector A custom Source class handling Vector Sources.
public	C WMTSSource
public	V QueryImageWMSSource: *
public	V QueryTileWMSSource: *
public	T ArcGISRESTFeatureSourceOptions: module:ol/source/Vector~Options Please note that a 'BBOX' or 'TILE' loadingStrategy is required
public	T WMSFeatureInfoOptions: object
public	T WMSSSourceConfig: SourceConfig A wms source config.
public	T QuerySourceOptions: SourceServerVectorOptions
public	T SourceServerVectorOptions: module:ol/source/Vector~Options

urlapi

summary
public	C LinkGenerator Generates links optionally wrapped in iframe- or a-tags that can be copied or clicked by the user.
public	C Marker Represents a single location with text on the map which can be setted via the url api.
public	C Query
public	C URLAPI The purpose of the URLAPI is two-fold:
public	C URLAPIModule The URLAPI module provides a possibility to control the map with various parameters from the URL.
public	T LinkGeneratorOptions: g4uControlOptions
public	T MarkerOptions: object
public	T URLAPIOptions: object
public	T URLParameter: object

urlapi/controls

summary
public	C CloseWindowButton Close the window.
public	C LinkGeneratorButton Shows a window which contains a link to the current location of the map.
public	C MaximizeButton Opens the client in a new maximized window
public	T CloseWindowButtonOptions: g4uControlOptions
public	T LinkGeneratorButtonOptions: g4uControlOptions
public	T MaximizeButtonOptions: g4uControlOptions

urlapi/handling

summary
public	V availableLayersParam: URLParameter
public	V centerParam: URLParameter
public	V closeButtonParam: URLParameter
public	V configurationFileParam: URLParameter
public	V fitRectangleParam: URLParameter
public	V languageParam: URLParameter
public	V layerConfigurationFileParam: URLParameter
public	V markerParam: URLParameter
public	V responsivenessParam: URLParameter
public	V rotationParam: URLParameter
public	V searchParam: URLParameter
public	V visibleLayersParam: URLParameter
public	V zoomParam: URLParameter

Directories