Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Restructure Dashboards TOC #2628

Merged
merged 16 commits into from
Feb 6, 2023
2 changes: 1 addition & 1 deletion _dashboards/admin-ui-index/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Index and snapshot management in OpenSearch Dashboards
nav_order: 15
nav_order: 80
has_children: true
redirect_from:
- /dashboards/admin-ui-index/
Expand Down
6 changes: 3 additions & 3 deletions _dashboards/branding.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: default
title: Custom branding
nav_order: 200
title: Customizing your branding
nav_order: 15
---

# OpenSearch Dashboards custom branding
# Customizing your branding
Introduced 1.2
{: .label .label-purple }

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
layout: default
title: Using maps
nav_order: 15
parent: Visualization types
grand_parent: Visualize
title: Using the Maps plugin
nav_order: 60
redirect_from:
- /dashboards/maps/
---
Expand Down
33 changes: 0 additions & 33 deletions _dashboards/maptiles.md

This file was deleted.

5 changes: 1 addition & 4 deletions _dashboards/quickstart-dashboards.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Quickstart guide for OpenSearch Dashboards
nav_order: 20
nav_order: 10
has_children: false
redirect_from:
- /dashboards/index/
Expand All @@ -11,9 +11,6 @@ redirect_from:

This quickstart guide covers the core concepts that you need to understand to get started with OpenSearch Dashboards. You'll learn how to:

- Add sample data.
- Explore and inspect data with **Discover**.
- Visualize data with **Dashboard**.
- Add sample data.
- Explore and inspect data with **Discover**.
- Visualize data with **Dashboard**.
Expand Down
3 changes: 1 addition & 2 deletions _dashboards/visualize/area.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
layout: default
title: Using area charts
parent: Visualization types
grand_parent: Visualize
parent: Building data visualizations with Visualize
nav_order: 5
---

Expand Down
5 changes: 2 additions & 3 deletions _dashboards/visualize/gantt.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
layout: default
title: Using Gantt charts
parent: Visualization types
grand_parent: Visualize
nav_order: 60
parent: Building data visualizations with Visualize
nav_order: 30
redirect_from:
- /dashboards/gantt/
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
---
layout: default
title: Region map visualizations
nav_order: 40
title: Using coordinate and region maps
parent: Building data visualizations with Visualize
has_children: true
nav_order: 15
redirect_from:
- /dashboards/geojson-regionmaps/
---

# Region map visualizations
# Using coordinate and region maps

OpenSearch Dashboards provides basic map tiles with a standard vector map that you can use to create your region map visualizations. You can configure the base map tiles using the Web Map Service (WMS) map server.
OpenSearch has a standard set of GeoJSON files to provide a vector map with your region map, and OpenSearch Dashboards provides basic map tiles with a standard vector map to create region maps. You can configure the base map tiles using [Web Map Service (WMS)](https://www.ogc.org/standards/wms). For more information, see [Configuring WMS in OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/maptiles/).

You can't configure a server to support user-defined vector map layers. However, you can configure your own GeoJSON file and upload it for this purpose.
{: .note}
For air gapped environments, OpenSearch Dashboards provides a self-host maps server. For more information, see [Using the self-host maps server]({{site.url}}{{site.baseurl}}/dashboards/selfhost-maps-server/)

OpenSearch also has a standard set of GeoJSON files to provide a vector map with your regional maps.
While you can't configure a server to support user-defined vector map layers, you, however, can configure your own GeoJSON file and upload it for this purpose.
{: .note}

## Custom vector maps with GeoJSON
## Customizing vector maps with GeoJSON

If you have a specific locale that is not provided by OpenSearch Dashboards vector maps, such as a US county or US ZIP Code, you can create your own custom vector map with a GeoJSON file. To create a custom region map you would define a geographic shape such as a polygon with multiple coordinates. To learn more about the various geographic shapes that support a custom region map location, see [Geoshape field type]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/geo-shape/).

