@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/cjs/index.js
CHANGED
|
@@ -101,6 +101,7 @@ __export(src_exports, {
|
|
|
101
101
|
singleValueOptionsSchema: () => singleValueOptionsSchema,
|
|
102
102
|
singleValueRadialOptionsSchema: () => singleValueRadialOptionsSchema,
|
|
103
103
|
tableOptionsSchema: () => tableOptionsSchema,
|
|
104
|
+
timelineOptionsSchema: () => timelineOptionsSchema,
|
|
104
105
|
validAlignments: () => validAlignments,
|
|
105
106
|
validCellRenderers: () => validCellRenderers,
|
|
106
107
|
validColumnAlignments: () => validColumnAlignments,
|
|
@@ -321,7 +322,7 @@ var TOKEN_NAME_CHARS_PATTERN = /([^$|:]+?)(\|[|\w]+)?/.source;
|
|
|
321
322
|
var TOKEN_PATTERN = /\$/.source + TOKEN_NAMESPACE_PREFIX_PATTERN + TOKEN_NAME_CHARS_PATTERN + /\$/.source;
|
|
322
323
|
var rgbColorPattern = /^rgb\(\s*(\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)$/;
|
|
323
324
|
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}
|
|
325
|
+
var colorPattern = "^#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$|^transparent$";
|
|
325
326
|
var colorPatternWithRGBA = `${colorPattern}|${rgbColorPattern.source}|${rgbaColorPattern.source}`;
|
|
326
327
|
var COLOR_OR_TOKEN_PATTERN = `${colorPattern}|${TOKEN_PATTERN}`;
|
|
327
328
|
var COLOR_OR_TOKEN_PATTERN_WITH_RGBA = `${colorPatternWithRGBA}|${TOKEN_PATTERN}`;
|
|
@@ -448,8 +449,7 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
448
449
|
default: "off"
|
|
449
450
|
},
|
|
450
451
|
legendDisplay: {
|
|
451
|
-
|
|
452
|
-
description: "Specify the location of the legend on the panel. You must select the Standard legend mode to make this change.",
|
|
452
|
+
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
453
|
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
454
454
|
type: "string"
|
|
455
455
|
},
|
|
@@ -470,6 +470,30 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
470
470
|
pattern: getPattern(["ellipsisEnd", "ellipsisMiddle", "ellipsisStart", "ellipsisOff"]),
|
|
471
471
|
type: "string"
|
|
472
472
|
},
|
|
473
|
+
lineDashStyle: {
|
|
474
|
+
default: "solid",
|
|
475
|
+
description: "Specify a dash style for all overlay field lines.",
|
|
476
|
+
pattern: getPattern([
|
|
477
|
+
"solid",
|
|
478
|
+
"shortDash",
|
|
479
|
+
"shortDot",
|
|
480
|
+
"shortDashDot",
|
|
481
|
+
"shortDashDotDot",
|
|
482
|
+
"dot",
|
|
483
|
+
"dash",
|
|
484
|
+
"longDash",
|
|
485
|
+
"dashDot",
|
|
486
|
+
"longDashDot",
|
|
487
|
+
"longDashDotDot"
|
|
488
|
+
]),
|
|
489
|
+
type: "string"
|
|
490
|
+
},
|
|
491
|
+
lineDashStylesByField: {
|
|
492
|
+
description: `Specify a dash style to use for overlay lines for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.
|
|
493
|
+
Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",
|
|
494
|
+
"longDash", "dashDot", "longDashDot", "longDashDotDot".`,
|
|
495
|
+
type: "object"
|
|
496
|
+
},
|
|
473
497
|
lineWidth: {
|
|
474
498
|
default: 2,
|
|
475
499
|
description: "Specify the line width (px) for overlay field lines.",
|
|
@@ -496,6 +520,13 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
496
520
|
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
521
|
type: "object"
|
|
498
522
|
},
|
|
523
|
+
splitByLayout: {
|
|
524
|
+
default: "off",
|
|
525
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
526
|
+
type: "string",
|
|
527
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
528
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
529
|
+
},
|
|
499
530
|
stackMode: {
|
|
500
531
|
description: "Specify stack mode.",
|
|
501
532
|
type: "string",
|
|
@@ -557,6 +588,45 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
557
588
|
type: "boolean",
|
|
558
589
|
default: false
|
|
559
590
|
},
|
|
591
|
+
trellisBackgroundColor: {
|
|
592
|
+
default: "> themes.defaultBackgroundColor",
|
|
593
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
594
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
595
|
+
type: "string"
|
|
596
|
+
},
|
|
597
|
+
trellisColumns: {
|
|
598
|
+
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.",
|
|
599
|
+
type: "number",
|
|
600
|
+
minimum: 1,
|
|
601
|
+
default: 3
|
|
602
|
+
},
|
|
603
|
+
trellisMinColumnWidth: {
|
|
604
|
+
default: 250,
|
|
605
|
+
minimum: 1,
|
|
606
|
+
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.",
|
|
607
|
+
type: "number"
|
|
608
|
+
},
|
|
609
|
+
trellisPageCount: {
|
|
610
|
+
default: 20,
|
|
611
|
+
minimum: 1,
|
|
612
|
+
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.",
|
|
613
|
+
type: "number"
|
|
614
|
+
},
|
|
615
|
+
trellisRowHeight: {
|
|
616
|
+
default: 180,
|
|
617
|
+
minimum: 1,
|
|
618
|
+
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.",
|
|
619
|
+
type: "number"
|
|
620
|
+
},
|
|
621
|
+
trellisSharedScale: {
|
|
622
|
+
default: true,
|
|
623
|
+
type: "boolean",
|
|
624
|
+
description: "Specify whether all visualizations will share the same scale in the trellis container."
|
|
625
|
+
},
|
|
626
|
+
trellisSplitBy: {
|
|
627
|
+
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.",
|
|
628
|
+
type: "string"
|
|
629
|
+
},
|
|
560
630
|
xAxisLabelRotation: {
|
|
561
631
|
description: "Specify the rotation of the x-axis label in degrees.",
|
|
562
632
|
enum: [-90, -45, 0, 45, 90],
|
|
@@ -832,8 +902,7 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
832
902
|
type: "string"
|
|
833
903
|
},
|
|
834
904
|
legendDisplay: {
|
|
835
|
-
|
|
836
|
-
description: "Specify the location of the legend on the panel.",
|
|
905
|
+
description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. ",
|
|
837
906
|
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
838
907
|
type: "string"
|
|
839
908
|
},
|
|
@@ -854,6 +923,30 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
854
923
|
pattern: getPattern(["ellipsisEnd", "ellipsisMiddle", "ellipsisStart", "ellipsisOff"]),
|
|
855
924
|
type: "string"
|
|
856
925
|
},
|
|
926
|
+
lineDashStyle: {
|
|
927
|
+
default: "solid",
|
|
928
|
+
description: "Specify a dash style for all overlay field lines.",
|
|
929
|
+
pattern: getPattern([
|
|
930
|
+
"solid",
|
|
931
|
+
"shortDash",
|
|
932
|
+
"shortDot",
|
|
933
|
+
"shortDashDot",
|
|
934
|
+
"shortDashDotDot",
|
|
935
|
+
"dot",
|
|
936
|
+
"dash",
|
|
937
|
+
"longDash",
|
|
938
|
+
"dashDot",
|
|
939
|
+
"longDashDot",
|
|
940
|
+
"longDashDotDot"
|
|
941
|
+
]),
|
|
942
|
+
type: "string"
|
|
943
|
+
},
|
|
944
|
+
lineDashStylesByField: {
|
|
945
|
+
description: `Specify a dash style to use for overlay lines for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.
|
|
946
|
+
Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",
|
|
947
|
+
"longDash", "dashDot", "longDashDot", "longDashDotDot".`,
|
|
948
|
+
type: "object"
|
|
949
|
+
},
|
|
857
950
|
lineWidth: {
|
|
858
951
|
default: 2,
|
|
859
952
|
description: "Specify the line width (px) for overlay field lines.",
|
|
@@ -878,6 +971,13 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
878
971
|
description: "Specify the spacing (px) between clustered series in column and bar charts.",
|
|
879
972
|
type: "number"
|
|
880
973
|
},
|
|
974
|
+
splitByLayout: {
|
|
975
|
+
default: "off",
|
|
976
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
977
|
+
type: "string",
|
|
978
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
979
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
980
|
+
},
|
|
881
981
|
stackMode: {
|
|
882
982
|
default: "auto",
|
|
883
983
|
description: "Specify stack mode.",
|
|
@@ -940,6 +1040,45 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
940
1040
|
pattern: getPattern(["auto", "show", "hide"]),
|
|
941
1041
|
type: "string"
|
|
942
1042
|
},
|
|
1043
|
+
trellisBackgroundColor: {
|
|
1044
|
+
default: "> themes.defaultBackgroundColor",
|
|
1045
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
1046
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
1047
|
+
type: "string"
|
|
1048
|
+
},
|
|
1049
|
+
trellisColumns: {
|
|
1050
|
+
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.",
|
|
1051
|
+
type: "number",
|
|
1052
|
+
minimum: 1,
|
|
1053
|
+
default: 3
|
|
1054
|
+
},
|
|
1055
|
+
trellisMinColumnWidth: {
|
|
1056
|
+
default: 250,
|
|
1057
|
+
minimum: 1,
|
|
1058
|
+
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.",
|
|
1059
|
+
type: "number"
|
|
1060
|
+
},
|
|
1061
|
+
trellisPageCount: {
|
|
1062
|
+
default: 20,
|
|
1063
|
+
minimum: 1,
|
|
1064
|
+
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.",
|
|
1065
|
+
type: "number"
|
|
1066
|
+
},
|
|
1067
|
+
trellisRowHeight: {
|
|
1068
|
+
default: 180,
|
|
1069
|
+
minimum: 1,
|
|
1070
|
+
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.",
|
|
1071
|
+
type: "number"
|
|
1072
|
+
},
|
|
1073
|
+
trellisSharedScale: {
|
|
1074
|
+
default: true,
|
|
1075
|
+
type: "boolean",
|
|
1076
|
+
description: "Specify whether all visualizations will share the same scale in the trellis container."
|
|
1077
|
+
},
|
|
1078
|
+
trellisSplitBy: {
|
|
1079
|
+
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.",
|
|
1080
|
+
type: "string"
|
|
1081
|
+
},
|
|
943
1082
|
yAxisLabelVisibility: {
|
|
944
1083
|
default: "auto",
|
|
945
1084
|
description: "Specify whether to show labels on the y-axis.",
|
|
@@ -1533,12 +1672,6 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1533
1672
|
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
1534
1673
|
type: "string"
|
|
1535
1674
|
},
|
|
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
1675
|
columnGrouping: {
|
|
1543
1676
|
default: "auto",
|
|
1544
1677
|
description: "Specify a column grouping mode. If chart.stackMode is defined, it overrides grouping mode settings.",
|
|
@@ -1549,11 +1682,16 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1549
1682
|
description: "Specifies the spacing (px) between columns in a column chart.",
|
|
1550
1683
|
type: "number"
|
|
1551
1684
|
},
|
|
1685
|
+
dataValuesDisplay: {
|
|
1686
|
+
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.',
|
|
1687
|
+
type: "string",
|
|
1688
|
+
pattern: getPattern(["off", "all", "minmax"]),
|
|
1689
|
+
default: "off"
|
|
1690
|
+
},
|
|
1552
1691
|
legendDisplay: {
|
|
1553
|
-
description: "Specify the location of the legend on the panel.",
|
|
1692
|
+
description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. ",
|
|
1554
1693
|
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
1555
|
-
type: "string"
|
|
1556
|
-
default: "right"
|
|
1694
|
+
type: "string"
|
|
1557
1695
|
},
|
|
1558
1696
|
legendLabels: {
|
|
1559
1697
|
description: `Specify a list of labels to populate the legend in advance. For example, ["percent", "count"].`,
|
|
@@ -1572,6 +1710,30 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1572
1710
|
type: "string",
|
|
1573
1711
|
default: "ellipsisEnd"
|
|
1574
1712
|
},
|
|
1713
|
+
lineDashStyle: {
|
|
1714
|
+
default: "solid",
|
|
1715
|
+
description: "Specify a dash style for all overlay field lines.",
|
|
1716
|
+
pattern: getPattern([
|
|
1717
|
+
"solid",
|
|
1718
|
+
"shortDash",
|
|
1719
|
+
"shortDot",
|
|
1720
|
+
"shortDashDot",
|
|
1721
|
+
"shortDashDotDot",
|
|
1722
|
+
"dot",
|
|
1723
|
+
"dash",
|
|
1724
|
+
"longDash",
|
|
1725
|
+
"dashDot",
|
|
1726
|
+
"longDashDot",
|
|
1727
|
+
"longDashDotDot"
|
|
1728
|
+
]),
|
|
1729
|
+
type: "string"
|
|
1730
|
+
},
|
|
1731
|
+
lineDashStylesByField: {
|
|
1732
|
+
description: `Specify a dash style to use for overlay lines for each field. For example, {"count": "longDashDot", "percent": "longDashDotDot"}.
|
|
1733
|
+
Valid values: "solid", "shortDash", "shortDot", "shortDashDot", "shortDashDotDot", "dot", "dash",
|
|
1734
|
+
"longDash", "dashDot", "longDashDot", "longDashDotDot".`,
|
|
1735
|
+
type: "object"
|
|
1736
|
+
},
|
|
1575
1737
|
lineWidth: {
|
|
1576
1738
|
default: 2,
|
|
1577
1739
|
description: "Specify the line width (px) for overlay field lines.",
|
|
@@ -1596,6 +1758,13 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1596
1758
|
description: "Specify the spacing (px) between clustered series in column and bar charts.",
|
|
1597
1759
|
type: "number"
|
|
1598
1760
|
},
|
|
1761
|
+
splitByLayout: {
|
|
1762
|
+
default: "off",
|
|
1763
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
1764
|
+
type: "string",
|
|
1765
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
1766
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
1767
|
+
},
|
|
1599
1768
|
stackMode: {
|
|
1600
1769
|
description: "Specify stack mode.",
|
|
1601
1770
|
type: "string",
|
|
@@ -1657,6 +1826,45 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1657
1826
|
type: "boolean",
|
|
1658
1827
|
default: false
|
|
1659
1828
|
},
|
|
1829
|
+
trellisBackgroundColor: {
|
|
1830
|
+
default: "> themes.defaultBackgroundColor",
|
|
1831
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
1832
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
1833
|
+
type: "string"
|
|
1834
|
+
},
|
|
1835
|
+
trellisColumns: {
|
|
1836
|
+
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.",
|
|
1837
|
+
type: "number",
|
|
1838
|
+
minimum: 1,
|
|
1839
|
+
default: 3
|
|
1840
|
+
},
|
|
1841
|
+
trellisMinColumnWidth: {
|
|
1842
|
+
default: 250,
|
|
1843
|
+
minimum: 1,
|
|
1844
|
+
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.",
|
|
1845
|
+
type: "number"
|
|
1846
|
+
},
|
|
1847
|
+
trellisPageCount: {
|
|
1848
|
+
default: 20,
|
|
1849
|
+
minimum: 1,
|
|
1850
|
+
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.",
|
|
1851
|
+
type: "number"
|
|
1852
|
+
},
|
|
1853
|
+
trellisRowHeight: {
|
|
1854
|
+
default: 180,
|
|
1855
|
+
minimum: 1,
|
|
1856
|
+
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.",
|
|
1857
|
+
type: "number"
|
|
1858
|
+
},
|
|
1859
|
+
trellisSharedScale: {
|
|
1860
|
+
default: true,
|
|
1861
|
+
type: "boolean",
|
|
1862
|
+
description: "Specify whether all visualizations will share the same scale in the trellis container."
|
|
1863
|
+
},
|
|
1864
|
+
trellisSplitBy: {
|
|
1865
|
+
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.",
|
|
1866
|
+
type: "string"
|
|
1867
|
+
},
|
|
1660
1868
|
xAxisLabelRotation: {
|
|
1661
1869
|
description: "Specify the rotation of the x-axis label in degrees.",
|
|
1662
1870
|
enum: [-90, -45, 0, 45, 90],
|
|
@@ -2133,8 +2341,7 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2133
2341
|
type: "string"
|
|
2134
2342
|
},
|
|
2135
2343
|
legendDisplay: {
|
|
2136
|
-
|
|
2137
|
-
description: "Specify the location of the legend on the panel. You must select the Standard legend mode to make this change.",
|
|
2344
|
+
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
2345
|
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
2139
2346
|
type: "string"
|
|
2140
2347
|
},
|
|
@@ -2267,6 +2474,52 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2267
2474
|
description: "Specify whether the y2-axis range includes zero.",
|
|
2268
2475
|
type: "boolean"
|
|
2269
2476
|
},
|
|
2477
|
+
splitByLayout: {
|
|
2478
|
+
default: "off",
|
|
2479
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
2480
|
+
type: "string",
|
|
2481
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
2482
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
2483
|
+
},
|
|
2484
|
+
trellisBackgroundColor: {
|
|
2485
|
+
default: "> themes.defaultBackgroundColor",
|
|
2486
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
2487
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
2488
|
+
type: "string"
|
|
2489
|
+
},
|
|
2490
|
+
trellisColumns: {
|
|
2491
|
+
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.",
|
|
2492
|
+
type: "number",
|
|
2493
|
+
minimum: 1,
|
|
2494
|
+
default: 3
|
|
2495
|
+
},
|
|
2496
|
+
trellisMinColumnWidth: {
|
|
2497
|
+
default: 250,
|
|
2498
|
+
minimum: 1,
|
|
2499
|
+
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.",
|
|
2500
|
+
type: "number"
|
|
2501
|
+
},
|
|
2502
|
+
trellisPageCount: {
|
|
2503
|
+
default: 20,
|
|
2504
|
+
minimum: 1,
|
|
2505
|
+
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.",
|
|
2506
|
+
type: "number"
|
|
2507
|
+
},
|
|
2508
|
+
trellisRowHeight: {
|
|
2509
|
+
default: 180,
|
|
2510
|
+
minimum: 1,
|
|
2511
|
+
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.",
|
|
2512
|
+
type: "number"
|
|
2513
|
+
},
|
|
2514
|
+
trellisSharedScale: {
|
|
2515
|
+
default: true,
|
|
2516
|
+
type: "boolean",
|
|
2517
|
+
description: "Specify whether all visualizations will share the same scale in the trellis container."
|
|
2518
|
+
},
|
|
2519
|
+
trellisSplitBy: {
|
|
2520
|
+
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.",
|
|
2521
|
+
type: "string"
|
|
2522
|
+
},
|
|
2270
2523
|
xAxisLabelRotation: {
|
|
2271
2524
|
default: 0,
|
|
2272
2525
|
description: "Specify the rotation of the x-axis label in degrees.",
|
|
@@ -2615,6 +2868,9 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2615
2868
|
latitude: '> primary | seriesByName("latitude")',
|
|
2616
2869
|
longitude: '> primary | seriesByName("longitude")',
|
|
2617
2870
|
seriesColors: visualization_color_palettes_exports.VIZ_CATEGORICAL,
|
|
2871
|
+
dataValues: '> primary | seriesByType("number")',
|
|
2872
|
+
dataColors: "",
|
|
2873
|
+
// default to an empty string to prioritize seriesColors
|
|
2618
2874
|
bubbleSize: '> primary | frameWithoutSeriesNames("geobin", "latitude", "longitude") | frameBySeriesTypes("number")',
|
|
2619
2875
|
additionalTooltipFields: [],
|
|
2620
2876
|
resultLimit: 1e3
|
|
@@ -2624,6 +2880,9 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2624
2880
|
latitude: '> primary | seriesByName("latitude")',
|
|
2625
2881
|
longitude: '> primary | seriesByName("longitude")',
|
|
2626
2882
|
seriesColors: visualization_color_palettes_exports.VIZ_CATEGORICAL,
|
|
2883
|
+
dataValues: '> primary | seriesByType("number")',
|
|
2884
|
+
dataColors: "",
|
|
2885
|
+
// default to an empty string to prioritize seriesColors
|
|
2627
2886
|
additionalTooltipFields: [],
|
|
2628
2887
|
resultLimit: 1e3
|
|
2629
2888
|
},
|
|
@@ -2675,9 +2934,16 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2675
2934
|
default: visualization_color_palettes_exports.VIZ_CATEGORICAL
|
|
2676
2935
|
},
|
|
2677
2936
|
dataColors: {
|
|
2678
|
-
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
|
|
2937
|
+
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.',
|
|
2679
2938
|
type: ["string", "array"],
|
|
2680
|
-
items: { type: "string" }
|
|
2939
|
+
items: { type: "string" },
|
|
2940
|
+
default: ""
|
|
2941
|
+
},
|
|
2942
|
+
dataValues: {
|
|
2943
|
+
description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
|
|
2944
|
+
type: ["string"],
|
|
2945
|
+
items: { type: "number" },
|
|
2946
|
+
default: '> primary | seriesByType("number")'
|
|
2681
2947
|
},
|
|
2682
2948
|
additionalTooltipFields: {
|
|
2683
2949
|
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.",
|
|
@@ -2772,7 +3038,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2772
3038
|
default: "bubble" /* Bubble */
|
|
2773
3039
|
},
|
|
2774
3040
|
bubbleSize: {
|
|
2775
|
-
description: 'Specify the data column to encode bubble size. This applies to layers where type: "bubble".',
|
|
3041
|
+
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.',
|
|
2776
3042
|
type: ["string", "array"],
|
|
2777
3043
|
items: { type: "number" },
|
|
2778
3044
|
default: '> primary | frameWithoutSeriesNames("geobin", "latitude", "longitude") | frameBySeriesTypes("number")'
|
|
@@ -2796,9 +3062,16 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2796
3062
|
default: visualization_color_palettes_exports.VIZ_CATEGORICAL
|
|
2797
3063
|
},
|
|
2798
3064
|
dataColors: {
|
|
2799
|
-
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
|
|
3065
|
+
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.',
|
|
2800
3066
|
type: ["string", "array"],
|
|
2801
|
-
items: { type: "string" }
|
|
3067
|
+
items: { type: "string" },
|
|
3068
|
+
default: ""
|
|
3069
|
+
},
|
|
3070
|
+
dataValues: {
|
|
3071
|
+
description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
|
|
3072
|
+
type: ["string"],
|
|
3073
|
+
items: { type: "number" },
|
|
3074
|
+
default: '> primary | seriesByType("number")'
|
|
2802
3075
|
},
|
|
2803
3076
|
additionalTooltipFields: {
|
|
2804
3077
|
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.",
|
|
@@ -3596,7 +3869,12 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3596
3869
|
},
|
|
3597
3870
|
majorValue: {
|
|
3598
3871
|
default: "> sparklineValues|lastPoint()",
|
|
3599
|
-
description: "The
|
|
3872
|
+
description: "The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified.",
|
|
3873
|
+
type: ["string", "number"]
|
|
3874
|
+
},
|
|
3875
|
+
majorValueDisplay: {
|
|
3876
|
+
default: "> majorValue",
|
|
3877
|
+
description: "The formatted version of majorValue displayed in the visualization.",
|
|
3600
3878
|
type: ["string", "number"]
|
|
3601
3879
|
},
|
|
3602
3880
|
majorValueField: {
|
|
@@ -3798,7 +4076,12 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3798
4076
|
},
|
|
3799
4077
|
majorValue: {
|
|
3800
4078
|
default: '> primary|seriesByPrioritizedTypes("number", "string", "time")|lastPoint()',
|
|
3801
|
-
description: "The
|
|
4079
|
+
description: "The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified.",
|
|
4080
|
+
type: ["string", "number"]
|
|
4081
|
+
},
|
|
4082
|
+
majorValueDisplay: {
|
|
4083
|
+
default: "> majorValue",
|
|
4084
|
+
description: "The formatted version of majorValue displayed in the visualization.",
|
|
3802
4085
|
type: ["string", "number"]
|
|
3803
4086
|
},
|
|
3804
4087
|
majorValueField: {
|
|
@@ -3949,7 +4232,12 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3949
4232
|
},
|
|
3950
4233
|
majorValue: {
|
|
3951
4234
|
default: '> primary | seriesByPrioritizedTypes("number", "string", "time") | lastPoint()',
|
|
3952
|
-
description: "
|
|
4235
|
+
description: "The raw value to display and used to calculate trendValue. It is not displayed if majorValueDisplay is specified.",
|
|
4236
|
+
type: ["string", "number"]
|
|
4237
|
+
},
|
|
4238
|
+
majorValueDisplay: {
|
|
4239
|
+
default: "> majorValue",
|
|
4240
|
+
description: "The formatted version of majorValue displayed in the visualization.",
|
|
3953
4241
|
type: ["string", "number"]
|
|
3954
4242
|
},
|
|
3955
4243
|
majorValueField: {
|
|
@@ -4038,7 +4326,7 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4038
4326
|
minimum: 1
|
|
4039
4327
|
},
|
|
4040
4328
|
trellisMinColumnWidth: {
|
|
4041
|
-
default:
|
|
4329
|
+
default: 120,
|
|
4042
4330
|
minimum: 1,
|
|
4043
4331
|
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
4332
|
type: "number"
|
|
@@ -4050,7 +4338,7 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4050
4338
|
type: "number"
|
|
4051
4339
|
},
|
|
4052
4340
|
trellisRowHeight: {
|
|
4053
|
-
default:
|
|
4341
|
+
default: 100,
|
|
4054
4342
|
minimum: 1,
|
|
4055
4343
|
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
4344
|
type: "number"
|
|
@@ -4362,4 +4650,97 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4362
4650
|
}
|
|
4363
4651
|
}
|
|
4364
4652
|
});
|
|
4653
|
+
|
|
4654
|
+
// src/optionsSchemas/timeline.ts
|
|
4655
|
+
var timelineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
4656
|
+
x: {
|
|
4657
|
+
default: '> primary | seriesByType("time")',
|
|
4658
|
+
description: "Specify the data source applied to the x-axis.",
|
|
4659
|
+
type: "array",
|
|
4660
|
+
items: { type: ["string", "number"] }
|
|
4661
|
+
},
|
|
4662
|
+
y: {
|
|
4663
|
+
default: '> primary | seriesByPrioritizedTypes("string", "number")',
|
|
4664
|
+
description: "Specify the data source applied to the y-axis.",
|
|
4665
|
+
type: "array",
|
|
4666
|
+
items: { type: ["string", "number"] }
|
|
4667
|
+
},
|
|
4668
|
+
duration: {
|
|
4669
|
+
default: '> primary | seriesByPrioritizedTypes("number", "time")',
|
|
4670
|
+
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.",
|
|
4671
|
+
type: "array",
|
|
4672
|
+
items: { type: ["string", "number"] }
|
|
4673
|
+
},
|
|
4674
|
+
category: {
|
|
4675
|
+
default: '> primary| seriesByName("category")',
|
|
4676
|
+
description: "Specify the data source to apply series categories. This will color events in distinct categories.",
|
|
4677
|
+
type: "array",
|
|
4678
|
+
items: { type: ["string", "number"] }
|
|
4679
|
+
},
|
|
4680
|
+
xField: {
|
|
4681
|
+
default: "> x | getField()",
|
|
4682
|
+
description: "Specify the field that should be mapped to the x-axis.",
|
|
4683
|
+
type: "string"
|
|
4684
|
+
},
|
|
4685
|
+
yField: {
|
|
4686
|
+
default: "> y | getField()",
|
|
4687
|
+
description: "Specify the field that should be mapped to the y-axis.",
|
|
4688
|
+
type: "string"
|
|
4689
|
+
},
|
|
4690
|
+
durationField: {
|
|
4691
|
+
default: "> duration | getField()",
|
|
4692
|
+
description: "Specify the field that should be mapped to the x-axis.",
|
|
4693
|
+
type: "string"
|
|
4694
|
+
},
|
|
4695
|
+
categoryField: {
|
|
4696
|
+
default: "> category | getField()",
|
|
4697
|
+
description: "Specify the field that should be mapped to the y-axis.",
|
|
4698
|
+
type: "string"
|
|
4699
|
+
},
|
|
4700
|
+
additionalTooltipFields: {
|
|
4701
|
+
default: [],
|
|
4702
|
+
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.",
|
|
4703
|
+
type: "array",
|
|
4704
|
+
items: { type: "string" }
|
|
4705
|
+
},
|
|
4706
|
+
backgroundColor: {
|
|
4707
|
+
default: "> themes.defaultBackgroundColor",
|
|
4708
|
+
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".',
|
|
4709
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
4710
|
+
type: "string"
|
|
4711
|
+
},
|
|
4712
|
+
dataColors: {
|
|
4713
|
+
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.',
|
|
4714
|
+
type: ["string", "array"],
|
|
4715
|
+
items: { type: "string" }
|
|
4716
|
+
},
|
|
4717
|
+
legendDisplay: {
|
|
4718
|
+
default: "off",
|
|
4719
|
+
description: "Specify the location of the legend on the panel.",
|
|
4720
|
+
pattern: getPattern(["right", "bottom", "off"]),
|
|
4721
|
+
type: "string"
|
|
4722
|
+
},
|
|
4723
|
+
legendTruncation: {
|
|
4724
|
+
default: "ellipsisEnd",
|
|
4725
|
+
description: "Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis.",
|
|
4726
|
+
pattern: getPattern(["ellipsisEnd", "ellipsisMiddle", "ellipsisStart", "ellipsisOff"]),
|
|
4727
|
+
type: "string"
|
|
4728
|
+
},
|
|
4729
|
+
resultLimit: {
|
|
4730
|
+
default: 1e4,
|
|
4731
|
+
description: "Specify the maximum number of events to render on the timeline. Adjust the value to improve performance.",
|
|
4732
|
+
type: "number"
|
|
4733
|
+
},
|
|
4734
|
+
seriesColors: {
|
|
4735
|
+
default: visualization_color_palettes_exports.VIZ_CATEGORICAL,
|
|
4736
|
+
description: 'Specify the colors used for a series. For example, ["#FF0000", "#0000FF", "#008000"].',
|
|
4737
|
+
type: "array",
|
|
4738
|
+
items: { type: "string" }
|
|
4739
|
+
},
|
|
4740
|
+
yAxisLabelWidth: {
|
|
4741
|
+
default: 100,
|
|
4742
|
+
description: "Specify the width, in pixels, for y-axis labels.",
|
|
4743
|
+
type: "number"
|
|
4744
|
+
}
|
|
4745
|
+
});
|
|
4365
4746
|
//# sourceMappingURL=index.js.map
|