Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified src/manage/dashboard-maps/basemap-addition.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/manage/dashboard-maps/basemap-addition.xcf
Binary file not shown.
Binary file modified src/manage/dashboard-maps/basemap-selection.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/manage/dashboard-maps/basemap-selection.xcf
Binary file not shown.
Binary file modified src/manage/dashboard-maps/dashboard-map-properties.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/manage/dashboard-maps/dashboard-map-properties.xcf
Binary file not shown.
Binary file added src/manage/dashboard-maps/dashboard-open-map.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/manage/dashboard-maps/dashboard-open-map.xcf
Binary file not shown.
Binary file removed src/manage/dashboard-maps/dashboard-webmap.gif
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/manage/dashboard-maps/dashboard-webmap.xcf
Binary file not shown.
78 changes: 50 additions & 28 deletions src/manage/dashboard-maps/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,79 +5,101 @@ outline: deep

# Webmaps Overview

The spatial data of your project can be displayed and explored in the **Map** tab of the project on the <DashboardShortLink />. As an early access feature, they can also be [shared via URL](#sharing-maps-via-url).
[[toc]]

![Mergin Maps dashboard map](./dashboard-webmap.gif "Mergin Maps dashboard map")
The spatial data of your project can be displayed and explored on the <DashboardShortLink />. As an early access feature, webmaps can also be [shared via URL](#sharing-maps-via-url).

:::tip Usage details
To open the webmap, navigate to your project and click the **Open map** button.

![Mergin Maps dashboard Open webmap](./dashboard-open-map.webp "Mergin Maps dashboard Open webmap")

On the webmap, you can see your survey layers or raster layers that are [packaged](#project-layers) with the project.

![Mergin Maps webmaps](./dashboard-webmap.webp "Mergin Maps webmaps")

In the **Layers** panel, you can control the visibility of the [layers](#project-layers), switch [map themes](#map-themes) and [basemaps](#background-maps). The default extent of maps is defined by the [extent set in the QGIS project](#extent).

The webmap is refreshed automatically, so you always see the latest version of your project without needing to reload the page.

Features can be explored on the map: click on a feature to display its attributes form.

![Mergin Maps dashboard maps](./dashboard-map-properties.webp "Mergin Maps dashboard maps")


:::tip Usage requirements
Webmaps are available for <MainPlatformNameLink /> cloud and <EnterprisePlatformNameLink /> users.

Webmaps are **not** available for <CommunityPlatformNameLink /> at this point.
Webmaps are **not** available for <CommunityPlatformNameLink />.
:::

## Project layers
On the webmaps, you will see your survey layers or raster layers that are [packaged](../project/#packaging-qgis-project) with the project. The default extent of maps is defined by the [extent set in the QGIS project](../../gis/features/#project-extent).
## Layers {#project-layers}
Webmaps show layers that are packaged with the project (loaded from project files) by default. These are usually GeoPackage or Shapefile layers, as well as background maps made available for [offline use](../../gis/settingup_background_map/#generating-xyz-mbtiles-raster-tiles-for-offline-use) (e.g. mbtiles, GeoTIFF).

All maps on the <DashboardShortLink /> by default offer [<MainPlatformName /> vector tile service](../../gis/settingup_background_map/#online-services-1) as a background map, with three styles: default, light and dark.
Layers requiring a network connection (e.g. PostgreSQL layers or online background maps) are excluded from the webmap by default due to potential performance and connectivity problems. However, certain network layers (such as satellite background map) can be added manually, read more in the [custom background maps](#add-custom-background-maps) section.

The webmap is refreshed automatically, you will see the latest version of your project all the time, even without refreshing the web page.
The **Layers** panel lists all available layers displayed on the map, together with their legend as defined in QGIS.

The **Layers** panel lists all available layers displayed on the map, together with their legend as defined in QGIS. The eye button next to the layer name controls the visibility of layers. If you have defined map themes in your project, these are visible on top of the layers panel.
The eye icon next to a layer toggles its visibility.

![Mergin Maps webmaps toggle layer visibility](./webmaps-toggle-layer-visibility.webp "Mergin Maps webmaps toggle layer visibility")

You can also switch [Map themes](../../gis/setup_themes/) defined in the project:
## Map themes
If you have defined [map themes](../../gis/setup_themes/) for your project, you can switch between them in the **Layers** panel.

![Mergin Maps webmaps toggle layer visibility](./webmaps-map-themes.webp "Mergin Maps webmaps toggle layer visibility")

Click on a feature on the map to display its attributes.

![Mergin Maps dashboard maps](./dashboard-map-properties.webp "Mergin Maps dashboard maps")
## Background maps

By default, all webmaps include the [<MainPlatformName /> vector tile service](../../gis/settingup_background_map/#online-services-1) as a background map.

## Available layers
Webmaps by default show layers that are packaged with the project (loaded from project files). These are usually GeoPackage layers, shapefile layers and background maps that are made available for offline use (e.g. mbtiles, GeoTIFF, ...).
![Mergin Maps Webmaps background maps](./webmaps-background-maps.webp "Mergin Maps Webmaps background maps")

You can switch between three styles: default, light, and dark.
![Mergin Maps Webmaps background maps](./webmaps-background-maps-theme.webp "Mergin Maps Webmaps background maps")

Layers requiring network connection (e.g. PostgreSQL layers or online background maps) are by default not included on the webmap due to potential performance and connectivity problems. However, certain network layers (such as satellite background map) can be added manually, read more in the [following section](#add-custom-background-maps).

### Add custom background maps
If you prefer a different background map than the official ones provided by default, you can add a custom one in the basemap selection.
If you prefer a different background map than the default options, you can add a custom one in the **basemap** selection.

1. In the layers section, click on the top-left basemap selection item
1. In the **Layers** section, click on the top-left basemap selection item, then select **+ Add new**.

![Mergin Maps webmaps background map selection](./basemap-selection.webp "Mergin Maps webmaps background map selection")

2. Click the `+ Add new` button
2. Enter the connection details for your background map and click **Add basemap** to confirm.

Please note that **raster tiles** and **vector tiles** are supported.

![Mergin Maps webmaps adding background map](./basemap-addition.webp "Mergin Maps webmaps adding background map")

3. Fill in the connection details of your background map. Please note that `vector tiles` and `raster tiles` are supported
4. Hit `Add basemap` and your background map, if available, will be enabled automatically
4. If available, your basemap will be enabled automatically.

![Mergin Maps webmaps satellite background map](./basemap-satellite.webp "Mergin Maps webmaps satellite background map")

:::warning Background maps licensing
Keep in mind that background maps services and data sources come with their own terms of use, especially if they are to be publicly shared. You should comply with any terms and conditions of the services of your choice.
:::

## Custom webmap applications <Badge text="Experimental 🧪" />
Webmaps can be further programmatically customised via `map-script` to build a custom webmap application. This feature can be used to add layers, alter visual and functional elements, and more. Read more [here](../webmaps-applications/).

## Extent

The extent of webmaps is defined in QGIS in the **Project Properties**.
Webmap extent is defined in QGIS in the **Project Properties**.

When displaying maps on the <DashboardShortLink />, <MainPlatformName /> uses primarily the [project full extent](../../gis/features/#project-extent) defined in the **View Settings** tab.
When displaying webmaps, <MainPlatformName /> primarily uses the [project full extent](../../gis/features/#project-extent) defined in the **View Settings** tab.

![QGIS set project extent](../../gis/features/qgis-project-extent.jpg "QGIS set project extent")

If this parameter is not defined, the map extent will be set as the *Advertised extent* from the **QGIS Server** tab.
If this is not defined, the map extent defaults to the *Advertised extent* from the **QGIS Server** tab.

![Maps in dashboard extent set in QGIS project](./qgis-project-properties-qgis-server-extent.jpg "Maps in dashboard extent set in QGIS project")

If there are no extent settings in the QGIS project, <MainPlatformName /> will calculate the extent from layers in the project.

## Sharing maps via URL <Badge text="early access" type="warning"/>

Webmaps can be shared via URL or embedded on a website. You can find more details about this early access feature in [Sharing and Embedding Webmaps](../webmaps-sharing/).
You can share webmaps via URL or embed them on a website. More details about this early access feature can be found in [Sharing and Embedding Webmaps](../webmaps-sharing/).

## Custom webmap applications <Badge text="Experimental 🧪" />
You can further customise webmaps programmatically using `map-script` to build custom webmap applications. This feature can be used to add layers, alter visual and functional elements, and more. Read more [here](../webmaps-applications/).

## Troubleshooting
Troubleshooting tips for webmaps can be found [here](../webmaps-troubleshooting/).
Troubleshooting tips for webmaps are available [here](../webmaps-troubleshooting/).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified src/manage/dashboard-maps/webmaps-map-themes.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/manage/dashboard-maps/webmaps-map-themes.xcf
Binary file not shown.
Binary file modified src/manage/dashboard-maps/webmaps-toggle-layer-visibility.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/manage/dashboard-maps/webmaps-toggle-layer-visibility.xcf
Binary file not shown.
13 changes: 8 additions & 5 deletions src/manage/dashboard/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
description: Mergin Maps dashboard is where you manage your projects, workspace members, subscriptions and profiles. Explore files, history, webmaps of your projects.

outline: deep
---

# Mergin Maps Dashboard
Expand All @@ -26,7 +28,7 @@ Here, you can:

When you click on a project, you will see the overview of its content. Files can simply be **uploaded** to the project using drag and drop.

In the right upper corner, you will find buttons to **download** and [**clone**](../create-project/#clone-an-existing-project-through-mergin-maps-dashboard) the project.
In the right upper corner, there are buttons to [**open map**](../dashboard-maps/), **download** and [**clone**](../create-project/#clone-an-existing-project-through-mergin-maps-dashboard) the project.

![Mergin Maps dashboard project details](./mergin-maps-project-details.jpg "Mergin Maps dashboard project details")

Expand All @@ -42,7 +44,7 @@ On the **Map** tab, your project is displayed directly on the <DashboardShortLin

More details about this functionality can be found in the [Webmaps](../dashboard-maps/) section.

![Mergin Maps dashboard webmaps](./mergin-maps-web-map.webp "Mergin Maps dashboard webmaps")
![Mergin Maps dashboard webmaps](../dashboard-maps/dashboard-webmap.webp "Mergin Maps dashboard webmaps")

### History
The **History** tab contains an overview of available project versions that can be also downloaded to your computer.
Expand All @@ -62,8 +64,9 @@ Here, the [**project permissions**](../permissions/#workspace-member-roles-and-p

![Mergin Maps project collaborators](./mergin-maps-dashboard-project-collaborators.jpg "Mergin Maps project collaborators")

### Settings
In **Settings**, you can:
### Settings and API {#settings}
In **Settings & API**, you can:
- **Enable** [OGC API access](../../gis/ogc-api/) and copy WFS and WMS / WMTS URL
- make the project [public or private](../project-advanced/#make-your-project-public-private)
- [Transfer project](../project-advanced/#transfer-a-project) to another workspace
- [Delete project](../project-advanced/#delete-a-project)
Expand Down Expand Up @@ -105,7 +108,7 @@ For details about different subscription plans visit our <MainDomainNameLink id=
## Settings
In the **Settings** tab, you will find information about the current workspace.

Here, [admins and owners](../permissions/#workspace-member-roles-and-project-permissions) of a workspace can set up or manage [Single sign-on (SSO)](../sso/).
Here, [admins and owners](../permissions/#workspace-member-roles-and-project-permissions) of a workspace can set up or manage [Single sign-on (SSO)](../sso/) and enable early access program features ([Map sharing via URL](../webmaps-sharing/), [OGC API read-only access](../../gis/ogc-api/)).

[Owners](../permissions/#workspace-member-roles-and-project-permissions) of a workspace can also:
- use **Edit Workspace** to add or change the description of the workspace
Expand Down
Binary file modified src/manage/dashboard/mergin-maps-dashboard-file-detail.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/manage/dashboard/mergin-maps-dashboard-file-detail.xcf
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified src/manage/dashboard/mergin-maps-dashboard-project-history.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/manage/dashboard/mergin-maps-dashboard-project-history.xcf
Binary file not shown.
Binary file modified src/manage/dashboard/mergin-maps-dashboard-project-settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/manage/dashboard/mergin-maps-dashboard-project-settings.xcf
Binary file not shown.
Binary file modified src/manage/dashboard/mergin-maps-dashboard-settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/manage/dashboard/mergin-maps-dashboard-settings.xcf
Binary file not shown.
Binary file modified src/manage/dashboard/mergin-maps-project-details.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/manage/dashboard/mergin-maps-project-details.xcf
Binary file not shown.
Binary file removed src/manage/dashboard/mergin-maps-web-map.webp
Binary file not shown.
Binary file removed src/manage/dashboard/mergin-maps-web-map.xcf
Binary file not shown.
18 changes: 9 additions & 9 deletions src/manage/webmaps-sharing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ description: Mergin Maps webmaps can be shared using a URL link. You can also em
# Sharing and Embedding Webmaps <Badge text="Early access" type="warning"/>

::: warning Early access feature
Map sharing is in early access. If you would like to try it out, ask your workspace admin or owner to enable map sharing early access program in your [workspace settings](https://app.merginmaps.com/settings). The availability of the feature might change in the future.
Map sharing is currently available as an early access feature. If you would like to try it out, ask your workspace admin or owner to enable map sharing early access program in your [workspace settings](https://app.merginmaps.com/settings). The availability of the feature might change in the future.
:::

## Sharing maps via URL

Webmaps can be shared via URL. [Admins or owners](../permissions/) can enable map sharing for a project, so that anyone with the link can display and explore your project in a web browser, without the need to log in to <MainPlatformNameLink /> or make the project [public](../project-advanced/#make-your-project-public-private).
You can share webmaps via a direct URL. [Admins or owners](../permissions/) can enable map sharing for a project, allowing anyone with the link can display and explore it in a web browser, without the need to log in to <MainPlatformNameLink /> or make the project [public](../project-advanced/#make-your-project-public-private).

1. Navigate to your project on the <DashboardShortLink />.
2. In the **Map** tab, click on the **Share map** button to generate a shareable link
3. Send the link to anyone to share your project

To see how this works, you can try a link to our [sample webmap](https://app.merginmaps.com/maps/grDTleg8yCdSracIxs-hmFIGdDs).

To disable the map sharing, click on the **Revoke sharing** button.
1. Navigate to your project on the <DashboardShortLink />
2. Click the **Open map** button to open the [webmap](../dashboard-maps/)
3. Click the **Share map** button to display the public map link
4. Copy and share the link to provide access to your webmap

![Sharing maps via URL](./map-sharing-url.webp "Sharing maps via URL")

To see this feature in action, you can try a link to our [sample webmap](https://app.merginmaps.com/maps/grDTleg8yCdSracIxs-hmFIGdDs).

To disable the map sharing, click the **Stop sharing** button.

## Embedding webmaps using HTML

Expand Down
Binary file modified src/manage/webmaps-sharing/map-sharing-url.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/manage/webmaps-sharing/map-sharing-url.xcf
Binary file not shown.
Loading