@splunk/visualizations 27.2.1 → 27.4.0

package/TRELLIS.md

@@ -1,6 +1,6 @@
 # Trellis layout
 
-> Trellis is only available for Area, Bar, Column, Line and Single value visualizations.
+> Trellis is only available for Area, Bar, Column, Line, Pie, Scatter and Single value visualizations.
 
 Organize your search results with the trellis layout for a holistic view of your data. Trellis layout visualizes your search results by separating each value field or aggregation.
 
@@ -18,7 +18,7 @@ Configure your visualization for the trellis layout by adding the `splitByLayout
 
 Customers with access to a Unified Dashboard Framework (UDF) **Edit** mode can create the trellis layout using the following steps. If you’re not using UDF, skip to step 4.
 
-1. Select a visualization that supports trellis (Area, Bar, Column, Line, Single value) using the visual editor by clicking the **Add Chart** dropdown menu in the editing toolbar.
+1. Select a visualization that supports trellis (Area, Bar, Column, Line, Pie, Scatter, Single value) using the visual editor by clicking the **Add Chart** dropdown menu in the editing toolbar.
 2. Select the visualization on your dashboard so that it's highlighted with the blue editing outline.
 3. Set up a new data source by adding selecting **+ Create Search** and adding a search to the **Search query** window. Or, select an existing data source under the **Search**, **Saved Search**, or **Chain Search** dropdown lists.
 4. Activate the trellis layout by toggling on **Trellis Layout** in the **Data display** section of the Configuration panel.
@@ -36,7 +36,7 @@ Additionally, you can add the following trellis configurations to the `options`
 | trellisMinColumnWidth  | number  | 100                             | Specify the minimum width, in pixels, of each visualization in the trellis container. If you resize the window or panel, you can view the remaining visualizations by scrolling.                                                                                                                                                   |
 | trellisPageCount       | number  | 20                              | Specify the maximum number of visualizations to display on a single page in the trellis container. The remaining visualizations paginate accordingly.                                                                                                                                                                              |
 | trellisRowHeight       | number  | 70                              | Specify each visualization's height, in pixels, in the trellis container. If you resize the window or panel, you can view the remaining visualizations by scrolling.                                                                                                                                                               |
-| trellisSharedScale     | boolean | true                            | If applicable, specify whether all visualizations will share the same scale in the trellis container. This only applies to Area, Bar, Column and Line chart.                                                                                                                                                                       |
+| trellisSharedScale     | boolean | true                            | If applicable, specify whether all visualizations will share the same scale in the trellis container. This only applies to Area, Bar, Column, Scatter and Line chart.                                                                                                                                                                       |
 | trellisSplitBy         | string  | n/a                             | If applicable, specify the column's field name with categories used or aggregations to split the data into individual visualizations for trellis display. If you use an SPL `timechart` command, this might default to the SPL `by` clause field. If you use an SPL `chart` command, this might default to the first string field. |
 ```
 
@@ -295,3 +295,12 @@ You can customize the number of visualizations to display in a single row of the
 The following example shows how visualizations might extend beyond the trellis panel with a `trellisMinColumnWidth: 150` and `trellisColumns: 6`.
 
 ![](./src/common/docs/images/trellis-col-3.png)
+
+## Event payload for trellis
+
+When the Trellis layout is enabled, the event payload object includes two additional key-value pairs, along with the existing payload:
+
+1. `trellis.name` - The value set for the `trellisSplitBy` option.
+2. `trellis.value` - The specific value used in the title of each Trellis child visualization.
+
+Examples can be found in the Events tab on the Trellis-supported visualizations page.

package/Table.js

@@ -1062,7 +1062,7 @@ var withFixedSizeContainer = (Viz) => {
       FixSizeItem,
       {
         "data-test": "fix-size-item",
-        "data-splunk-visualization-version": "27.2.1 - 41b7410be",
+        "data-splunk-visualization-version": "27.4.0 - 92ef39d5c",
         width,
         height,
         backgroundColor
@@ -1128,7 +1128,7 @@ var Cover = styled_components_default.div`
     bottom: 0;
 `;
 var Blocker = styled_components_default.div.attrs({
-  "data-splunk-visualization-version": "27.2.1 - 41b7410be"
+  "data-splunk-visualization-version": "27.4.0 - 92ef39d5c"
 })`
     position: relative;
     width: 100%;
@@ -1792,11 +1792,9 @@ var withDashboardViz = (opts) => {
       useAsyncEvaluatedOptions
     ]);
     const evaluatedOptionsToUse = !useAsyncEvaluatedOptions ? evaluatedOptions : evaluatedOptionsAsync;
-    let clonedEvaluatedOptions = evaluatedOptionsToUse;
+    const clonedEvaluatedOptions = __spreadValues({}, evaluatedOptionsToUse);
     if (isTrellisOn) {
-      clonedEvaluatedOptions = __spreadProps(__spreadValues({}, evaluatedOptionsToUse), {
-        backgroundColor: clonedEvaluatedOptions == null ? void 0 : clonedEvaluatedOptions.trellisBackgroundColor
-      });
+      clonedEvaluatedOptions.backgroundColor = clonedEvaluatedOptions == null ? void 0 : clonedEvaluatedOptions.trellisBackgroundColor;
     }
     react_exports.useEffect(() => {
       onComputedProps(clonedEvaluatedOptions);
@@ -1855,7 +1853,8 @@ var withDashboardViz = (opts) => {
     }));
     let dataSourceMetadata = {};
     const OptionKey = "paginateDataSourceKey";
-    const paginateDataSourceKey = (0, lodash_exports.has)(evaluatedOptionsToUse, OptionKey) && evaluatedOptionsToUse[OptionKey] || "primary";
+    const optsKey = (0, lodash_exports.has)(evaluatedOptionsToUse, OptionKey) && evaluatedOptionsToUse[OptionKey];
+    const paginateDataSourceKey = typeof optsKey === "string" ? optsKey : "primary";
     if (vizConfig.supports.indexOf("page-and-sort" /* PAGE_AND_SORT */) > -1 && (0, lodash_exports.has)(dataSources, paginateDataSourceKey)) {
       const requestParams = (0, lodash_exports.get)(dataSources, [paginateDataSourceKey, "requestParams"], {});
       const meta = (0, lodash_exports.get)(dataSources, [paginateDataSourceKey, "meta"], {});