import {URLAPIModule} from 'guide4you/src/urlapi/URLAPIModule.js'

public class | source

URLAPIModule

Extends:

Module → URLAPIModule

The URLAPI module provides a possibility to control the map with various parameters from the URL. this contains a simple marker class which is a position on the map combined with some text. This module can also generate URL which will reproduce the map in most of its current state. This is used by the control LinkGenerator which can display the URL in various forms and by the LinkGeneratorButton which can additionally let the user set the marker on the map and give it a text.

The URLAPI module extends the G4UMapOptions by 2 parameters:

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	moduleParameters_: *

Method Summary

Public Methods
public	configureUI(mapConfig: *): undefined This method is called once when the map is configured
public	createControl(controlType: string, options: g4uControlOptions, receiver: ComposedControl \| G4UMap): undefined \| Control This method is called if the ControlFactory cant construct controls of this type
public	setMap(map: G4UMap)

Inherited Summary

From class Module
private	map_: G4UMap
public	configureMap(mapConfig: *): undefined This method is called once when the map is configured
public	configureUI(mapConfig: *): undefined This method is called every time the ui is recreated
public	createControl(controlType: string, options: g4uControlOptions, receiver: ComposedControl \| G4UMap): undefined \| Control This method is called if the ControlFactory cant construct controls of this type
public	createLayer(type: string, options: g4uLayerOptions, superType: SuperType, skipIdCheck: boolean): undefined \| ol.layer.Base This method is called if the LayerFactory cant construct layers of this type
public	enableUserActionTracking(): undefined Thsi method is called if the map enables userActionTracking
public	getMap(): G4UMap
public	setMap(map: G4UMap)

Public Constructors

public constructor() source

Public Members

public moduleParameters_: * source

Public Methods

public configureUI(mapConfig: *): undefined source

This method is called once when the map is configured

Override:

Module#configureUI

Params:

Name	Type	Attribute	Description
mapConfig	*

Return:

undefined

public createControl(controlType: string, options: g4uControlOptions, receiver: ComposedControl | G4UMap): undefined | Control source

This method is called if the ControlFactory cant construct controls of this type

Override:

Module#createControl

Params:

Name	Type	Attribute	Description
controlType	string
options	g4uControlOptions
receiver	ComposedControl \| G4UMap

Return:

undefined | Control

public setMap(map: G4UMap) source

Override:

Module#setMap

Params:

Name	Type	Attribute	Description
map	G4UMap