-
Notifications
You must be signed in to change notification settings - Fork 909
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
[Table Visualization] Replace table visualization with React and DataGrid #2863
Changes from all commits
bf2f4ef
73a636a
d891efc
10683d9
81a5c9f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,35 @@ | ||
Contains the data table visualization, that allows presenting data in a simple table format. | ||
# Data Table | ||
|
||
This is an OpenSearch Dashboards plugin that is used to visualize data and aggregations in tabular format. | ||
|
||
## Create Data Table | ||
To create a data table in OpenSearch Dashboards, first select `Visualize` from the navigation menu. Then click `Create Visualization` and choose `Data Table` as the visualization type. | ||
|
||
## Select Metrics | ||
|
||
### Metrics Aggregation | ||
At the `Metrics`, select the metric aggregation type from the menu and configure it accordingly. You could also add multiple metrics and each metrics is a separate column in table visualization. | ||
|
||
### Buckets Aggregation | ||
At the `Buckets`, configure the columns to be displayed in the table visualization. | ||
- `Split Rows` is used when you want to divide one row into more based on some category. It splits one row into multiple and add columns based on the categories you choose to split. For example, if you split the data based on gender then you want to know more on each gender's clothing preference. You could click `Split Rows` and input `clothing.category` in terms. Each gender's data is now split across to multiple rows based on a new added column `clothing.category`. | ||
- `Split Table` splits the table into separate tables for the aggregation you choose. It is similar to `Split Rows`, but this time each row becomes a single table with aggregation columns arranged horizontally or vertically. | ||
|
||
## Select Options | ||
In the `Options` tab, you can configure more options. | ||
- `Max rows per page` is the maximum number of rows displayed per page. | ||
- `Show metrics for every bucket/level` adds metrics aggregation to every column. | ||
- `Show partial rows` will include data with missing columns. | ||
- `Show total` calculates the selected metrics per column and displays the result at the bottom. Warning - depending on your columns and the total aggregation function selected, this may generate statistically invalid results. For example, avoid summing or averaging averages. | ||
- `Percentage column` adds one percentage column based on the chosen metrics aggregation. | ||
|
||
## Example | ||
ananzh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Below is an example of creating a table visualization using sample ecommerce data. | ||
|
||
- Create a new data table visualization and set a relative time 15 weeks ago. | ||
- Compute the count of ecommerce: Choose `Count` in Metrics Aggregation. | ||
- Split the rows on the top 5 of `manufacturer.keyword` ordered by `Metric:Count` in descending and add a label "manufacturer". | ||
- Split the table in rows on the top 5 of `geoip.city_name` ordered by `Metric:Count` in ascending order. | ||
- Click the `Save` button on the top left and save the visualization as "Top manufacturers by count per city". | ||
- Choose a table and click the download icon to download the table. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion:
isNumericalAggregationAllowed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah it is not looking good. but the original table is using this name here and so do percent, bytes and some other format files. I think I will just use this name for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also prefer tmarkley's suggestion, but agree that it's out of scope for this PR.