@splunk/visualization-schemas 27.0.0 → 27.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cjs/index.js CHANGED
@@ -321,7 +321,7 @@ var TOKEN_NAME_CHARS_PATTERN = /([^$|:]+?)(\|[|\w]+)?/.source;
321
321
  var TOKEN_PATTERN = /\$/.source + TOKEN_NAMESPACE_PREFIX_PATTERN + TOKEN_NAME_CHARS_PATTERN + /\$/.source;
322
322
  var rgbColorPattern = /^rgb\(\s*(\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)$/;
323
323
  var rgbaColorPattern = /^rgba\(\s*(\d{1,3}%?),\s*(\d{1,3}%?),\s*(\d{1,3}%?),\s*(\d*(?:\.\d+)?)\)$/;
324
- var colorPattern = "^#[0-9a-fA-F]{6}$|transparent";
324
+ var colorPattern = "^#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$|^transparent$";
325
325
  var colorPatternWithRGBA = `${colorPattern}|${rgbColorPattern.source}|${rgbaColorPattern.source}`;
326
326
  var COLOR_OR_TOKEN_PATTERN = `${colorPattern}|${TOKEN_PATTERN}`;
327
327
  var COLOR_OR_TOKEN_PATTERN_WITH_RGBA = `${colorPatternWithRGBA}|${TOKEN_PATTERN}`;
@@ -448,8 +448,7 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
448
448
  default: "off"
449
449
  },
450
450
  legendDisplay: {
451
- default: "right",
452
- description: "Specify the location of the legend on the panel. You must select the Standard legend mode to make this change.",
451
+ description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. You must select the Standard legend mode to make this change.",
453
452
  pattern: getPattern(["right", "left", "top", "bottom", "off"]),
454
453
  type: "string"
455
454
  },
@@ -470,6 +469,30 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
470
469
  pattern: getPattern(["ellipsisEnd", "ellipsisMiddle", "ellipsisStart", "ellipsisOff"]),
471
470
  type: "string"
472
471
  },
472
+ lineDashStyle: {
473
+ default: "solid",
474
+ description: "Specify a dash style for all overlay field lines.",
475
+ pattern: getPattern([
476
+ "solid",
477
+ "shortDash",
478
+ "shortDot",
479
+ "shortDashDot",
480
+ "shortDashDotDot",
481
+ "dot",
482
+ "dash",
483
+ "longDash",
484
+ "dashDot",
485
+ "longDashDot",
486
+ "longDashDotDot"
487
+ ]),
488
+ type: "string"
489
+ },
490
+ lineDashStylesByField: {
491
+ description: `Specify a dash style to use for overlay lines for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.
492
+ Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",
493
+ "longDash", "dashDot", "longDashDot", "longDashDotDot".`,
494
+ type: "object"
495
+ },
473
496
  lineWidth: {
474
497
  default: 2,
475
498
  description: "Specify the line width (px) for overlay field lines.",
@@ -496,6 +519,13 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
496
519
  description: `Specify the colors to use for specific fields in a series. For example, {\u201Ccount\u201D: \u201C#008000\u201D, \u201Cpercent\u201D: \u201C#FFA500\u201D}.`,
497
520
  type: "object"
498
521
  },
522
+ splitByLayout: {
523
+ default: "off",
524
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
525
+ type: "string",
526
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
527
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
528
+ },
499
529
  stackMode: {
500
530
  description: "Specify stack mode.",
501
531
  type: "string",
@@ -557,6 +587,45 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
557
587
  type: "boolean",
558
588
  default: false
559
589
  },
590
+ trellisBackgroundColor: {
591
+ default: "> themes.defaultBackgroundColor",
592
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
593
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
594
+ type: "string"
595
+ },
596
+ trellisColumns: {
597
+ description: "Specify the number of visualizations to display in a given row of the trellis container. The remaining visualizations will wrap accordingly. If nothing is specified, it will be auto-set based on the trellisMinColumnWidth. The minimum value is 1.",
598
+ type: "number",
599
+ minimum: 1,
600
+ default: 3
601
+ },
602
+ trellisMinColumnWidth: {
603
+ default: 250,
604
+ minimum: 1,
605
+ description: "Specify the minimum width, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1.",
606
+ type: "number"
607
+ },
608
+ trellisPageCount: {
609
+ default: 20,
610
+ minimum: 1,
611
+ description: "Specify the maximum number of visualizations to display in a single page in the trellis container. The remaining visualizations will paginate accordingly. The minimum value is 1.",
612
+ type: "number"
613
+ },
614
+ trellisRowHeight: {
615
+ default: 180,
616
+ minimum: 1,
617
+ description: "Specify the height, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1.",
618
+ type: "number"
619
+ },
620
+ trellisSharedScale: {
621
+ default: true,
622
+ type: "boolean",
623
+ description: "Specify whether all visualizations will share the same scale in the trellis container."
624
+ },
625
+ trellisSplitBy: {
626
+ description: "Specify the field name of the column with categories used, or \u201Caggregations\u201D, to split the data into individual visualizations for trellis display, if applicable. If a SPL `timechart` command is used, this may default to the SPL `by` clause field. If a SPL `chart` command is used, this may default to the first string field.",
627
+ type: "string"
628
+ },
560
629
  xAxisLabelRotation: {
561
630
  description: "Specify the rotation of the x-axis label in degrees.",
562
631
  enum: [-90, -45, 0, 45, 90],
@@ -832,8 +901,7 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
832
901
  type: "string"
833
902
  },
834
903
  legendDisplay: {
835
- default: "right",
836
- description: "Specify the location of the legend on the panel.",
904
+ description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. ",
837
905
  pattern: getPattern(["right", "left", "top", "bottom", "off"]),
838
906
  type: "string"
839
907
  },
@@ -854,6 +922,30 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
854
922
  pattern: getPattern(["ellipsisEnd", "ellipsisMiddle", "ellipsisStart", "ellipsisOff"]),
855
923
  type: "string"
856
924
  },
925
+ lineDashStyle: {
926
+ default: "solid",
927
+ description: "Specify a dash style for all overlay field lines.",
928
+ pattern: getPattern([
929
+ "solid",
930
+ "shortDash",
931
+ "shortDot",
932
+ "shortDashDot",
933
+ "shortDashDotDot",
934
+ "dot",
935
+ "dash",
936
+ "longDash",
937
+ "dashDot",
938
+ "longDashDot",
939
+ "longDashDotDot"
940
+ ]),
941
+ type: "string"
942
+ },
943
+ lineDashStylesByField: {
944
+ description: `Specify a dash style to use for overlay lines for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.
945
+ Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",
946
+ "longDash", "dashDot", "longDashDot", "longDashDotDot".`,
947
+ type: "object"
948
+ },
857
949
  lineWidth: {
858
950
  default: 2,
859
951
  description: "Specify the line width (px) for overlay field lines.",
@@ -878,6 +970,13 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
878
970
  description: "Specify the spacing (px) between clustered series in column and bar charts.",
879
971
  type: "number"
880
972
  },
973
+ splitByLayout: {
974
+ default: "off",
975
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
976
+ type: "string",
977
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
978
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
979
+ },
881
980
  stackMode: {
882
981
  default: "auto",
883
982
  description: "Specify stack mode.",
@@ -940,6 +1039,45 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
940
1039
  pattern: getPattern(["auto", "show", "hide"]),
941
1040
  type: "string"
942
1041
  },
1042
+ trellisBackgroundColor: {
1043
+ default: "> themes.defaultBackgroundColor",
1044
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
1045
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
1046
+ type: "string"
1047
+ },
1048
+ trellisColumns: {
1049
+ description: "Specify the number of visualizations to display in a given row of the trellis container. The remaining visualizations will wrap accordingly. If nothing is specified, it will be auto-set based on the trellisMinColumnWidth. The minimum value is 1.",
1050
+ type: "number",
1051
+ minimum: 1,
1052
+ default: 3
1053
+ },
1054
+ trellisMinColumnWidth: {
1055
+ default: 250,
1056
+ minimum: 1,
1057
+ description: "Specify the minimum width, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1.",
1058
+ type: "number"
1059
+ },
1060
+ trellisPageCount: {
1061
+ default: 20,
1062
+ minimum: 1,
1063
+ description: "Specify the maximum number of visualizations to display in a single page in the trellis container. The remaining visualizations will paginate accordingly. The minimum value is 1.",
1064
+ type: "number"
1065
+ },
1066
+ trellisRowHeight: {
1067
+ default: 180,
1068
+ minimum: 1,
1069
+ description: "Specify the height, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1.",
1070
+ type: "number"
1071
+ },
1072
+ trellisSharedScale: {
1073
+ default: true,
1074
+ type: "boolean",
1075
+ description: "Specify whether all visualizations will share the same scale in the trellis container."
1076
+ },
1077
+ trellisSplitBy: {
1078
+ description: "Specify the field name of the column with categories used, or \u201Caggregations\u201D, to split the data into individual visualizations for trellis display, if applicable. If a SPL `timechart` command is used, this may default to the SPL `by` clause field. If a SPL `chart` command is used, this may default to the first string field.",
1079
+ type: "string"
1080
+ },
943
1081
  yAxisLabelVisibility: {
944
1082
  default: "auto",
945
1083
  description: "Specify whether to show labels on the y-axis.",
@@ -1533,12 +1671,6 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1533
1671
  pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
1534
1672
  type: "string"
1535
1673
  },
1536
- dataValuesDisplay: {
1537
- description: 'Specify the labels to display. Enter "all" to show labels for all data points, "off" to show no labels, or "minmax" to show high and low values.',
1538
- type: "string",
1539
- pattern: getPattern(["off", "all", "minmax"]),
1540
- default: "off"
1541
- },
1542
1674
  columnGrouping: {
1543
1675
  default: "auto",
1544
1676
  description: "Specify a column grouping mode. If chart.stackMode is defined, it overrides grouping mode settings.",
@@ -1549,11 +1681,16 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1549
1681
  description: "Specifies the spacing (px) between columns in a column chart.",
1550
1682
  type: "number"
1551
1683
  },
1684
+ dataValuesDisplay: {
1685
+ description: 'Specify the labels to display. Enter "all" to show labels for all data points, "off" to show no labels, or "minmax" to show high and low values.',
1686
+ type: "string",
1687
+ pattern: getPattern(["off", "all", "minmax"]),
1688
+ default: "off"
1689
+ },
1552
1690
  legendDisplay: {
1553
- description: "Specify the location of the legend on the panel.",
1691
+ description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. ",
1554
1692
  pattern: getPattern(["right", "left", "top", "bottom", "off"]),
1555
- type: "string",
1556
- default: "right"
1693
+ type: "string"
1557
1694
  },
1558
1695
  legendLabels: {
1559
1696
  description: `Specify a list of labels to populate the legend in advance. For example, ["percent", "count"].`,
@@ -1572,6 +1709,30 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1572
1709
  type: "string",
1573
1710
  default: "ellipsisEnd"
1574
1711
  },
1712
+ lineDashStyle: {
1713
+ default: "solid",
1714
+ description: "Specify a dash style for all overlay field lines.",
1715
+ pattern: getPattern([
1716
+ "solid",
1717
+ "shortDash",
1718
+ "shortDot",
1719
+ "shortDashDot",
1720
+ "shortDashDotDot",
1721
+ "dot",
1722
+ "dash",
1723
+ "longDash",
1724
+ "dashDot",
1725
+ "longDashDot",
1726
+ "longDashDotDot"
1727
+ ]),
1728
+ type: "string"
1729
+ },
1730
+ lineDashStylesByField: {
1731
+ description: `Specify a dash style to use for overlay lines for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.
1732
+ Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",
1733
+ "longDash", "dashDot", "longDashDot", "longDashDotDot".`,
1734
+ type: "object"
1735
+ },
1575
1736
  lineWidth: {
1576
1737
  default: 2,
1577
1738
  description: "Specify the line width (px) for overlay field lines.",
@@ -1596,6 +1757,13 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1596
1757
  description: "Specify the spacing (px) between clustered series in column and bar charts.",
1597
1758
  type: "number"
1598
1759
  },
1760
+ splitByLayout: {
1761
+ default: "off",
1762
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
1763
+ type: "string",
1764
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
1765
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
1766
+ },
1599
1767
  stackMode: {
1600
1768
  description: "Specify stack mode.",
1601
1769
  type: "string",
@@ -1657,6 +1825,45 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1657
1825
  type: "boolean",
1658
1826
  default: false
1659
1827
  },
1828
+ trellisBackgroundColor: {
1829
+ default: "> themes.defaultBackgroundColor",
1830
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
1831
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
1832
+ type: "string"
1833
+ },
1834
+ trellisColumns: {
1835
+ description: "Specify the number of visualizations to display in a given row of the trellis container. The remaining visualizations will wrap accordingly. If nothing is specified, it will be auto-set based on the trellisMinColumnWidth. The minimum value is 1.",
1836
+ type: "number",
1837
+ minimum: 1,
1838
+ default: 3
1839
+ },
1840
+ trellisMinColumnWidth: {
1841
+ default: 250,
1842
+ minimum: 1,
1843
+ description: "Specify the minimum width, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1.",
1844
+ type: "number"
1845
+ },
1846
+ trellisPageCount: {
1847
+ default: 20,
1848
+ minimum: 1,
1849
+ description: "Specify the maximum number of visualizations to display in a single page in the trellis container. The remaining visualizations will paginate accordingly. The minimum value is 1.",
1850
+ type: "number"
1851
+ },
1852
+ trellisRowHeight: {
1853
+ default: 180,
1854
+ minimum: 1,
1855
+ description: "Specify the height, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1.",
1856
+ type: "number"
1857
+ },
1858
+ trellisSharedScale: {
1859
+ default: true,
1860
+ type: "boolean",
1861
+ description: "Specify whether all visualizations will share the same scale in the trellis container."
1862
+ },
1863
+ trellisSplitBy: {
1864
+ description: "Specify the field name of the column with categories used, or \u201Caggregations\u201D, to split the data into individual visualizations for trellis display, if applicable. If a SPL `timechart` command is used, this may default to the SPL `by` clause field. If a SPL `chart` command is used, this may default to the first string field.",
1865
+ type: "string"
1866
+ },
1660
1867
  xAxisLabelRotation: {
1661
1868
  description: "Specify the rotation of the x-axis label in degrees.",
1662
1869
  enum: [-90, -45, 0, 45, 90],
@@ -2133,8 +2340,7 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2133
2340
  type: "string"
2134
2341
  },
2135
2342
  legendDisplay: {
2136
- default: "right",
2137
- description: "Specify the location of the legend on the panel. You must select the Standard legend mode to make this change.",
2343
+ description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. You must select the Standard legend mode to make this change.",
2138
2344
  pattern: getPattern(["right", "left", "top", "bottom", "off"]),
2139
2345
  type: "string"
2140
2346
  },
@@ -2267,6 +2473,52 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2267
2473
  description: "Specify whether the y2-axis range includes zero.",
2268
2474
  type: "boolean"
2269
2475
  },
2476
+ splitByLayout: {
2477
+ default: "off",
2478
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
2479
+ type: "string",
2480
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
2481
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
2482
+ },
2483
+ trellisBackgroundColor: {
2484
+ default: "> themes.defaultBackgroundColor",
2485
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
2486
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
2487
+ type: "string"
2488
+ },
2489
+ trellisColumns: {
2490
+ description: "Specify the number of visualizations to display in a given row of the trellis container. The remaining visualizations will wrap accordingly. If nothing is specified, it will be auto-set based on the trellisMinColumnWidth. The minimum value is 1.",
2491
+ type: "number",
2492
+ minimum: 1,
2493
+ default: 3
2494
+ },
2495
+ trellisMinColumnWidth: {
2496
+ default: 250,
2497
+ minimum: 1,
2498
+ description: "Specify the minimum width, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1.",
2499
+ type: "number"
2500
+ },
2501
+ trellisPageCount: {
2502
+ default: 20,
2503
+ minimum: 1,
2504
+ description: "Specify the maximum number of visualizations to display in a single page in the trellis container. The remaining visualizations will paginate accordingly. The minimum value is 1.",
2505
+ type: "number"
2506
+ },
2507
+ trellisRowHeight: {
2508
+ default: 180,
2509
+ minimum: 1,
2510
+ description: "Specify the height, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1.",
2511
+ type: "number"
2512
+ },
2513
+ trellisSharedScale: {
2514
+ default: true,
2515
+ type: "boolean",
2516
+ description: "Specify whether all visualizations will share the same scale in the trellis container."
2517
+ },
2518
+ trellisSplitBy: {
2519
+ description: "Specify the field name of the column with categories used, or \u201Caggregations\u201D, to split the data into individual visualizations for trellis display, if applicable. If a SPL `timechart` command is used, this may default to the SPL `by` clause field. If a SPL `chart` command is used, this may default to the first string field.",
2520
+ type: "string"
2521
+ },
2270
2522
  xAxisLabelRotation: {
2271
2523
  default: 0,
2272
2524
  description: "Specify the rotation of the x-axis label in degrees.",
@@ -4038,7 +4290,7 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4038
4290
  minimum: 1
4039
4291
  },
4040
4292
  trellisMinColumnWidth: {
4041
- default: 100,
4293
+ default: 120,
4042
4294
  minimum: 1,
4043
4295
  description: "Specify the minimum width, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1.",
4044
4296
  type: "number"
@@ -4050,7 +4302,7 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4050
4302
  type: "number"
4051
4303
  },
4052
4304
  trellisRowHeight: {
4053
- default: 70,
4305
+ default: 100,
4054
4306
  minimum: 1,
4055
4307
  description: "Specify the height, in pixels, of each visualization in the trellis container. If the window or panel is resized, the remaining visualizations may be viewed by scrolling. The minimum value is 1.",
4056
4308
  type: "number"