@splunk/visualization-schemas 27.1.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 +137 -8
- package/dist/cjs/index.js.map +3 -3
- package/dist/esm/index.js +137 -8
- package/dist/esm/index.js.map +3 -3
- package/package.json +4 -3
package/dist/esm/index.js
CHANGED
|
@@ -2804,6 +2804,9 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2804
2804
|
latitude: '> primary | seriesByName("latitude")',
|
|
2805
2805
|
longitude: '> primary | seriesByName("longitude")',
|
|
2806
2806
|
seriesColors: visualization_color_palettes_exports.VIZ_CATEGORICAL,
|
|
2807
|
+
dataValues: '> primary | seriesByType("number")',
|
|
2808
|
+
dataColors: "",
|
|
2809
|
+
// default to an empty string to prioritize seriesColors
|
|
2807
2810
|
bubbleSize: '> primary | frameWithoutSeriesNames("geobin", "latitude", "longitude") | frameBySeriesTypes("number")',
|
|
2808
2811
|
additionalTooltipFields: [],
|
|
2809
2812
|
resultLimit: 1e3
|
|
@@ -2813,6 +2816,9 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2813
2816
|
latitude: '> primary | seriesByName("latitude")',
|
|
2814
2817
|
longitude: '> primary | seriesByName("longitude")',
|
|
2815
2818
|
seriesColors: visualization_color_palettes_exports.VIZ_CATEGORICAL,
|
|
2819
|
+
dataValues: '> primary | seriesByType("number")',
|
|
2820
|
+
dataColors: "",
|
|
2821
|
+
// default to an empty string to prioritize seriesColors
|
|
2816
2822
|
additionalTooltipFields: [],
|
|
2817
2823
|
resultLimit: 1e3
|
|
2818
2824
|
},
|
|
@@ -2864,9 +2870,16 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2864
2870
|
default: visualization_color_palettes_exports.VIZ_CATEGORICAL
|
|
2865
2871
|
},
|
|
2866
2872
|
dataColors: {
|
|
2867
|
-
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.',
|
|
2868
2874
|
type: ["string", "array"],
|
|
2869
|
-
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")'
|
|
2870
2883
|
},
|
|
2871
2884
|
additionalTooltipFields: {
|
|
2872
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.",
|
|
@@ -2961,7 +2974,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2961
2974
|
default: "bubble" /* Bubble */
|
|
2962
2975
|
},
|
|
2963
2976
|
bubbleSize: {
|
|
2964
|
-
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.',
|
|
2965
2978
|
type: ["string", "array"],
|
|
2966
2979
|
items: { type: "number" },
|
|
2967
2980
|
default: '> primary | frameWithoutSeriesNames("geobin", "latitude", "longitude") | frameBySeriesTypes("number")'
|
|
@@ -2985,9 +2998,16 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2985
2998
|
default: visualization_color_palettes_exports.VIZ_CATEGORICAL
|
|
2986
2999
|
},
|
|
2987
3000
|
dataColors: {
|
|
2988
|
-
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.',
|
|
2989
3002
|
type: ["string", "array"],
|
|
2990
|
-
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")'
|
|
2991
3011
|
},
|
|
2992
3012
|
additionalTooltipFields: {
|
|
2993
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.",
|
|
@@ -3785,7 +3805,12 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3785
3805
|
},
|
|
3786
3806
|
majorValue: {
|
|
3787
3807
|
default: "> sparklineValues|lastPoint()",
|
|
3788
|
-
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.",
|
|
3789
3814
|
type: ["string", "number"]
|
|
3790
3815
|
},
|
|
3791
3816
|
majorValueField: {
|
|
@@ -3987,7 +4012,12 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3987
4012
|
},
|
|
3988
4013
|
majorValue: {
|
|
3989
4014
|
default: '> primary|seriesByPrioritizedTypes("number", "string", "time")|lastPoint()',
|
|
3990
|
-
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.",
|
|
3991
4021
|
type: ["string", "number"]
|
|
3992
4022
|
},
|
|
3993
4023
|
majorValueField: {
|
|
@@ -4138,7 +4168,12 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4138
4168
|
},
|
|
4139
4169
|
majorValue: {
|
|
4140
4170
|
default: '> primary | seriesByPrioritizedTypes("number", "string", "time") | lastPoint()',
|
|
4141
|
-
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.",
|
|
4142
4177
|
type: ["string", "number"]
|
|
4143
4178
|
},
|
|
4144
4179
|
majorValueField: {
|
|
@@ -4551,6 +4586,99 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4551
4586
|
}
|
|
4552
4587
|
}
|
|
4553
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
|
+
});
|
|
4554
4682
|
export {
|
|
4555
4683
|
COLOR_OR_TOKEN_PATTERN,
|
|
4556
4684
|
COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
@@ -4591,6 +4719,7 @@ export {
|
|
|
4591
4719
|
singleValueOptionsSchema,
|
|
4592
4720
|
singleValueRadialOptionsSchema,
|
|
4593
4721
|
tableOptionsSchema,
|
|
4722
|
+
timelineOptionsSchema,
|
|
4594
4723
|
validAlignments,
|
|
4595
4724
|
validCellRenderers,
|
|
4596
4725
|
validColumnAlignments,
|