@splunk/visualization-schemas 27.3.0 → 27.5.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 +136 -4
- package/dist/cjs/index.js.map +2 -2
- package/dist/esm/index.js +136 -4
- package/dist/esm/index.js.map +2 -2
- package/package.json +3 -3
package/dist/esm/index.js
CHANGED
|
@@ -352,6 +352,12 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
352
352
|
description: "Specify the field to map to the y-axis.",
|
|
353
353
|
type: "string"
|
|
354
354
|
},
|
|
355
|
+
additionalTooltipFields: {
|
|
356
|
+
default: [],
|
|
357
|
+
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.",
|
|
358
|
+
type: "array",
|
|
359
|
+
items: { type: "string" }
|
|
360
|
+
},
|
|
355
361
|
annotationColor: {
|
|
356
362
|
description: `Specify the annotation colors. For example, [\u201C#FF0000\u201D, \u201C#0000FF", \u201C#008000\u201D]. You can use a data source or a hexadecimal code to apply the color.`,
|
|
357
363
|
type: "array",
|
|
@@ -821,6 +827,12 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
821
827
|
type: "string"
|
|
822
828
|
}
|
|
823
829
|
},
|
|
830
|
+
additionalTooltipFields: {
|
|
831
|
+
default: [],
|
|
832
|
+
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.",
|
|
833
|
+
type: "array",
|
|
834
|
+
items: { type: "string" }
|
|
835
|
+
},
|
|
824
836
|
backgroundColor: {
|
|
825
837
|
default: "> themes.defaultBackgroundColor",
|
|
826
838
|
description: "Specify the color used for the background. You can use a data source or hexadecimal code to apply the color.",
|
|
@@ -1592,6 +1604,12 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1592
1604
|
type: "string"
|
|
1593
1605
|
}
|
|
1594
1606
|
},
|
|
1607
|
+
additionalTooltipFields: {
|
|
1608
|
+
default: [],
|
|
1609
|
+
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.",
|
|
1610
|
+
type: "array",
|
|
1611
|
+
items: { type: "string" }
|
|
1612
|
+
},
|
|
1595
1613
|
annotationColor: {
|
|
1596
1614
|
description: `Specify the annotation colors. For example, [\u201C#FF0000\u201D, \u201C#0000FF", \u201C#008000\u201D]. You can use a data source or hexadecimal code to apply the color.`,
|
|
1597
1615
|
type: "array",
|
|
@@ -2254,6 +2272,12 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2254
2272
|
description: "Specify the field that should be mapped to the y-axis.",
|
|
2255
2273
|
type: "string"
|
|
2256
2274
|
},
|
|
2275
|
+
additionalTooltipFields: {
|
|
2276
|
+
default: [],
|
|
2277
|
+
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.",
|
|
2278
|
+
type: "array",
|
|
2279
|
+
items: { type: "string" }
|
|
2280
|
+
},
|
|
2257
2281
|
annotationColor: {
|
|
2258
2282
|
description: `Specify the annotation colors. You may use a dataSource to apply the color. For example, [\u201C#FF0000\u201D, \u201C#0000FF", \u201C#008000\u201D].`,
|
|
2259
2283
|
type: "array",
|
|
@@ -2882,7 +2906,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2882
2906
|
},
|
|
2883
2907
|
dataValues: {
|
|
2884
2908
|
description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
|
|
2885
|
-
type: ["string"],
|
|
2909
|
+
type: ["string", "array"],
|
|
2886
2910
|
items: { type: "number" },
|
|
2887
2911
|
default: '> primary | seriesByType("number")'
|
|
2888
2912
|
},
|
|
@@ -2892,6 +2916,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2892
2916
|
items: { type: "string" },
|
|
2893
2917
|
default: []
|
|
2894
2918
|
},
|
|
2919
|
+
tooltipHeaderField: {
|
|
2920
|
+
description: "Specify the field to add to the tooltip header. Tooltips appear when you hover over data points. Only the value of this field will be displayed as the header.",
|
|
2921
|
+
type: "string"
|
|
2922
|
+
},
|
|
2895
2923
|
resultLimit: {
|
|
2896
2924
|
description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
|
|
2897
2925
|
type: "number",
|
|
@@ -2936,6 +2964,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2936
2964
|
items: { type: "string" },
|
|
2937
2965
|
default: []
|
|
2938
2966
|
},
|
|
2967
|
+
tooltipHeaderField: {
|
|
2968
|
+
description: "Specify the field to add to the tooltip header. Tooltips appear when you hover over data points. Only the value of this field will be displayed as the header.",
|
|
2969
|
+
type: "string"
|
|
2970
|
+
},
|
|
2939
2971
|
resultLimit: {
|
|
2940
2972
|
description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
|
|
2941
2973
|
type: "number",
|
|
@@ -3010,7 +3042,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3010
3042
|
},
|
|
3011
3043
|
dataValues: {
|
|
3012
3044
|
description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
|
|
3013
|
-
type: ["string"],
|
|
3045
|
+
type: ["string", "array"],
|
|
3014
3046
|
items: { type: "number" },
|
|
3015
3047
|
default: '> primary | seriesByType("number")'
|
|
3016
3048
|
},
|
|
@@ -3020,6 +3052,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3020
3052
|
items: { type: "string" },
|
|
3021
3053
|
default: []
|
|
3022
3054
|
},
|
|
3055
|
+
tooltipHeaderField: {
|
|
3056
|
+
description: "Specify the field to add to the tooltip header. Tooltips appear when you hover over data points. Only the value of this field will be displayed as the header.",
|
|
3057
|
+
type: "string"
|
|
3058
|
+
},
|
|
3023
3059
|
resultLimit: {
|
|
3024
3060
|
description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
|
|
3025
3061
|
type: "number",
|
|
@@ -3054,6 +3090,16 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3054
3090
|
zoom: {
|
|
3055
3091
|
description: "Specify the zoom level of the map.",
|
|
3056
3092
|
type: "number"
|
|
3093
|
+
},
|
|
3094
|
+
showCoordinates: {
|
|
3095
|
+
default: true,
|
|
3096
|
+
type: "boolean",
|
|
3097
|
+
description: "Specify whether to display coordinates (latitude and longitude) in the tooltip."
|
|
3098
|
+
},
|
|
3099
|
+
icon: {
|
|
3100
|
+
default: "",
|
|
3101
|
+
type: "string",
|
|
3102
|
+
description: 'Specify the url for an svg to display an icon inside bubbles for map. This applies to layers where type: "bubble".'
|
|
3057
3103
|
}
|
|
3058
3104
|
});
|
|
3059
3105
|
|
|
@@ -3264,6 +3310,47 @@ var pieOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3264
3310
|
description: "Specify whether the pie should be a donut.",
|
|
3265
3311
|
type: "boolean"
|
|
3266
3312
|
},
|
|
3313
|
+
splitByLayout: {
|
|
3314
|
+
default: "off",
|
|
3315
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
3316
|
+
type: "string",
|
|
3317
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
3318
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
3319
|
+
},
|
|
3320
|
+
trellisBackgroundColor: {
|
|
3321
|
+
default: "> themes.defaultBackgroundColor",
|
|
3322
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
3323
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
3324
|
+
type: "string"
|
|
3325
|
+
},
|
|
3326
|
+
trellisColumns: {
|
|
3327
|
+
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.",
|
|
3328
|
+
type: "number",
|
|
3329
|
+
minimum: 1,
|
|
3330
|
+
default: 3
|
|
3331
|
+
},
|
|
3332
|
+
trellisMinColumnWidth: {
|
|
3333
|
+
default: 250,
|
|
3334
|
+
minimum: 1,
|
|
3335
|
+
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.",
|
|
3336
|
+
type: "number"
|
|
3337
|
+
},
|
|
3338
|
+
trellisPageCount: {
|
|
3339
|
+
default: 20,
|
|
3340
|
+
minimum: 1,
|
|
3341
|
+
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.",
|
|
3342
|
+
type: "number"
|
|
3343
|
+
},
|
|
3344
|
+
trellisRowHeight: {
|
|
3345
|
+
default: 180,
|
|
3346
|
+
minimum: 1,
|
|
3347
|
+
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.",
|
|
3348
|
+
type: "number"
|
|
3349
|
+
},
|
|
3350
|
+
trellisSplitBy: {
|
|
3351
|
+
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.",
|
|
3352
|
+
type: "string"
|
|
3353
|
+
},
|
|
3267
3354
|
value: {
|
|
3268
3355
|
description: "List of numerical values to power the pie chart.",
|
|
3269
3356
|
type: "array",
|
|
@@ -3551,8 +3638,7 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3551
3638
|
type: "string"
|
|
3552
3639
|
},
|
|
3553
3640
|
legendDisplay: {
|
|
3554
|
-
|
|
3555
|
-
description: "Specify the location of the legend on the panel.",
|
|
3641
|
+
description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. ",
|
|
3556
3642
|
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
3557
3643
|
type: "string"
|
|
3558
3644
|
},
|
|
@@ -3628,6 +3714,52 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3628
3714
|
description: "Specify whether minor grid lines are visible on the y-axis.",
|
|
3629
3715
|
type: "boolean"
|
|
3630
3716
|
},
|
|
3717
|
+
splitByLayout: {
|
|
3718
|
+
default: "off",
|
|
3719
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
3720
|
+
type: "string",
|
|
3721
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
3722
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
3723
|
+
},
|
|
3724
|
+
trellisBackgroundColor: {
|
|
3725
|
+
default: "> themes.defaultBackgroundColor",
|
|
3726
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
3727
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
3728
|
+
type: "string"
|
|
3729
|
+
},
|
|
3730
|
+
trellisColumns: {
|
|
3731
|
+
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.",
|
|
3732
|
+
type: "number",
|
|
3733
|
+
minimum: 1,
|
|
3734
|
+
default: 3
|
|
3735
|
+
},
|
|
3736
|
+
trellisMinColumnWidth: {
|
|
3737
|
+
default: 250,
|
|
3738
|
+
minimum: 1,
|
|
3739
|
+
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.",
|
|
3740
|
+
type: "number"
|
|
3741
|
+
},
|
|
3742
|
+
trellisPageCount: {
|
|
3743
|
+
default: 20,
|
|
3744
|
+
minimum: 1,
|
|
3745
|
+
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.",
|
|
3746
|
+
type: "number"
|
|
3747
|
+
},
|
|
3748
|
+
trellisRowHeight: {
|
|
3749
|
+
default: 180,
|
|
3750
|
+
minimum: 1,
|
|
3751
|
+
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.",
|
|
3752
|
+
type: "number"
|
|
3753
|
+
},
|
|
3754
|
+
trellisSharedScale: {
|
|
3755
|
+
default: true,
|
|
3756
|
+
type: "boolean",
|
|
3757
|
+
description: "Specify whether all visualizations will share the same scale in the trellis container."
|
|
3758
|
+
},
|
|
3759
|
+
trellisSplitBy: {
|
|
3760
|
+
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 `stats` command is used, this may default to the first string field.",
|
|
3761
|
+
type: "string"
|
|
3762
|
+
},
|
|
3631
3763
|
xAxisLabelRotation: {
|
|
3632
3764
|
default: 0,
|
|
3633
3765
|
description: "Specify the rotation of the x-axis labels in degrees.",
|