Expand All @@ -26,7 +30,7 @@ You can use [geojson.io](https://geojson.io/#map=2/20.0/0.0) to extract GeoJSON
> * OpenSearch Dashboards Maps [`dashboards-maps`](https://github.com/opensearch-project/dashboards-maps) front-end plugin
> * OpenSearch [`geospatial`](https://github.com/opensearch-project/geospatial) backend plugin
{: .note}
### Step 1: Create a region map visualization
### Step 1: Creating a region map visualization

To create your own custom vector map, upload a JSON file that contains GEO data for your customized regional maps. The JSON file contains vector layers for visualization.

Expand All @@ -41,18 +45,18 @@ Enter **Map name prefix** (for example, `usa-counties`). Your map will have the
1. Select the **Import file** button.
Once the upload is successful, you will see a pop-up prompting you to refresh the map. Select the **Refresh** button. <img src="{{site.url}}{{site.baseurl}}/images/upload-success.png" alt="message upon a successful file upload" width="280"/>

### Step 2: View the custom region map in OpenSearch Dashboards
### Step 2: Viewing the custom region map in OpenSearch Dashboards

After you upload a custom GeoJSON file, you need to set the vector map layer to custom, and select your vector map:

1. From **Layer Options > Layer settings**, select **Custom vector map**.
1. Under **Vector map**, select the name of the vector map that you just uploaded.
1. *(Optional):* Under **Style settings**, increase **Border thickness** to see the borders more clearly.
1. Select the **Update** button.
1. View your region map in the Dashboards. For example, the following image shows the Los Angeles and San Diego county regions:
2. Optional: Under **Style settings**, increase **Border thickness** to see the borders more clearly.
3. Select the **Update** button.
4. View your region map in the Dashboards. For example, the following image shows the Los Angeles and San Diego county regions:
<img src="{{site.url}}{{site.baseurl}}/images/county-region-map.png" alt="view a custom GeoJSON region map" width="700"/>

### Example GeoJSON file
#### Example GeoJSON file

The following example GeoJSON file provides coordinates for two US counties.

Expand All @@ -67,3 +71,4 @@ The following example GeoJSON file provides coordinates for two US counties.
}

```

34 changes: 34 additions & 0 deletions _dashboards/visualize/maptiles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
layout: default
title: Configuring a Web Map Service (WMS)
grand_parent: Building data visualizations with Visualize
parent: Using coordinate and region maps
nav_order: 5
redirect_from:
- /docs/opensearch-dashboards/maptiles/
---

{%- comment -%}The `/docs/opensearch-dashboards/maptiles/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}

# Configuring a Web Map Service (WMS)

The Open Geospatial Consortium (OGC) Web Map Service (WMS) specification is an international specification for requesting dynamic maps on the web. OpenSearch Dashboards includes default map tiles. For specialized maps, you can configure a WMS on OpenSearch Dashboards following these steps:

1. Open and log in to OpenSearch Dashboards at `https://<host>:<port>`. Alternatively, you can connect to OpenSearch Dashboards by connecting to [https://localhost:5601](https://localhost:5601). The default username and password are `admin`.
2. Choose **Management** > **Advanced Settings**.
3. Locate `visualization:tileMap:WMSdefaults`.
4. Change `enabled` to `true` and add the URL of a valid WMS server, as shown in the following example:

```json
{
"enabled": true,
"url": "<wms-map-server-url>",
"options": {
"format": "image/png",
"transparent": true
}
}
```

Web map services may have licensing fees or restrictions, and you are responsible for complying with any such fees or restrictions.
{: .note }
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
layout: default
title: Self-host maps server
nav_order: 30
title: Using the self-host maps server
grand_parent: Building data visualizations with Visualize
parent: Using coordinate and region maps
nav_order: 10
---

# Self-host maps server
Expand Down
5 changes: 2 additions & 3 deletions _dashboards/visualize/visbuilder.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
layout: default
title: Using VisBuilder
parent: Visualization types
grand_parent: Visualize
nav_order: 50
parent: Building data visualizations with Visualize
nav_order: 100
redirect_from:
- /dashboards/drag-drop-wizard/
---
Expand Down
4 changes: 2 additions & 2 deletions _dashboards/visualize/viz-index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Visualize
nav_order: 4
title: Building data visualizations with Visualize
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we drop 'with Visualize'?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Visualize is the application on the UI.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screen Shot 2023-02-03 at 10 03 26 AM

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hdhalter Changes made as suggested.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TOC updates
Screen Shot 2023-02-03 at 2 58 35 PM

nav_order: 40
has_children: true
---

Expand Down
10 changes: 0 additions & 10 deletions _dashboards/visualize/viz-types.md

This file was deleted.