@splunk/visualization-schemas 27.4.0 → 28.0.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 +94 -14
- package/dist/cjs/index.js.map +2 -2
- package/dist/esm/index.js +94 -14
- package/dist/esm/index.js.map +2 -2
- package/dist/types/utils/constants.d.ts +7 -7
- package/package.json +3 -3
package/dist/cjs/index.js
CHANGED
|
@@ -366,11 +366,15 @@ var enhanceOptionsSchemaWithDynamicOptions = (optionsSchema) => {
|
|
|
366
366
|
if (type === "object") {
|
|
367
367
|
enhancedOptionsSchema[key] = __spreadValues(__spreadProps(__spreadValues(__spreadValues({}, remainingSchemaEntry), annotations), {
|
|
368
368
|
type
|
|
369
|
-
}), properties && {
|
|
369
|
+
}), properties && {
|
|
370
|
+
properties: enhanceOptionsSchemaWithDynamicOptions(properties)
|
|
371
|
+
});
|
|
370
372
|
if (patternProperties) {
|
|
371
373
|
let enhancedPatternProperties = {};
|
|
372
374
|
Object.keys(patternProperties).forEach((opt) => {
|
|
373
|
-
enhancedPatternProperties = __spreadValues(__spreadValues({}, enhancedPatternProperties), enhanceOptionsSchemaWithDynamicOptions({
|
|
375
|
+
enhancedPatternProperties = __spreadValues(__spreadValues({}, enhancedPatternProperties), enhanceOptionsSchemaWithDynamicOptions({
|
|
376
|
+
[opt]: patternProperties[opt]
|
|
377
|
+
}));
|
|
374
378
|
});
|
|
375
379
|
enhancedOptionsSchema[key].patternProperties = enhancedPatternProperties;
|
|
376
380
|
}
|
|
@@ -416,6 +420,12 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
416
420
|
description: "Specify the field to map to the y-axis.",
|
|
417
421
|
type: "string"
|
|
418
422
|
},
|
|
423
|
+
additionalTooltipFields: {
|
|
424
|
+
default: [],
|
|
425
|
+
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.",
|
|
426
|
+
type: "array",
|
|
427
|
+
items: { type: "string" }
|
|
428
|
+
},
|
|
419
429
|
annotationColor: {
|
|
420
430
|
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.`,
|
|
421
431
|
type: "array",
|
|
@@ -885,6 +895,12 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
885
895
|
type: "string"
|
|
886
896
|
}
|
|
887
897
|
},
|
|
898
|
+
additionalTooltipFields: {
|
|
899
|
+
default: [],
|
|
900
|
+
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.",
|
|
901
|
+
type: "array",
|
|
902
|
+
items: { type: "string" }
|
|
903
|
+
},
|
|
888
904
|
backgroundColor: {
|
|
889
905
|
default: "> themes.defaultBackgroundColor",
|
|
890
906
|
description: "Specify the color used for the background. You can use a data source or hexadecimal code to apply the color.",
|
|
@@ -1656,6 +1672,12 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
1656
1672
|
type: "string"
|
|
1657
1673
|
}
|
|
1658
1674
|
},
|
|
1675
|
+
additionalTooltipFields: {
|
|
1676
|
+
default: [],
|
|
1677
|
+
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.",
|
|
1678
|
+
type: "array",
|
|
1679
|
+
items: { type: "string" }
|
|
1680
|
+
},
|
|
1659
1681
|
annotationColor: {
|
|
1660
1682
|
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.`,
|
|
1661
1683
|
type: "array",
|
|
@@ -2114,7 +2136,7 @@ var ellipseOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2114
2136
|
},
|
|
2115
2137
|
strokeWidth: {
|
|
2116
2138
|
default: 1,
|
|
2117
|
-
description: "Specify the width of the stroke, in pixels
|
|
2139
|
+
description: "Specify the width of the stroke, in pixels. The minimum value is 0.",
|
|
2118
2140
|
type: "number"
|
|
2119
2141
|
}
|
|
2120
2142
|
});
|
|
@@ -2318,6 +2340,12 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2318
2340
|
description: "Specify the field that should be mapped to the y-axis.",
|
|
2319
2341
|
type: "string"
|
|
2320
2342
|
},
|
|
2343
|
+
additionalTooltipFields: {
|
|
2344
|
+
default: [],
|
|
2345
|
+
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.",
|
|
2346
|
+
type: "array",
|
|
2347
|
+
items: { type: "string" }
|
|
2348
|
+
},
|
|
2321
2349
|
annotationColor: {
|
|
2322
2350
|
description: `Specify the annotation colors. You may use a dataSource to apply the color. For example, [\u201C#FF0000\u201D, \u201C#0000FF", \u201C#008000\u201D].`,
|
|
2323
2351
|
type: "array",
|
|
@@ -2935,7 +2963,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2935
2963
|
seriesColors: {
|
|
2936
2964
|
description: 'Specify the colors to use for data points. If the dataColors option is specified, the seriesColors option is ignored. The seriesColors option applies to layers where type: "bubble" or type: "marker".',
|
|
2937
2965
|
type: "array",
|
|
2938
|
-
items: {
|
|
2966
|
+
items: {
|
|
2967
|
+
type: "string",
|
|
2968
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
|
|
2969
|
+
},
|
|
2939
2970
|
default: visualization_color_palettes_exports.VIZ_CATEGORICAL
|
|
2940
2971
|
},
|
|
2941
2972
|
dataColors: {
|
|
@@ -2946,7 +2977,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2946
2977
|
},
|
|
2947
2978
|
dataValues: {
|
|
2948
2979
|
description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
|
|
2949
|
-
type: ["string"],
|
|
2980
|
+
type: ["string", "array"],
|
|
2950
2981
|
items: { type: "number" },
|
|
2951
2982
|
default: '> primary | seriesByType("number")'
|
|
2952
2983
|
},
|
|
@@ -2956,6 +2987,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2956
2987
|
items: { type: "string" },
|
|
2957
2988
|
default: []
|
|
2958
2989
|
},
|
|
2990
|
+
tooltipHeaderField: {
|
|
2991
|
+
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.",
|
|
2992
|
+
type: "string"
|
|
2993
|
+
},
|
|
2959
2994
|
resultLimit: {
|
|
2960
2995
|
description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
|
|
2961
2996
|
type: "number",
|
|
@@ -3000,6 +3035,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3000
3035
|
items: { type: "string" },
|
|
3001
3036
|
default: []
|
|
3002
3037
|
},
|
|
3038
|
+
tooltipHeaderField: {
|
|
3039
|
+
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.",
|
|
3040
|
+
type: "string"
|
|
3041
|
+
},
|
|
3003
3042
|
resultLimit: {
|
|
3004
3043
|
description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
|
|
3005
3044
|
type: "number",
|
|
@@ -3063,7 +3102,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3063
3102
|
seriesColors: {
|
|
3064
3103
|
description: 'Specify the colors to use for data points. If the dataColors option is specified, the seriesColors option is ignored. The seriesColors option applies to layers where type: "bubble" or type: "marker".',
|
|
3065
3104
|
type: "array",
|
|
3066
|
-
items: {
|
|
3105
|
+
items: {
|
|
3106
|
+
type: "string",
|
|
3107
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
|
|
3108
|
+
},
|
|
3067
3109
|
default: visualization_color_palettes_exports.VIZ_CATEGORICAL
|
|
3068
3110
|
},
|
|
3069
3111
|
dataColors: {
|
|
@@ -3074,7 +3116,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3074
3116
|
},
|
|
3075
3117
|
dataValues: {
|
|
3076
3118
|
description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
|
|
3077
|
-
type: ["string"],
|
|
3119
|
+
type: ["string", "array"],
|
|
3078
3120
|
items: { type: "number" },
|
|
3079
3121
|
default: '> primary | seriesByType("number")'
|
|
3080
3122
|
},
|
|
@@ -3084,6 +3126,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3084
3126
|
items: { type: "string" },
|
|
3085
3127
|
default: []
|
|
3086
3128
|
},
|
|
3129
|
+
tooltipHeaderField: {
|
|
3130
|
+
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.",
|
|
3131
|
+
type: "string"
|
|
3132
|
+
},
|
|
3087
3133
|
resultLimit: {
|
|
3088
3134
|
description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
|
|
3089
3135
|
type: "number",
|
|
@@ -3123,6 +3169,11 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3123
3169
|
default: true,
|
|
3124
3170
|
type: "boolean",
|
|
3125
3171
|
description: "Specify whether to display coordinates (latitude and longitude) in the tooltip."
|
|
3172
|
+
},
|
|
3173
|
+
icon: {
|
|
3174
|
+
default: "",
|
|
3175
|
+
type: "string",
|
|
3176
|
+
description: 'Specify the url for an svg to display an icon inside bubbles for map. This applies to layers where type: "bubble".'
|
|
3126
3177
|
}
|
|
3127
3178
|
});
|
|
3128
3179
|
|
|
@@ -3565,7 +3616,7 @@ var rectangleOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3565
3616
|
default: 1
|
|
3566
3617
|
},
|
|
3567
3618
|
strokeWidth: {
|
|
3568
|
-
description: "Specify the width of the stroke, in pixels
|
|
3619
|
+
description: "Specify the width of the stroke, in pixels. The minimum value is 0.",
|
|
3569
3620
|
type: "number",
|
|
3570
3621
|
default: 1
|
|
3571
3622
|
}
|
|
@@ -3585,6 +3636,12 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3585
3636
|
pattern: getPattern(["categorical", "dynamic"]),
|
|
3586
3637
|
type: "string"
|
|
3587
3638
|
},
|
|
3639
|
+
labelDisplay: {
|
|
3640
|
+
default: "off",
|
|
3641
|
+
description: "Specify whether to display the values and/or percentages of the nodes. Values are abbreviated to two decimal points, and a magnitude unit will be displayed. Percentages are calculated using the maximum node value as 100%. For very small nodes (with height < 24px) the values/percentage display is automatically turned off. ",
|
|
3642
|
+
pattern: getPattern(["values", "valuesAndPercentage", "percentage", "off"]),
|
|
3643
|
+
type: "string"
|
|
3644
|
+
},
|
|
3588
3645
|
linkColors: {
|
|
3589
3646
|
default: `> linkValues | rangeValue(linkColorRangeConfig)`,
|
|
3590
3647
|
description: "Specify the coloring method used for the links when the colorMode \u201Cdynamic\u201D is specified.",
|
|
@@ -3616,6 +3673,10 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3616
3673
|
items: {
|
|
3617
3674
|
type: "string"
|
|
3618
3675
|
}
|
|
3676
|
+
},
|
|
3677
|
+
unit: {
|
|
3678
|
+
description: 'Specify text to show on the left of the value in the node label when "labelDisplay" is set to either "values" or "valuesAndPercentage"',
|
|
3679
|
+
type: "string"
|
|
3619
3680
|
}
|
|
3620
3681
|
});
|
|
3621
3682
|
|
|
@@ -4111,7 +4172,10 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4111
4172
|
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.",
|
|
4112
4173
|
type: "string"
|
|
4113
4174
|
},
|
|
4114
|
-
underLabel: {
|
|
4175
|
+
underLabel: {
|
|
4176
|
+
description: "Specify the text that appears below the major value.",
|
|
4177
|
+
type: "string"
|
|
4178
|
+
},
|
|
4115
4179
|
underLabelFontSize: {
|
|
4116
4180
|
default: 12,
|
|
4117
4181
|
description: "Specify the font size (px) for the under label text.",
|
|
@@ -4143,7 +4207,11 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4143
4207
|
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
4144
4208
|
type: "string"
|
|
4145
4209
|
},
|
|
4146
|
-
icon: {
|
|
4210
|
+
icon: {
|
|
4211
|
+
default: "default",
|
|
4212
|
+
description: "Specify an icon.",
|
|
4213
|
+
type: "string"
|
|
4214
|
+
},
|
|
4147
4215
|
iconColor: {
|
|
4148
4216
|
default: null,
|
|
4149
4217
|
description: 'Specify the color for the icon. You may use a dataSource to apply the color. The hex value format should be \u201C#FFFFFF\u201D. The default for enterprise light is "#000000". The default for enterprise dark is "#ffffff". The default for prisma dark is "rgba(255, 255, 255, 0.98)".',
|
|
@@ -4274,7 +4342,10 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4274
4342
|
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.",
|
|
4275
4343
|
type: "string"
|
|
4276
4344
|
},
|
|
4277
|
-
underLabel: {
|
|
4345
|
+
underLabel: {
|
|
4346
|
+
description: "Specify the text that appears below the major value.",
|
|
4347
|
+
type: "string"
|
|
4348
|
+
},
|
|
4278
4349
|
unit: {
|
|
4279
4350
|
description: "Specify text to show next to the major value.",
|
|
4280
4351
|
type: "string"
|
|
@@ -4443,7 +4514,10 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4443
4514
|
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.",
|
|
4444
4515
|
type: "string"
|
|
4445
4516
|
},
|
|
4446
|
-
underLabel: {
|
|
4517
|
+
underLabel: {
|
|
4518
|
+
description: "Specify the text that appears below the major value.",
|
|
4519
|
+
type: "string"
|
|
4520
|
+
},
|
|
4447
4521
|
unit: {
|
|
4448
4522
|
description: "Specify text to show next to the major value.",
|
|
4449
4523
|
type: "string"
|
|
@@ -4496,7 +4570,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4496
4570
|
oneOf: [
|
|
4497
4571
|
{ type: "string" },
|
|
4498
4572
|
{ type: "number" },
|
|
4499
|
-
{
|
|
4573
|
+
{
|
|
4574
|
+
type: "array",
|
|
4575
|
+
items: { type: ["string", "number"] }
|
|
4576
|
+
}
|
|
4500
4577
|
]
|
|
4501
4578
|
}
|
|
4502
4579
|
},
|
|
@@ -4659,7 +4736,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4659
4736
|
oneOf: [
|
|
4660
4737
|
{ type: "string" },
|
|
4661
4738
|
{ type: "number" },
|
|
4662
|
-
{
|
|
4739
|
+
{
|
|
4740
|
+
type: "array",
|
|
4741
|
+
items: { type: ["string", "number"] }
|
|
4742
|
+
}
|
|
4663
4743
|
]
|
|
4664
4744
|
}
|
|
4665
4745
|
}
|