Class: OptionsConfig

Options.OptionsConfig(cfg)

Class representing the options config

Constructor

new OptionsConfig(cfg)

Create an options config instance based on a config object
Parameters:
Name Type Description
cfg object the lizmap config object for options
Properties
Name Type Attributes Description
bbox Array.<number> the project and web services max extent
initialExtent Array.<number> the map extent at the loading page
mapScales Array.<number> the map scales
minScale number the map's min scale
maxScale number the map's max scale
projection object the web map projection
pointTolerance number the point tolerance for QGIS Server WMS GetFeatureInfo request
lineTolerance number the line tolerance for QGIS Server WMS GetFeatureInfo request
polygonTolerance number the polygon tolerance for QGIS Server WMS GetFeatureInfo request
popupLocation string the popup location in the User interface: dock, bottom-dock, right-dock, mini-dock, map
datavizLocation string the popup location in the User interface: dock, bottom-dock, right-dock
hideProject boolean <optional>
 is the project hidden in user interface ? Only services are available.
wmsMaxHeight number <optional>
 the image max height for WMS GetMap request
wmsMaxWidth number <optional>
 the image max width for WMS GetMap request
fixed_scale_overview_map boolean <optional>
 does the Overview map have fixed scale ?
max_scale_points number <optional>
 maximum scale when zooming on points
max_scale_lines_polygons boolean <optional>
 maximum scale when zooming on lines or polygons
use_native_zoom_levels boolean <optional>
 does the map use native zoom levels ?
hide_numeric_scale_value boolean <optional>
 does the scale line hide numeric scale value ?
hideGroupCheckbox boolean <optional>
 are groups checkbox hidden ?
activateFirstMapTheme boolean <optional>
 is first map theme activated ?
automatic_permalink boolean <optional>
 is automatic permalink activated ?
wms_single_request_for_all_layers boolean <optional>
 are layers loaded as single WMS image ?
Source:

Extends

  • BaseObjectConfig

Members

activateFirstMapTheme :boolean

Activate first map theme
Type:
  • boolean
Source:
Activate first map theme
Type:
  • boolean
Source:

bbox :Extent

The project and web services max extent
Type:
  • Extent
Source:

datavizLocation :string

The popup location in the User interface dock, bottom-dock, right-dock
Type:
  • string
Source:

fixed_scale_overview_map :boolean

The Overview map has fixed scale
Type:
  • boolean
Source:

hideGroupCheckbox :boolean

Hide groups checkbox
Type:
  • boolean
Source:

hideProject :boolean

The project is hidden in user interface Services are still available
Type:
  • boolean
Source:

hide_numeric_scale_value :boolean

Hide numeric scale value
Type:
  • boolean
Source:

initialExtent :Extent

The map extent at the loading page
Type:
  • Extent
Source:

lineTolerance :number

The QGIS Server line tolerance for WMS GetFeatureInfo request
Type:
  • number
Source:

mapScales :Array

The web map scales
Type:
  • Array
Source:

maxScale :number

The web map max scale
Type:
  • number
Source:

max_scale_lines_polygons :boolean

Maximum scale when zooming on lines or polygons
Type:
  • boolean
Source:

max_scale_points :boolean

Maximum scale when zooming on points
Type:
  • boolean
Source:

minScale :number

The web map min scale
Type:
  • number
Source:

pointTolerance :number

The QGIS Server point tolerance for WMS GetFeatureInfo request
Type:
  • number
Source:

polygonTolerance :number

The QGIS Server polygon tolerance for WMS GetFeatureInfo request
Type:
  • number
Source:

popupLocation :string

The popup location in the User interface dock, bottom-dock, right-dock, mini-dock, map
Type:
  • string
Source:

projection :object

The web map projection
Type:
  • object
Source:

use_native_zoom_levels :boolean

The map uses native zoom levels
Type:
  • boolean
Source:

wmsMaxHeight :number

The image max height for WMS GetMap request
Type:
  • number
Source:

wmsMaxWidth :number

The image max width for WMS GetMap request
Type:
  • number
Source:

wms_single_request_for_all_layers :boolean

The layers are loaded as a single WMS image
Type:
  • boolean
Source: