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]: Update Wizard naming convention #1808

Merged
merged 10 commits into from
Nov 8, 2022
Merged
Show file tree
Hide file tree
Changes from 5 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
67 changes: 0 additions & 67 deletions _dashboards/drag-drop-wizard.md

This file was deleted.

59 changes: 59 additions & 0 deletions _dashboards/visbuilder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
layout: default
title: VisBuilder
nav_order: 8
---
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

# VisBuilder

VisBuilder is an experimental feature and shouldn't be used in a production environment. For updates on its progress, or if you want to leave feedback that helps improve the feature, see the [git issue](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/2280).
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
{: .warning}

You can use the VisBuilder visualization type in OpenSearch Dashboards to create data visualizations easily using a drag-and-drop gesture. With VisBuilder you have:
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

* an immediate view of your data without the need to preselect the visualization output
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
* the flexibility to change visualization types and index patterns quickly
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
* the ability to easily navigate between multiple screens
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/vis-builder-2.png" alt="VisBuilder new visualization start page">

## Try VisBuilder in the OpenSearch Dashboards playground

If you'd like to try out VisBuilder without installing OpenSearch locally, you can do so in the [Dashboards playground](https://playground.opensearch.org/app/vis-builder#/). VisBuilder is enabled by default.

## Try VisBuilder locally

The VisBuilder feature flag, `vis_builder.enabled:`, is enabled by default in the `opensearch_dashboards.yml` file.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

```
# Set the value of this setting to false to disable VisBuilder
# functionality in Visualization.
vis_builder.enabled: true
```
You can disable it using the flag`vis_builder.enabled: false`.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

Follow these steps to create a new visualization using VisBuilder in your environment:

1. Open Dashboards:
- If you're not running the security plugin, go to http://localhost:5601.
- If you're running the security plugin, go to https://localhost:5601 and log in with your username and password (default is admin/admin).

2. Confirm the **Enable experimental visualizations** option is turned on.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- From the top menu, select **Management** **>** **Stack Management** **>** **Advanced Settings**.
- Select **Visualization** and verify the option is turned on.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/enable-experimental-viz.png" alt="Enable experimental visualizations" width="550">

vagimeli marked this conversation as resolved.
Show resolved Hide resolved
3. From the top menu, select **Visualize** **>** **Create visualization** **>** **VisBuilder**.

vagimeli marked this conversation as resolved.
Show resolved Hide resolved
<img src="{{site.url}}{{site.baseurl}}/images/vis-builder-1.png" alt="Select the VisBuilder visualization type" width="350">

4. Drag and drop field names from the left column into the **Configuration** panel to generate a visualization.

Here’s an example visualization. Your visualization will look different depending on your data and the fields you select.

<img src="{{site.url}}{{site.baseurl}}/images/drag-drop-generated-viz.png" alt="Visualization generated using sample data">
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

## Related topics

* [OpenSearch News, September 14, 2022](https://opensearch.org/)
Binary file removed images/drag-and-drop-viz-select.png
Binary file not shown.
Binary file removed images/drag-drop-ui.png
Binary file not shown.
Binary file added images/vis-builder-1.png
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 images/vis-builder-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.