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

[Proposal] Improve and expand visualization type definitions for easier plugin use #2833

Open
10 tasks
joshuarrrr opened this issue Nov 8, 2022 · 0 comments
Open
10 tasks
Labels
unified visualization UX visualizations Issues and PRs related to visualizations

Comments

@joshuarrrr
Copy link
Member

There are many features where a plugin author might need to provide a pre-configured visualization in their application. For consistent look, feel, and interaction experience, we'd like to make it as easy as possible to embed one of the visualization types already defined in OpenSearch Dashboards. For example, if a security analytics plugin wanted to provide a histogram on the homepage of their app, they could simply get a react component from the visualization type:

import { ReactHistogram } from './vislib`

const histogramData = /* some data source */

...

return (
  <ReactHistogram data={data} />
);

We currently have a number of visualization types implemented, with fairly powerful configuration options. However, to use them effectively requires deep understanding of core dashboards concepts, because a developer needs to understand how to properly specify and format visualization configurations (not generally documented), and how to use the expressions plugin to properly format and pass data. They may also need understanding of how the visualizations plugin provides an embeddable, and how to integrate that properly into an app page.

Potential tasks:

  • Audit and improve default visualization configurations
  • Add high-level React components to existing VisLib types
    • Line chart
    • Area chart
    • Histogram
    • Horizontal bar chart
    • Heatmap
    • Pie chart
    • Gauge
    • Goal
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
unified visualization UX visualizations Issues and PRs related to visualizations
Projects
None yet
Development

No branches or pull requests

1 participant