Namespace: luxx

luxx.BgSelectorOptions

luxx.Exclusions

luxx.FeaturesOptions

Object literal with config options for the feature recenter.

Source:

Members

click :boolean|undefined

If set, the popup is displayed when clicking the feature.

Type:
Source:

ids :Array.<string>

Comma-separated list of ids. Required.

Type:
Source:

layer :string|number

Layer identifier Required.

Type:
Source:

maxZoom :number|undefined

The maximal zoom level to use when zooming on a feature. Default is 17.

Type:
Source:

showMarker :boolean|undefined

If set to true, a marker is shown. Default is true.

Type:
Source:

target :Element|string

The container for the feature popup, either the element itself or the id of the element. Required.

Type:
Source:

luxx.GeocodeOptions

The address object to send to the geocoding webservice.

Source:

Members

locality :string

The locality name. Required.

Type:
Source:

num :number

The house number. Required.

Type:
Source:

queryString :string

The complete address into one string. Required.

Type:
Source:

street :string

The street name. Required.

Type:
Source:

zip :number

The postal code. Required.

Type:
Source:

luxx.GeocodeResponse

luxx.LayerManagerOptions

luxx.LayerMetadataOptions

luxx.LayerOptions

luxx.LayersOptions

luxx.MapOptions

Object literal with config options for the map.

Source:

Members

bgLayer :string|undefined

Identifier of background layer. Default to basemap_2015_global.

Type:
Source:

bgLayerStyle :string|undefined

Style to apply to vector tile background layer.

Type:
Source:

bgLayerStyleXYZ :string|undefined

XYZ layer to apply to vector tile background layer when printing. Ex: 'https://vectortiles.geoportail.lu/styles/roadmap/{z}/{x}/{y}.png'.

Type:
Source:

bgSelector :luxx.BgSelectorOptions|undefined

Set the presence of a background selector control in the map. (not included by default).

Type:
Source:

callback :function|undefined

Function called when the objects are initialized.

Type:
Source:

controls :ol.Collection.<ol.control.Control>|Array.<ol.control.Control>|undefined

Controls initially added to the map. If not specified, ol.control.defaults() is used plus a rotate control.

Type:
Source:

features :luxx.FeaturesOptions|undefined

Set the presence of features to recenter on & to show markers for. (not included by default).

Type:
Source:

interactions :ol.Collection.<ol.interaction.Interaction>|Array.<ol.interaction.Interaction>|undefined

Interactions initially added to the map. If not specified, ol.interaction.defaults() is used, plus a dragRotate interaction.

Type:
Source:

layerInfoCallback :function|undefined

Function called when an info layer is return.

Type:
Source:

layerManager :luxx.LayerManagerOptions|undefined

Set the presence of a layer manager control. (not included by default)

Type:
Source:

layerOpacities :Array.<number>|undefined

Array of opacities for the layers.

Type:
Source:

layers :Array.<(string|number)>|undefined

Array of overlay layer identifiers.

Type:
Source:

layerVisibilities :Array.<boolean>|undefined

Array of visibilities for the layers.

Type:
Source:

mouseWheelZoom :boolean|undefined

Allows the user to zoom the map by scrolling the mouse wheel. Default is true.

Type:
Source:

popupAutoPan :boolean|undefined

If the popup should automatically pan or not. Default is false.

Type:
Source:

popupClassPrefix :string|undefined

The css class of the element that contains each row

Type:
Source:

popupContentTransformer :function|undefined

Function called to transform the result of the information popup.

Type:
Source:

popupTarget :Element|string|undefined

The container for map popups, either the element itself or the id of the element.

Type:
Source:

position :ol.Coordinate|undefined

The initial position of the center for the map view. The coordinate system for the center is specified with the positionSrs option. If a center is defined in the view, then this parameter will override the center defined in the view.

Type:
Source:

positionSrs :string|number|undefined

The projection of the position coordinates. Default is 2169.

Type:
Source:

queryableLayers :Array.<(string|number)>|undefined

Array of queryable layers.

Type:
Source:

The search configuration.

Type:
Source:

showLayerInfoPopup :boolean|undefined

If set to true, it displays the feature information in a popup or in popupTarget element.

Type:
Source:

target :Element|string

The container for the map, either the element itself or the id of the element. Required.

Type:
Source:

view :ol.View|undefined

The map's view.

Type:
Source:

luxx.MarkerOptions

luxx.MousePositionOptions

luxx.MyMapOptions

Source:

Members

fitToExtent :boolean

Fit to the mymaps extent. Default value is true. Required.

Type:
Source:

layerVisibility :boolean

The layer visibility. Default is visible. Required.

Type:
Source:

mapId :string|undefined

The map identifier.

Type:
Source:

mapIds :Array.<string>|undefined

An array of map identifiers.

Type:
Source:

name :string

The name of the mymaps layer. Required.

Type:
Source:

onClick :function|undefined

If set, the function is called when clicking on the object and the popup is not displayed.

Type:
Source:

onload :function|undefined

The function called once the map is loaded. Optional.

Type:
Source:

profileTarget :string|undefined

The id of the element in which to put the profile (without #). Optional. It is recommended to set the display style to none at first. The display will then be set to block adequately.

Type:
Source:

showPopup :boolean|undefined

If true, the popup is displayed on click. Default is True.

Type:
Source:

luxx.ReverseGeocodeResponse

luxx.ReverseGeocodeResult

Address returned by the reverse geocoding webservice.

Source:

Members

distance :number

The distance in meter between the coordinate and the found address. Required.

Type:
Source:

geom :ol.geom.Geometry

The location of the found address. Required.

Type:
Source:

id_caclr_bat :String

The internal id of the batiment. Required.

Type:
  • String
Source:

id_caclr_street :String

The internal id of the street. Required.

Type:
  • String
Source:

locality :String

The locality of the found address. Required.

Type:
  • String
Source:

number :String

The house number. Required.

Type:
  • String
Source:

postal_code :String

The postal code of the locality. Required.

Type:
  • String
Source:

street :String

The street name. Required.

Type:
  • String
Source:

luxx.SearchOption

Object literal with config options for the search.

Source:

Members

dataSets :Array.<string>|undefined

A dataSets Array of layer used as search sources. Default is Adresse. Possible values are 'Adresse' and 'Coordinates'.

Type:
Source:

onSelect :function|undefined

The function to be called when an entry is selected. The default function center the map on the selection and add an overlay.

Type:
Source:

target :Element|string

The container for the map, either the element itself or the id of the element. Required.

Type:
Source:

luxx.State

luxx.VectorOptions

Object literal with config options for the vector (GPX/KML) layer.

Source:

Members

click :boolean|undefined

If set, the popup is displayed when clicking the feature.

Type:
Source:

fit :boolean|undefined

True if map should fit to the vector. Default and undefined are true.

Type:
Source:

name :string|undefined

The layer name.

Type:
Source:

onClick :function|undefined

If set, and if click is true then the function is called with the feature as parameter.

Type:
Source:

onFeatureAdd :function|undefined

Callback function called when a feature is added.

Type:
Source:

reloadInterval :number|undefined

Interval after which to reload the vector layer (in seconds).

Type:
Source:

style :ol.StyleFunction|undefined

The style function.

Type:
Source:

target :Element|string|undefined

The container for the feature popup, either the element itself or the id of the element.

Type:
Source: