@splunk/visualization-schemas 27.0.0 → 27.2.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 +407 -26
- package/dist/cjs/index.js.map +3 -3
- package/dist/esm/index.js +407 -26
- package/dist/esm/index.js.map +3 -3
- package/package.json +6 -5
package/dist/esm/index.js
CHANGED
|
@@ -258,7 +258,7 @@ var TOKEN_NAME_CHARS_PATTERN = /([^$|:]+?)(\|[|\w]+)?/.source;
|
|
|
258
258
|
var TOKEN_PATTERN = /\$/.source + TOKEN_NAMESPACE_PREFIX_PATTERN + TOKEN_NAME_CHARS_PATTERN + /\$/.source;
|
|
259
259
|
var rgbColorPattern = /^rgb\(\s*(\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)$/;
|
|
260
260
|
var rgbaColorPattern = /^rgba\(\s*(\d{1,3}%?),\s*(\d{1,3}%?),\s*(\d{1,3}%?),\s*(\d*(?:\.\d+)?)\)$/;
|
|
261
|
-
var colorPattern = "^#[0-9a-fA-F]{6}
|
|
261
|
+
var colorPattern = "^#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$|^transparent$";
|
|
262
262
|
var colorPatternWithRGBA = `${colorPattern}|${rgbColorPattern.source}|${rgbaColorPattern.source}`;
|
|
263
263
|
var COLOR_OR_TOKEN_PATTERN = `${colorPattern}|${TOKEN_PATTERN}`;
|
|
264
264
|
var COLOR_OR_TOKEN_PATTERN_WITH_RGBA = `${colorPatternWithRGBA}|${TOKEN_PATTERN}`;
|
|
@@ -385,8 +385,7 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
385
385
|
default: "off"
|
|
386
386
|
},
|
|
387
387
|
legendDisplay: {
|
|
388
|
-
|
|
389
|
-
description: "Specify the location of the legend on the panel. You must select the Standard legend mode to make this change.",
|
|
388
|
+
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.",
|
|
390
389
|
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
391
390
|
type: "string"
|
|
392
391
|
},
|
|
@@ -407,6 +406,30 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
407
406
|
pattern: getPattern(["ellipsisEnd", "ellipsisMiddle", "ellipsisStart", "ellipsisOff"]),
|
|
408
407
|
type: "string"
|
|
409
408
|
},
|
|
409
|
+
lineDashStyle: {
|
|
410
|
+
default: "solid",
|
|
411
|
+
description: "Specify a dash style for all overlay field lines.",
|
|
412
|
+
pattern: getPattern([
|
|
413
|
+
"solid",
|
|
414
|
+
"shortDash",
|
|
415
|
+
"shortDot",
|
|
416
|
+
"shortDashDot",
|
|
417
|
+
"shortDashDotDot",
|
|
418
|
+
"dot",
|
|
419
|
+
"dash",
|
|
420
|
+
"longDash",
|
|
421
|
+
"dashDot",
|
|
422
|
+
"longDashDot",
|
|
423
|
+
"longDashDotDot"
|
|
424
|
+
]),
|
|
425
|
+
type: "string"
|
|
426
|
+
},
|
|
427
|
+
lineDashStylesByField: {
|
|
428
|
+
description: `Specify a dash style to use for overlay lines for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.
|
|
429
|
+
Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",
|
|
430
|
+
"longDash", "dashDot", "longDashDot", "longDashDotDot".`,
|
|
431
|
+
type: "object"
|
|
432
|
+
},
|
|
410
433
|
lineWidth: {
|
|
411
434
|
default: 2,
|
|
412
435
|
description: "Specify the line width (px) for overlay field lines.",
|
|
@@ -433,6 +456,13 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
433
456
|
description: `Specify the colors to use for specific fields in a series. For example, {\u201Ccount\u201D: \u201C#008000\u201D, \u201Cpercent\u201D: \u201C#FFA500\u201D}.`,
|
|
434
457
|
type: "object"
|
|
435
458
|
},
|
|
459
|
+
splitByLayout: {
|
|
460
|
+
default: "off",
|
|
461
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
462
|
+
type: "string",
|
|
463
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
464
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
465
|
+
},
|
|
436
466
|
stackMode: {
|
|
437
467
|
description: "Specify stack mode.",
|
|
438
468
|
type: "string",
|
|
@@ -494,6 +524,45 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
494
524
|
type: "boolean",
|
|
495
525
|
default: false
|
|
496
526
|
},
|
|
527
|
+
trellisBackgroundColor: {
|
|
528
|
+
default: "> themes.defaultBackgroundColor",
|
|
529
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
530
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
531
|
+
type: "string"
|
|
532
|
+
},
|
|
533
|
+
trellisColumns: {
|
|
534
|
+
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.",
|
|
535
|
+
type: "number",
|
|
536
|
+
minimum: 1,
|
|
537
|
+
default: 3
|
|
538
|
+
},
|
|
539
|
+
trellisMinColumnWidth: {
|
|
540
|
+
default: 250,
|
|
541
|
+
minimum: 1,
|
|
542
|
+
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.",
|
|
543
|
+
type: "number"
|
|
544
|
+
},
|
|
545
|
+
trellisPageCount: {
|
|
546
|
+
default: 20,
|
|
547
|
+
minimum: 1,
|
|
548
|
+
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.",
|
|
549
|
+
type: "number"
|
|
550
|
+
},
|
|
551
|
+
trellisRowHeight: {
|
|
552
|
+
default: 180,
|
|
553
|
+
minimum: 1,
|
|
554
|
+
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.",
|
|
555
|
+
type: "number"
|
|
556
|
+
},
|
|
557
|
+
trellisSharedScale: {
|
|
558
|
+
default: true,
|
|
559
|
+
type: "boolean",
|
|
560
|
+
description: "Specify whether all visualizations will share the same scale in the trellis container."
|
|
561
|
+
},
|
|
562
|
+
trellisSplitBy: {
|
|
563
|
+
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.",
|
|
564
|
+
type: "string"
|
|
565
|
+
},
|
|
497
566
|
xAxisLabelRotation: {
|
|
498
567
|
description: "Specify the rotation of the x-axis label in degrees.",
|
|
499
568
|
enum: [-90, -45, 0, 45, 90],
|
|
@@ -769,8 +838,7 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
769
838
|
type: "string"
|
|
770
839
|
},
|
|
771
840
|
legendDisplay: {
|
|
772
|
-
|
|
773
|
-
description: "Specify the location of the legend on the panel.",
|
|
841
|
+
description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. ",
|
|
774
842
|
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
775
843
|
type: "string"
|
|
776
844
|
},
|
|
@@ -791,6 +859,30 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
791
859
|
pattern: getPattern(["ellipsisEnd", "ellipsisMiddle", "ellipsisStart", "ellipsisOff"]),
|
|
792
860
|
type: "string"
|
|
793
861
|
},
|
|
862
|
+
lineDashStyle: {
|
|
863
|
+
default: "solid",
|
|
864
|
+
description: "Specify a dash style for all overlay field lines.",
|
|
865
|
+
pattern: getPattern([
|
|
866
|
+
"solid",
|
|
867
|
+
"shortDash",
|
|
868
|
+
"shortDot",
|
|
869
|
+
"shortDashDot",
|
|
870
|
+
"shortDashDotDot",
|
|
871
|
+
"dot",
|
|
872
|
+
"dash",
|
|
873
|
+
"longDash",
|
|
874
|
+
"dashDot",
|
|
875
|
+
"longDashDot",
|
|
876
|
+
"longDashDotDot"
|
|
877
|
+
]),
|
|
878
|
+
type: "string"
|
|
879
|
+
},
|
|
880
|
+
lineDashStylesByField: {
|
|
881
|
+
description: `Specify a dash style to use for overlay lines for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.
|
|
882
|
+
Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",
|
|
883
|
+
"longDash", "dashDot", "longDashDot", "longDashDotDot".`,
|
|
884
|
+
type: "object"
|
|
885
|
+
},
|
|
794
886
|
lineWidth: {
|
|
795
887
|
default: 2,
|
|
796
888
|
description: "Specify the line width (px) for overlay field lines.",
|
|
@@ -815,6 +907,13 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
815
907
|
description: "Specify the spacing (px) between clustered series in column and bar charts.",
|
|
816
908
|
type: "number"
|
|
817
909
|
},
|
|
910
|
+
splitByLayout: {
|
|
911
|
+
default: "off",
|
|
912
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
913
|
+
type: "string",
|
|
914
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
915
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
916
|
+
},
|
|
818
917
|
stackMode: {
|
|
819
918
|
default: "auto",
|
|
820
919
|
description: "Specify stack mode.",
|
|
@@ -877,6 +976,45 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
877
976
|
pattern: getPattern(["auto", "show", "hide"]),
|
|
878
977
|
type: "string"
|
|
879
978
|
},
|
|
979
|
+
trellisBackgroundColor: {
|
|
980
|
+
default: "> themes.defaultBackgroundColor",
|
|
981
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
982
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
983
|
+
type: "string"
|
|
984
|
+
},
|
|
985
|
+
trellisColumns: {
|
|
986
|
+
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.",
|
|
987
|
+
type: "number",
|
|
988
|
+
minimum: 1,
|
|
989
|
+
default: 3
|
|
990
|
+
},
|
|
991
|
+
trellisMinColumnWidth: {
|
|
992
|
+
default: 250,
|
|
993
|
+
minimum: 1,
|
|
994
|
+
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.",
|
|
995
|
+
type: "number"
|
|
996
|
+
},
|
|
997
|
+
trellisPageCount: {
|
|
998
|
+
default: 20,
|
|
999
|
+
minimum: 1,
|
|
1000
|
+
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.",
|
|
1001
|
+
type: "number"
|
|
1002
|
+
},
|
|
1003
|
+
trellisRowHeight: {
|
|
1004
|
+
default: 180,
|
|
1005
|
+
minimum: 1,
|
|
1006
|
+
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.",
|
|
1007
|
+
type: "number"
|
|
1008
|
+
},
|
|
1009
|
+
trellisSharedScale: {
|
|
1010
|
+
default: true,
|
|
1011
|
+
type: "boolean",
|
|
1012
|
+
description: "Specify whether all visualizations will share the same scale in the trellis container."
|
|
1013
|
+
},
|
|
1014
|
+
trellisSplitBy: {
|
|
1015
|
+
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.",
|
|
1016
|
+
type: "string"
|
|
1017
|
+
},
|
|
880
1018
|
yAxisLabelVisibility: {
|
|
881
1019
|
default: "auto",
|
|
882
1020
|
description: "Specify whether to show labels on the y-axis.",
|
|
@@ -1470,12 +1608,6 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1470
1608
|
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
1471
1609
|
type: "string"
|
|
1472
1610
|
},
|
|
1473
|
-
dataValuesDisplay: {
|
|
1474
|
-
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.',
|
|
1475
|
-
type: "string",
|
|
1476
|
-
pattern: getPattern(["off", "all", "minmax"]),
|
|
1477
|
-
default: "off"
|
|
1478
|
-
},
|
|
1479
1611
|
columnGrouping: {
|
|
1480
1612
|
default: "auto",
|
|
1481
1613
|
description: "Specify a column grouping mode. If chart.stackMode is defined, it overrides grouping mode settings.",
|
|
@@ -1486,11 +1618,16 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1486
1618
|
description: "Specifies the spacing (px) between columns in a column chart.",
|
|
1487
1619
|
type: "number"
|
|
1488
1620
|
},
|
|
1621
|
+
dataValuesDisplay: {
|
|
1622
|
+
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.',
|
|
1623
|
+
type: "string",
|
|
1624
|
+
pattern: getPattern(["off", "all", "minmax"]),
|
|
1625
|
+
default: "off"
|
|
1626
|
+
},
|
|
1489
1627
|
legendDisplay: {
|
|
1490
|
-
description: "Specify the location of the legend on the panel.",
|
|
1628
|
+
description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. ",
|
|
1491
1629
|
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
1492
|
-
type: "string"
|
|
1493
|
-
default: "right"
|
|
1630
|
+
type: "string"
|
|
1494
1631
|
},
|
|
1495
1632
|
legendLabels: {
|
|
1496
1633
|
description: `Specify a list of labels to populate the legend in advance. For example, ["percent", "count"].`,
|
|
@@ -1509,6 +1646,30 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1509
1646
|
type: "string",
|
|
1510
1647
|
default: "ellipsisEnd"
|
|
1511
1648
|
},
|
|
1649
|
+
lineDashStyle: {
|
|
1650
|
+
default: "solid",
|
|
1651
|
+
description: "Specify a dash style for all overlay field lines.",
|
|
1652
|
+
pattern: getPattern([
|
|
1653
|
+
"solid",
|
|
1654
|
+
"shortDash",
|
|
1655
|
+
"shortDot",
|
|
1656
|
+
"shortDashDot",
|
|
1657
|
+
"shortDashDotDot",
|
|
1658
|
+
"dot",
|
|
1659
|
+
"dash",
|
|
1660
|
+
"longDash",
|
|
1661
|
+
"dashDot",
|
|
1662
|
+
"longDashDot",
|
|
1663
|
+
"longDashDotDot"
|
|
1664
|
+
]),
|
|
1665
|
+
type: "string"
|
|
1666
|
+
},
|
|
1667
|
+
lineDashStylesByField: {
|
|
1668
|
+
description: `Specify a dash style to use for overlay lines for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.
|
|
1669
|
+
Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",
|
|
1670
|
+
"longDash", "dashDot", "longDashDot", "longDashDotDot".`,
|
|
1671
|
+
type: "object"
|
|
1672
|
+
},
|
|
1512
1673
|
lineWidth: {
|
|
1513
1674
|
default: 2,
|
|
1514
1675
|
description: "Specify the line width (px) for overlay field lines.",
|
|
@@ -1533,6 +1694,13 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1533
1694
|
description: "Specify the spacing (px) between clustered series in column and bar charts.",
|
|
1534
1695
|
type: "number"
|
|
1535
1696
|
},
|
|
1697
|
+
splitByLayout: {
|
|
1698
|
+
default: "off",
|
|
1699
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
1700
|
+
type: "string",
|
|
1701
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
1702
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
1703
|
+
},
|
|
1536
1704
|
stackMode: {
|
|
1537
1705
|
description: "Specify stack mode.",
|
|
1538
1706
|
type: "string",
|
|
@@ -1594,6 +1762,45 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1594
1762
|
type: "boolean",
|
|
1595
1763
|
default: false
|
|
1596
1764
|
},
|
|
1765
|
+
trellisBackgroundColor: {
|
|
1766
|
+
default: "> themes.defaultBackgroundColor",
|
|
1767
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
1768
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
1769
|
+
type: "string"
|
|
1770
|
+
},
|
|
1771
|
+
trellisColumns: {
|
|
1772
|
+
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.",
|
|
1773
|
+
type: "number",
|
|
1774
|
+
minimum: 1,
|
|
1775
|
+
default: 3
|
|
1776
|
+
},
|
|
1777
|
+
trellisMinColumnWidth: {
|
|
1778
|
+
default: 250,
|
|
1779
|
+
minimum: 1,
|
|
1780
|
+
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.",
|
|
1781
|
+
type: "number"
|
|
1782
|
+
},
|
|
1783
|
+
trellisPageCount: {
|
|
1784
|
+
default: 20,
|
|
1785
|
+
minimum: 1,
|
|
1786
|
+
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.",
|
|
1787
|
+
type: "number"
|
|
1788
|
+
},
|
|
1789
|
+
trellisRowHeight: {
|
|
1790
|
+
default: 180,
|
|
1791
|
+
minimum: 1,
|
|
1792
|
+
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.",
|
|
1793
|
+
type: "number"
|
|
1794
|
+
},
|
|
1795
|
+
trellisSharedScale: {
|
|
1796
|
+
default: true,
|
|
1797
|
+
type: "boolean",
|
|
1798
|
+
description: "Specify whether all visualizations will share the same scale in the trellis container."
|
|
1799
|
+
},
|
|
1800
|
+
trellisSplitBy: {
|
|
1801
|
+
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.",
|
|
1802
|
+
type: "string"
|
|
1803
|
+
},
|
|
1597
1804
|
xAxisLabelRotation: {
|
|
1598
1805
|
description: "Specify the rotation of the x-axis label in degrees.",
|
|
1599
1806
|
enum: [-90, -45, 0, 45, 90],
|
|
@@ -2070,8 +2277,7 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2070
2277
|
type: "string"
|
|
2071
2278
|
},
|
|
2072
2279
|
legendDisplay: {
|
|
2073
|
-
|
|
2074
|
-
description: "Specify the location of the legend on the panel. You must select the Standard legend mode to make this change.",
|
|
2280
|
+
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.",
|
|
2075
2281
|
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
2076
2282
|
type: "string"
|
|
2077
2283
|
},
|
|
@@ -2204,6 +2410,52 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2204
2410
|
description: "Specify whether the y2-axis range includes zero.",
|
|
2205
2411
|
type: "boolean"
|
|
2206
2412
|
},
|
|
2413
|
+
splitByLayout: {
|
|
2414
|
+
default: "off",
|
|
2415
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
2416
|
+
type: "string",
|
|
2417
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
2418
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
2419
|
+
},
|
|
2420
|
+
trellisBackgroundColor: {
|
|
2421
|
+
default: "> themes.defaultBackgroundColor",
|
|
2422
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
2423
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
2424
|
+
type: "string"
|
|
2425
|
+
},
|
|
2426
|
+
trellisColumns: {
|
|
2427
|
+
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.",
|
|
2428
|
+
type: "number",
|
|
2429
|
+
minimum: 1,
|
|
2430
|
+
default: 3
|
|
2431
|
+
},
|
|
2432
|
+
trellisMinColumnWidth: {
|
|
2433
|
+
default: 250,
|
|
2434
|
+
minimum: 1,
|
|
2435
|
+
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.",
|
|
2436
|
+
type: "number"
|
|
2437
|
+
},
|
|
2438
|
+
trellisPageCount: {
|
|
2439
|
+
default: 20,
|
|
2440
|
+
minimum: 1,
|
|
2441
|
+
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.",
|
|
2442
|
+
type: "number"
|
|
2443
|
+
},
|
|
2444
|
+
trellisRowHeight: {
|
|
2445
|
+
default: 180,
|
|
2446
|
+
minimum: 1,
|
|
2447
|
+
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.",
|
|
2448
|
+
type: "number"
|
|
2449
|
+
},
|
|
2450
|
+
trellisSharedScale: {
|
|
2451
|
+
default: true,
|
|
2452
|
+
type: "boolean",
|
|
2453
|
+
description: "Specify whether all visualizations will share the same scale in the trellis container."
|
|
2454
|
+
},
|
|
2455
|
+
trellisSplitBy: {
|
|
2456
|
+
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.",
|
|
2457
|
+
type: "string"
|
|
2458
|
+
},
|
|
2207
2459
|
xAxisLabelRotation: {
|
|
2208
2460
|
default: 0,
|
|
2209
2461
|
description: "Specify the rotation of the x-axis label in degrees.",
|
|
@@ -2552,6 +2804,9 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2552
2804
|
latitude: '> primary | seriesByName("latitude")',
|
|
2553
2805
|
longitude: '> primary | seriesByName("longitude")',
|
|
2554
2806
|
seriesColors: visualization_color_palettes_exports.VIZ_CATEGORICAL,
|
|
2807
|
+
dataValues: '> primary | seriesByType("number")',
|
|
2808
|
+
dataColors: "",
|
|
2809
|
+
// default to an empty string to prioritize seriesColors
|
|
2555
2810
|
bubbleSize: '> primary | frameWithoutSeriesNames("geobin", "latitude", "longitude") | frameBySeriesTypes("number")',
|
|
2556
2811
|
additionalTooltipFields: [],
|
|
2557
2812
|
resultLimit: 1e3
|
|
@@ -2561,6 +2816,9 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2561
2816
|
latitude: '> primary | seriesByName("latitude")',
|
|
2562
2817
|
longitude: '> primary | seriesByName("longitude")',
|
|
2563
2818
|
seriesColors: visualization_color_palettes_exports.VIZ_CATEGORICAL,
|
|
2819
|
+
dataValues: '> primary | seriesByType("number")',
|
|
2820
|
+
dataColors: "",
|
|
2821
|
+
// default to an empty string to prioritize seriesColors
|
|
2564
2822
|
additionalTooltipFields: [],
|
|
2565
2823
|
resultLimit: 1e3
|
|
2566
2824
|
},
|
|
@@ -2612,9 +2870,16 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2612
2870
|
default: visualization_color_palettes_exports.VIZ_CATEGORICAL
|
|
2613
2871
|
},
|
|
2614
2872
|
dataColors: {
|
|
2615
|
-
description: 'Specify the colors to use for data points. You can use an array of colors to be picked from, or you can use a dataSource to apply dynamic coloring. For example, \u201C> primary | seriesByName("status") | matchValue(colorMatchConfig)\u201D. When type: "choropleth", dataColors is defined by default, and the opacities are shown at 80% of maximum to allow textual information to be visible in the map. By default, the dataColors option is
|
|
2873
|
+
description: 'Specify the colors to use for data points. You can use an array of colors to be picked from, or you can use a dataSource to apply dynamic coloring. For example, \u201C> primary | seriesByName("status") | matchValue(colorMatchConfig)\u201D. When type: "choropleth", dataColors is defined by default, and the opacities are shown at 80% of maximum to allow textual information to be visible in the map. By default, the dataColors option is empty for "bubble" or "marker" layers to prioritize seriesColors. For "bubble" layers, dataColors requires bubbleSize to have a single series configured. If multiple series are set for bubbleSize, only the first pie slice reflects the colors.',
|
|
2616
2874
|
type: ["string", "array"],
|
|
2617
|
-
items: { type: "string" }
|
|
2875
|
+
items: { type: "string" },
|
|
2876
|
+
default: ""
|
|
2877
|
+
},
|
|
2878
|
+
dataValues: {
|
|
2879
|
+
description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
|
|
2880
|
+
type: ["string"],
|
|
2881
|
+
items: { type: "number" },
|
|
2882
|
+
default: '> primary | seriesByType("number")'
|
|
2618
2883
|
},
|
|
2619
2884
|
additionalTooltipFields: {
|
|
2620
2885
|
description: "Specify the fields to add to the default set of tooltips. Tooltips appear when you hover over data points. These fields and their corresponding values are shown in addition to the ones displayed by default.",
|
|
@@ -2709,7 +2974,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2709
2974
|
default: "bubble" /* Bubble */
|
|
2710
2975
|
},
|
|
2711
2976
|
bubbleSize: {
|
|
2712
|
-
description: 'Specify the data column to encode bubble size. This applies to layers where type: "bubble".',
|
|
2977
|
+
description: 'Specify the data column to encode bubble size. This applies to layers where type: "bubble". If a single data column is specified, each bubble appears as a circle. When multiple columns are provided, bubbles are displayed as pie charts, with each slice representing a different column.',
|
|
2713
2978
|
type: ["string", "array"],
|
|
2714
2979
|
items: { type: "number" },
|
|
2715
2980
|
default: '> primary | frameWithoutSeriesNames("geobin", "latitude", "longitude") | frameBySeriesTypes("number")'
|
|
@@ -2733,9 +2998,16 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2733
2998
|
default: visualization_color_palettes_exports.VIZ_CATEGORICAL
|
|
2734
2999
|
},
|
|
2735
3000
|
dataColors: {
|
|
2736
|
-
description: 'Specify the colors to use for data points. You can use an array of colors to be picked from, or you can use a dataSource to apply dynamic coloring. For example, \u201C> primary | seriesByName("status") | matchValue(colorMatchConfig)\u201D. When type: "choropleth", dataColors is defined by default, and the opacities are shown at 80% of maximum to allow textual information to be visible in the map. By default, the dataColors option is
|
|
3001
|
+
description: 'Specify the colors to use for data points. You can use an array of colors to be picked from, or you can use a dataSource to apply dynamic coloring. For example, \u201C> primary | seriesByName("status") | matchValue(colorMatchConfig)\u201D. When type: "choropleth", dataColors is defined by default, and the opacities are shown at 80% of maximum to allow textual information to be visible in the map. By default, the dataColors option is empty for "bubble" or "marker" layers to prioritize seriesColors. For "bubble" layers, dataColors requires bubbleSize to have a single series configured. If multiple series are set for bubbleSize, only the first pie slice reflects the colors.',
|
|
2737
3002
|
type: ["string", "array"],
|
|
2738
|
-
items: { type: "string" }
|
|
3003
|
+
items: { type: "string" },
|
|
3004
|
+
default: ""
|
|
3005
|
+
},
|
|
3006
|
+
dataValues: {
|
|
3007
|
+
description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
|
|
3008
|
+
type: ["string"],
|
|
3009
|
+
items: { type: "number" },
|
|
3010
|
+
default: '> primary | seriesByType("number")'
|
|
2739
3011
|
},
|
|
2740
3012
|
additionalTooltipFields: {
|
|
2741
3013
|
description: "Specify the fields to add to the default set of tooltips. Tooltips appear when you hover over data points. These fields and their corresponding values are shown in addition to the ones displayed by default.",
|
|
@@ -3533,7 +3805,12 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3533
3805
|
},
|
|
3534
3806
|
majorValue: {
|
|
3535
3807
|
default: "> sparklineValues|lastPoint()",
|
|
3536
|
-
description: "The
|
|
3808
|
+
description: "The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified.",
|
|
3809
|
+
type: ["string", "number"]
|
|
3810
|
+
},
|
|
3811
|
+
majorValueDisplay: {
|
|
3812
|
+
default: "> majorValue",
|
|
3813
|
+
description: "The formatted version of majorValue displayed in the visualization.",
|
|
3537
3814
|
type: ["string", "number"]
|
|
3538
3815
|
},
|
|
3539
3816
|
majorValueField: {
|
|
@@ -3735,7 +4012,12 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3735
4012
|
},
|
|
3736
4013
|
majorValue: {
|
|
3737
4014
|
default: '> primary|seriesByPrioritizedTypes("number", "string", "time")|lastPoint()',
|
|
3738
|
-
description: "The
|
|
4015
|
+
description: "The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified.",
|
|
4016
|
+
type: ["string", "number"]
|
|
4017
|
+
},
|
|
4018
|
+
majorValueDisplay: {
|
|
4019
|
+
default: "> majorValue",
|
|
4020
|
+
description: "The formatted version of majorValue displayed in the visualization.",
|
|
3739
4021
|
type: ["string", "number"]
|
|
3740
4022
|
},
|
|
3741
4023
|
majorValueField: {
|
|
@@ -3886,7 +4168,12 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3886
4168
|
},
|
|
3887
4169
|
majorValue: {
|
|
3888
4170
|
default: '> primary | seriesByPrioritizedTypes("number", "string", "time") | lastPoint()',
|
|
3889
|
-
description: "
|
|
4171
|
+
description: "The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified.",
|
|
4172
|
+
type: ["string", "number"]
|
|
4173
|
+
},
|
|
4174
|
+
majorValueDisplay: {
|
|
4175
|
+
default: "> majorValue",
|
|
4176
|
+
description: "The formatted version of majorValue displayed in the visualization.",
|
|
3890
4177
|
type: ["string", "number"]
|
|
3891
4178
|
},
|
|
3892
4179
|
majorValueField: {
|
|
@@ -3975,7 +4262,7 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3975
4262
|
minimum: 1
|
|
3976
4263
|
},
|
|
3977
4264
|
trellisMinColumnWidth: {
|
|
3978
|
-
default:
|
|
4265
|
+
default: 120,
|
|
3979
4266
|
minimum: 1,
|
|
3980
4267
|
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.",
|
|
3981
4268
|
type: "number"
|
|
@@ -3987,7 +4274,7 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3987
4274
|
type: "number"
|
|
3988
4275
|
},
|
|
3989
4276
|
trellisRowHeight: {
|
|
3990
|
-
default:
|
|
4277
|
+
default: 100,
|
|
3991
4278
|
minimum: 1,
|
|
3992
4279
|
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.",
|
|
3993
4280
|
type: "number"
|
|
@@ -4299,6 +4586,99 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4299
4586
|
}
|
|
4300
4587
|
}
|
|
4301
4588
|
});
|
|
4589
|
+
|
|
4590
|
+
// src/optionsSchemas/timeline.ts
|
|
4591
|
+
var timelineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
4592
|
+
x: {
|
|
4593
|
+
default: '> primary | seriesByType("time")',
|
|
4594
|
+
description: "Specify the data source applied to the x-axis.",
|
|
4595
|
+
type: "array",
|
|
4596
|
+
items: { type: ["string", "number"] }
|
|
4597
|
+
},
|
|
4598
|
+
y: {
|
|
4599
|
+
default: '> primary | seriesByPrioritizedTypes("string", "number")',
|
|
4600
|
+
description: "Specify the data source applied to the y-axis.",
|
|
4601
|
+
type: "array",
|
|
4602
|
+
items: { type: ["string", "number"] }
|
|
4603
|
+
},
|
|
4604
|
+
duration: {
|
|
4605
|
+
default: '> primary | seriesByPrioritizedTypes("number", "time")',
|
|
4606
|
+
description: "Specify the data source to apply duration to events. This will display events over a length of time as a bar rather than a circle.",
|
|
4607
|
+
type: "array",
|
|
4608
|
+
items: { type: ["string", "number"] }
|
|
4609
|
+
},
|
|
4610
|
+
category: {
|
|
4611
|
+
default: '> primary| seriesByName("category")',
|
|
4612
|
+
description: "Specify the data source to apply series categories. This will color events in distinct categories.",
|
|
4613
|
+
type: "array",
|
|
4614
|
+
items: { type: ["string", "number"] }
|
|
4615
|
+
},
|
|
4616
|
+
xField: {
|
|
4617
|
+
default: "> x | getField()",
|
|
4618
|
+
description: "Specify the field that should be mapped to the x-axis.",
|
|
4619
|
+
type: "string"
|
|
4620
|
+
},
|
|
4621
|
+
yField: {
|
|
4622
|
+
default: "> y | getField()",
|
|
4623
|
+
description: "Specify the field that should be mapped to the y-axis.",
|
|
4624
|
+
type: "string"
|
|
4625
|
+
},
|
|
4626
|
+
durationField: {
|
|
4627
|
+
default: "> duration | getField()",
|
|
4628
|
+
description: "Specify the field that should be mapped to the x-axis.",
|
|
4629
|
+
type: "string"
|
|
4630
|
+
},
|
|
4631
|
+
categoryField: {
|
|
4632
|
+
default: "> category | getField()",
|
|
4633
|
+
description: "Specify the field that should be mapped to the y-axis.",
|
|
4634
|
+
type: "string"
|
|
4635
|
+
},
|
|
4636
|
+
additionalTooltipFields: {
|
|
4637
|
+
default: [],
|
|
4638
|
+
description: "Specify the fields to add to the default set of tooltips. Tooltips appear when you hover over events. These fields and their corresponding values are shown in addition to the ones displayed by default.",
|
|
4639
|
+
type: "array",
|
|
4640
|
+
items: { type: "string" }
|
|
4641
|
+
},
|
|
4642
|
+
backgroundColor: {
|
|
4643
|
+
default: "> themes.defaultBackgroundColor",
|
|
4644
|
+
description: 'Specify the color for the background. You may use a data source to apply the color. The default for enterprise light is "#ffffff". The default for enterprise dark is "#000000". The default for prisma dark is "#0b0c0e".',
|
|
4645
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
4646
|
+
type: "string"
|
|
4647
|
+
},
|
|
4648
|
+
dataColors: {
|
|
4649
|
+
description: 'Specify the colors to use for events. You can use an array of colors to be picked from, or you can use a data source to apply dynamic coloring. For example, \u201C> primary | seriesByName("count") | rangeValue(lowToHigh)\u201D. By default, the dataColors option is not defined and seriesColors is used for categorical coloring.',
|
|
4650
|
+
type: ["string", "array"],
|
|
4651
|
+
items: { type: "string" }
|
|
4652
|
+
},
|
|
4653
|
+
legendDisplay: {
|
|
4654
|
+
default: "off",
|
|
4655
|
+
description: "Specify the location of the legend on the panel.",
|
|
4656
|
+
pattern: getPattern(["right", "bottom", "off"]),
|
|
4657
|
+
type: "string"
|
|
4658
|
+
},
|
|
4659
|
+
legendTruncation: {
|
|
4660
|
+
default: "ellipsisEnd",
|
|
4661
|
+
description: "Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis.",
|
|
4662
|
+
pattern: getPattern(["ellipsisEnd", "ellipsisMiddle", "ellipsisStart", "ellipsisOff"]),
|
|
4663
|
+
type: "string"
|
|
4664
|
+
},
|
|
4665
|
+
resultLimit: {
|
|
4666
|
+
default: 1e4,
|
|
4667
|
+
description: "Specify the maximum number of events to render on the timeline. Adjust the value to improve performance.",
|
|
4668
|
+
type: "number"
|
|
4669
|
+
},
|
|
4670
|
+
seriesColors: {
|
|
4671
|
+
default: visualization_color_palettes_exports.VIZ_CATEGORICAL,
|
|
4672
|
+
description: 'Specify the colors used for a series. For example, ["#FF0000", "#0000FF", "#008000"].',
|
|
4673
|
+
type: "array",
|
|
4674
|
+
items: { type: "string" }
|
|
4675
|
+
},
|
|
4676
|
+
yAxisLabelWidth: {
|
|
4677
|
+
default: 100,
|
|
4678
|
+
description: "Specify the width, in pixels, for y-axis labels.",
|
|
4679
|
+
type: "number"
|
|
4680
|
+
}
|
|
4681
|
+
});
|
|
4302
4682
|
export {
|
|
4303
4683
|
COLOR_OR_TOKEN_PATTERN,
|
|
4304
4684
|
COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
@@ -4339,6 +4719,7 @@ export {
|
|
|
4339
4719
|
singleValueOptionsSchema,
|
|
4340
4720
|
singleValueRadialOptionsSchema,
|
|
4341
4721
|
tableOptionsSchema,
|
|
4722
|
+
timelineOptionsSchema,
|
|
4342
4723
|
validAlignments,
|
|
4343
4724
|
validCellRenderers,
|
|
4344
4725
|
validColumnAlignments,
|