- Source:
Web and Mobile client setting
Members
(static) qgisVersion :string
- Source:
- Default Value:
- "3.4"
QGIS Server version installed. Use only major number (2.18, 3.4,...)
Type:
- string
(static) title :string
- Source:
- Default Value:
- "projectData.title+' '+projectData.client_display_name";
Template string for web client header and browser window title
Type:
- string
Example
"TR.appName+projectData.title+' '+projectData.client_display_name";
(static) limitAttributeFeatures :number
- Source:
- Default Value:
- 2000
Limit number of features to request from server for displaying layer attribute table. If number of returned features is equal to limit then load more button is displayed in table toolbar.
Type:
- number
(static) syncAttributeTableWithView :boolean
- Source:
- Default Value:
- false
Enable by default synchronizing attribute table with current map extent. User can manage displaying whole table (with limitAttributeFeatures) or display only visible elements with button below table (it is updated on map zoom or move).
Type:
- boolean
(static) limitSearchMaxResults :number
- Source:
- Default Value:
- 10
Number of results in SearchPanel and Identify result window. FEATURE_COUNT value in WMS request
Type:
- number
(static) featureInfoTolerances :Object
- Source:
- Default Value:
- {{point: 4, line: 4, polygon: 2}}
Tolerances for WMS GetFeatureInfo requests on QGIS Server
tolerance values are in pixels at map dpi and will be scaled with the actual pixel ratio value for high resolution rendering
Type:
- Object
(static) enableHoverPopup :boolean
- Source:
- Default Value:
- false
Enable tooltip text when mouse cursor is over features
Type:
- boolean
(static) defaultIdentificationMode :string
- Source:
- Default Value:
- "allLayers"
Set default mode for identify option
Possible values are:
"allLayers"
,"topMostHit"
,"activeLayers"
Note: You can control visibility of this combo for specific project in gisapp database.
Type:
- string
(static) showCoordinatesIdentify :boolean
- Source:
- Default Value:
- true
Display coordinates of clicked location on top of identify window results
Type:
- boolean
(static) replaceIdentifyLayerWithView :Array
- Source:
Replace layer name in GetFeatureInfo request (identify and attributes table) and in layer export. Useful to create database view for layer, where you can reorder fields or create new read only fields from geometry, like: area, length, X, Y. This data will be displayed in identify window and attributes table and used in layer export instead of data from original layer. You could use view in QGIS in the first place for ordinary layers, but if you wish that layer is editable it cannot be connected to view.
Prepare:
- Write in this array layer name as it is in QGIS project,
- Create corresponding view named as your_layer_name_view and add it to the QGIS project. View will be hidden from legend and map.
- Set view symbology to transparent or no symbol, to avoid "seeing" it in print, because it must be added to print layers in case if its table is used in print layout.
If layer name is "points", view name must be "points_view", add in array only "points"
Type:
- Array
Example
"['points']";
(static) QgisUsersPrintName :string
- Source:
- Default Value:
- "users_print_view"
Set print table name from QGIS project needed to store information about title and description for each user last print.
To enable: add users_print_view into QGIS project from gisapp database. You must add table to print layout, table will always have max 1 row for current user. This table is removed from EQWC legend tree
Type:
- string
(static) visibleFirstBaseLayer :boolean
- Source:
- Default Value:
- true
Should first baselayer be visible on opening project
Type:
- boolean
(static) noDataValue :string
- Source:
- Default Value:
- ""
Display NULL values
Type:
- string
(static) overWriteRasterFieldName :Object
- Source:
- Default Value:
- {}
Overwrite identify values for raster data, instead of Band 1 write desired value to be displayed as a column name
Type:
- Object
Examples
{["layername"] = ["Band 1", "Your value"]}
{["my_elevation.tif"] = ["Band 1", "Elevation"]}
(static) numZoomLevels :number
- Source:
- Default Value:
- 22
Number of Zoom levels in map. This is relevant only in cases where Map does not contain base layers!
Type:
- number
(static) fixedPrintResolution :null|number
- Source:
- Default Value:
- null
Allow users to choose print options (leave null) or to have fixed resolution (type number for fixed DPI value).
Type:
- null | number
Example
200
(static) printCapabilities :Object
- Source:
Define print options (scales and DPIs). For fixed DPI value look fixedPrintResolution
Type:
- Object
(static) symbolizersHighLightLayer :Object
- Source:
Styling definition for highlight Layer (GetFeatureInfo and search result visualization)
Type:
- Object
(static) useGisPortal :boolean
- Source:
- Default Value:
- false
Integrate separate gisportal code to browse projects and manage database
Type:
- boolean
(static) gisPortalTitle :string
- Source:
- Default Value:
- ''
Optional prefix to browser window title
Type:
- string
(static) mobileUseTiledWMS :boolean
- Source:
- Default Value:
- false
Use tiled WMS requests for QGIS project
Mobile only
Type:
- boolean
(static) mobileEnableTracking :boolean
- Source:
- Deprecated:
- since release 1.9.2 (setting not needed anymore)
- Default Value:
- false
Enable tracking by default (auto center map on current position when position is on)
Mobile only
Type:
- boolean
(static) mobileMinScale :number
- Source:
- Default Value:
- 50
Minimum scale (maximum zoom to scale) for map
Mobile only
Type:
- number
(static) mobileShowAccuracy :boolean
- Source:
- Default Value:
- true
Show accuracy information in location panel
Mobile only
Type:
- boolean
(static) qgisFilesFieldAlias :string
- Source:
- Default Value:
- "files"
Change that if you set alias for files field in QGIS, then enter same alias here
Editor plugin
Type:
- string
(static) measurementsUnitSystem :string
- Source:
- Default Value:
- "metric"
Unit system for displaying distance and area measurements.
Possible values are:
"metric"
,"english"
,"geographic"
metric: "km", "m"
english: "mi", "ft", "in" for length and "ac" for area
geographic: "dd"
Type:
- string
(static) layerLegendMaxHeightPx :number
- Source:
- Default Value:
- 200
Maximum allowed height in pixels for layer legend. If legend height is larger, vertical scroller will be used
Type:
- number
(static) vectorExportFormats :Array.<Array.<string>>
- Source:
Possible vector layers export formats in form: ['name'], ['description']
. You can remove formats from list or rename format description (keep format name as it is!)
Type:
- Array.<Array.<string>>
Example
[
['SHP', 'ESRI Shapefile'],
['DXF', 'AutoCAD DXF'],
['XLSX', 'MS Office Open XLSX'],
['CSV', 'Text CSV (semicolon)'],
['TSV', 'Text TSV (tab)'],
['KML', 'Keyhole Markup Language KML'],
['GeoJSON', 'GeoJSON']
]
(static) tableExportFormats :Array.<Array.<string>>
- Source:
Possible table layers (no geometry) export formats in form: ['name'], ['description']
. You can remove formats from list or rename format description (keep format name as it is!)
Type:
- Array.<Array.<string>>
Example
[
['XLSX', 'MS Office Open XLSX'],
['CSV', 'Text CSV (semicolon)'],
['TSV', 'Text TSV (tab)']
]
(static) bookmarkPanelHeight :number
- Source:
Height for initial bookmarks panel in px. User can resize it later. Only visible if there are any bookmarks stored in QGIS project. Set value to 0 to hide bookmark panel.
Type:
- number
(static) fieldTemplates :Object
- Source:
- Default Value:
- {}
Configuration for formatting values in web client identify window. Possible actions are:
- display field boolean values as translated yes/no or empty strings
- display fixed tooltip for field values
- display dynamic tooltip using database and WSGI part for specific field value
- link to URL using field value as part of URL, use HTML tag Format: { FIELD_NAME1_UPPER_CASE: {template: string}, FIELD_NAME2_UPPER_CASE: {template: string} }
Type:
- Object
Example
{
'BOOLEAN_FIELD': {template: "BOOLEAN"},
'DB_LOOKUP_FIELD': {template: "%VALUE%", url: 'https://your_server/wsgi/lookup.wsgi?table=db_table_name&code='},
'LINK_AND_TOOLTIP_FIELD': {template: "<a class='link' ext:qtitle='Tip title' ext:qwidth='150' ext:qtip='This is a quick tip from markup!' href='http://www.google.it/#output=search&q=%VALUE%' target='_blank'>%VALUE%</a>"}
}
(static) toolTipEmptyText :string
- Source:
This text is displayed as tooltip when dynamic tooltip using configuration above cannot retrieve data from WSGI script
Type:
- string
(static) guestWinTitle :null|string
- Source:
Display of modal window that guest users must accept before continue. Write title for window to display it.
Type:
- null | string
(static) guestWinConfirm :string
- Source:
Button text for accepting conditions for guest users
Type:
- string
(static) guestWinText :string
- Source:
Detail text in HTML for modal window
Type:
- string
(static) defaultCoordinatesCrsCode :null|number
- Source:
- Default Value:
- null
By default project CRS is selected for displaying coordinates. You can change default display of coordinates with this setting.
Note: CRS must have it's definition loaded (EPSG js file) and must be added to QGIS project properties CRS restriction part. Note: This setting here is global for all projects. Can be overwritten per each project by adding data into project.json file into defaultCoordinatesCrsCode property.
Type:
- null | number
Example
3794
(static) expandAllGroups :boolean
- Source:
- Default Value:
- false
By default all groups inside QGIS project will be closed in web client. This setting to true opens all groups in web client on project open.
Note: This setting here is global for all projects. Can be overwritten per each project by adding data into project.json file into expandAllGroups property.
Type:
- boolean
(static) search :Array.<string>
- Source:
More information - search panels
Note: This setting here is global for all projects. Can be overwritten per each project by adding data into project.json file into search property.
Type:
- Array.<string>
(static) geocode :Object
- Source:
More information - search combo
Note: This setting here is global for all projects. Can be overwritten per each project by adding data into project.json file into geocode property.
Type:
- Object
(static) wsgi :Object
- Source:
More information - search combo
Note: This setting here is global for all projects. Can be overwritten per each project by adding data into project.json file into wsgi property.
Type:
- Object
(static) locationServices :Array.<string>
- Source:
More information - https://github.com/level2-gis/gisapp/wiki/5.2.-JSON#3-location-services
Note: This setting here is global for all projects. Can be overwritten per each project by adding data into project.json file into locationServices property.
Type:
- Array.<string>