Skip to content

Commit 1b9b70c

Browse files
committed
docs(readme):added section for scatterplot3d incl. screenshot
1 parent 07e8d86 commit 1b9b70c

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Visualizations included into this collection:
1111
* [OHLC Chart](#ohlc-chart) for Stocks and Financial Data :hammer_and_wrench: [source code](appserver/static/visualizations/ohlc/src/visualization_source.js)
1212
* [Box Plot Chart](#box-plot) for Statistical Data :hammer_and_wrench: [source code](appserver/static/visualizations/boxplot/src/visualization_source.js)
1313
* [Multiple Axes Chart](#multiple-axes-plot) for Advanced Statistical Data Visualizations :hammer_and_wrench: [source code](appserver/static/visualizations/multiple-axes/src/visualization_source.js)
14+
* [Scatterplot 3D](#scatterplot3d) for Multiple Dimensions / Clustering Data Visualizations :hammer_and_wrench: [source code](appserver/static/visualizations/scatterplot3d/src/visualization_source.js)
1415

1516
## Installation
1617
Please refer to the [Splunk Documentation](https://docs.splunk.com/Documentation/AddOns/released/Overview/Installingadd-ons) for guidance on installing the Add-On in your environment. The app needs to be installed on the SH tier.
@@ -62,6 +63,24 @@ Replace `_time`, `scatter-y2-datasetX` and `line-y-datasetX` with your fields to
6263
6364
![alt text](etc/MultipleAxes_plot.png "Multiple Axes Plot")
6465

66+
### Scatterplot 3D
67+
`<basesearch> | table trace x y z [marker_size]`
68+
69+
If not provided, default values will be used for optional field `marker_size`.
70+
71+
Replace `trace`, `x`, `y` and `z` with your fields to start.
72+
73+
| FieldName | Format | Description | Example |
74+
|-------------|---------|--------------------------|-----------|
75+
| `trace` | string | Label of the trace | `A` |
76+
| `x` | numeric | X-coordinate of data forming trace dataset | `20` |
77+
| `y` | numeric | Y-coordinate of data forming trace dataset | `2` |
78+
| `z` | numeric | Z-coordinate of data forming trace dataset | `100` |
79+
| `marker_size` | numeric | Size of the data marker in pixels. Range [1-50]. | `20` |
80+
81+
82+
![alt text](etc/scatterplot3d.png "Scatterplot 3D Chart Example")
83+
6584
## Example
6685
This app comes with a dashboard showcasing simple usages of mentioned charts.
6786

etc/scatterplot3d.png

131 KB
Loading

0 commit comments

Comments
 (0)