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

Add Maps to Dashboard #2903

Merged
merged 15 commits into from
Feb 28, 2023
Original file line number Diff line number Diff line change
@@ -1,22 +1,35 @@
---
layout: default
title: Using the Maps plugin
nav_order: 60
title: Using maps
grand_parent: Building data visualizations
parent: Using coordinate and region maps
nav_order: 5
redirect_from:
- /dashboards/maps/
---

# Using the Maps plugin
# Using maps

With OpenSearch Dashboards, you can create maps to visualize your geographical data. OpenSearch lets you construct map visualizations with multiple layers, combining data across different indexes. You can build each layer from a different index pattern. Additionally, you can configure maps to show specific data at different zoom levels. OpenSearch maps are powered by the OpenSearch maps service, which uses vector tiles to render maps.

## Getting started
## Creating a new map

To get started, perform the following steps:
You can create a new map from the **Maps** or **Visualize** workflows by performing the following steps:
Copy link
Contributor

Choose a reason for hiding this comment

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

Feel free to disregard this. I'm looking at the great screenshots you added. Are the "workflows" actual UI elements? If they're not items you can actually see labeled or interact with, I'm not sure we need to make them bold face. But I'm not in the UI. So move on if this comment isn't valid.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, they are actually menu items in the top menu... I don't know whether there is a better word than "workflow" here. Let's ask @natebower


1. On the top menu bar, go to **OpenSearch Plugins > Maps**.
1. Select the **Create map** button. You can now see the default OpenSearch basemap.
1. To examine the **Default map** layer configuration, in the **Layers** panel on the upper left of the map, select **Default map**, as shown in the following image.
- To create a new map from the **Maps** workflow, perform the following steps:

1. On the top menu bar, go to **OpenSearch Plugins > Maps**.
1. Select the **Create map** button.

- To create a new map from the **Visualize** workflow, perform the following steps:

1. On the top menu bar, go to **OpenSearch Dashboards > Visualize**.
1. Select the **Create visualization** button.
1. In the **New Visualization** dialog, select **Maps**.

You can now see the default OpenSearch basemap.

To examine the **Default map** layer configuration, in the **Layers** panel on the upper left of the map, select **Default map**, as shown in the following image.
Copy link
Contributor

Choose a reason for hiding this comment

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

"... in the Layers panel, in the upper-left corner of the map, ..."
(suggestion only-feel free to disregard)


<img src="{{site.url}}{{site.baseurl}}/images/maps/maps-default.png" alt="Default map" width="900">

Expand Down Expand Up @@ -154,4 +167,45 @@ To save a map with all the layers that you set up, perform the following steps:
1. (Optional) In the **Description** text box, enter the map description.
1. Select the **Save** button.

To open your saved map, select **Maps** in the upper-left corner. The list of saved maps is displayed.
To open your saved map, select **Maps** in the upper-left corner. The list of saved maps is displayed.

## Adding a map to a dashboard

You can add a new or existing map to a new or existing dashboard by performing the following steps:

- To add a map to a new dashboard, first create the dashboard as follows:

1. On the top menu bar, go to **OpenSearch Dashboards > Dashboard**.
1. Select the **Create dashboard** button.
1. Select the **Create new** button.

- To add a map to an existing dashboard, first open the dashboard as follows:
1. On the top menu bar, go to **OpenSearch Dashboards > Dashboard**.
1. Select the dashboard you want to open from the list.
1. In the upper right corner, select **Edit**.
Copy link
Contributor

Choose a reason for hiding this comment

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

upper-right corner


Once you've opened a dashboard, you can add a new or existing map to it.

### Adding an existing map

1. From the top menu, select **Add**.
1. In the **Types** dropdown list, select **Maps**.
1. Select the map you want to add from the list.

### Adding a new map

1. From the top menu, select the **Create new** button.
1. In the **New Visualization** dialog, select **Maps**.
1. Add any default map, layers, and tooltips to the map.
1. In the upper right corner, select the **Save** button.
Copy link
Contributor

Choose a reason for hiding this comment

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

upper-right corner

1. In the **Save map** dialog, enter the **Title** and optional **Description** of the map.
1. Select **Add to Dashboard after saving**.
1. Select the **Save and return** button.

## Editing a map from a dashboard

1. In the dashboard, select the gear icon in the upper right corner of the map you want to edit.
Copy link
Contributor

Choose a reason for hiding this comment

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

upper-right corner

1. Select **Edit maps**.
1. Edit the map.
1. In the upper right corner, select the **Save** button.
Copy link
Contributor

Choose a reason for hiding this comment

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

upper-right corner

1. In the **Save map** dialog, select the **Save and return** button.