@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/esm/index.js CHANGED
@@ -302,11 +302,15 @@ var enhanceOptionsSchemaWithDynamicOptions = (optionsSchema) => {
302
302
  if (type === "object") {
303
303
  enhancedOptionsSchema[key] = __spreadValues(__spreadProps(__spreadValues(__spreadValues({}, remainingSchemaEntry), annotations), {
304
304
  type
305
- }), properties && { properties: enhanceOptionsSchemaWithDynamicOptions(properties) });
305
+ }), properties && {
306
+ properties: enhanceOptionsSchemaWithDynamicOptions(properties)
307
+ });
306
308
  if (patternProperties) {
307
309
  let enhancedPatternProperties = {};
308
310
  Object.keys(patternProperties).forEach((opt) => {
309
- enhancedPatternProperties = __spreadValues(__spreadValues({}, enhancedPatternProperties), enhanceOptionsSchemaWithDynamicOptions({ [opt]: patternProperties[opt] }));
311
+ enhancedPatternProperties = __spreadValues(__spreadValues({}, enhancedPatternProperties), enhanceOptionsSchemaWithDynamicOptions({
312
+ [opt]: patternProperties[opt]
313
+ }));
310
314
  });
311
315
  enhancedOptionsSchema[key].patternProperties = enhancedPatternProperties;
312
316
  }
@@ -352,6 +356,12 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
352
356
  description: "Specify the field to map to the y-axis.",
353
357
  type: "string"
354
358
  },
359
+ additionalTooltipFields: {
360
+ default: [],
361
+ 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.",
362
+ type: "array",
363
+ items: { type: "string" }
364
+ },
355
365
  annotationColor: {
356
366
  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
367
  type: "array",
@@ -821,6 +831,12 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
821
831
  type: "string"
822
832
  }
823
833
  },
834
+ additionalTooltipFields: {
835
+ default: [],
836
+ 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.",
837
+ type: "array",
838
+ items: { type: "string" }
839
+ },
824
840
  backgroundColor: {
825
841
  default: "> themes.defaultBackgroundColor",
826
842
  description: "Specify the color used for the background. You can use a data source or hexadecimal code to apply the color.",
@@ -1592,6 +1608,12 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1592
1608
  type: "string"
1593
1609
  }
1594
1610
  },
1611
+ additionalTooltipFields: {
1612
+ default: [],
1613
+ 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.",
1614
+ type: "array",
1615
+ items: { type: "string" }
1616
+ },
1595
1617
  annotationColor: {
1596
1618
  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
1619
  type: "array",
@@ -2050,7 +2072,7 @@ var ellipseOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2050
2072
  },
2051
2073
  strokeWidth: {
2052
2074
  default: 1,
2053
- description: "Specify the width of the stroke, in pixels, in the range of 1 - 25 (inclusive).",
2075
+ description: "Specify the width of the stroke, in pixels. The minimum value is 0.",
2054
2076
  type: "number"
2055
2077
  }
2056
2078
  });
@@ -2254,6 +2276,12 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2254
2276
  description: "Specify the field that should be mapped to the y-axis.",
2255
2277
  type: "string"
2256
2278
  },
2279
+ additionalTooltipFields: {
2280
+ default: [],
2281
+ 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.",
2282
+ type: "array",
2283
+ items: { type: "string" }
2284
+ },
2257
2285
  annotationColor: {
2258
2286
  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
2287
  type: "array",
@@ -2871,7 +2899,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2871
2899
  seriesColors: {
2872
2900
  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".',
2873
2901
  type: "array",
2874
- items: { type: "string", pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA },
2902
+ items: {
2903
+ type: "string",
2904
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
2905
+ },
2875
2906
  default: visualization_color_palettes_exports.VIZ_CATEGORICAL
2876
2907
  },
2877
2908
  dataColors: {
@@ -2882,7 +2913,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2882
2913
  },
2883
2914
  dataValues: {
2884
2915
  description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
2885
- type: ["string"],
2916
+ type: ["string", "array"],
2886
2917
  items: { type: "number" },
2887
2918
  default: '> primary | seriesByType("number")'
2888
2919
  },
@@ -2892,6 +2923,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2892
2923
  items: { type: "string" },
2893
2924
  default: []
2894
2925
  },
2926
+ tooltipHeaderField: {
2927
+ 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.",
2928
+ type: "string"
2929
+ },
2895
2930
  resultLimit: {
2896
2931
  description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
2897
2932
  type: "number",
@@ -2936,6 +2971,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2936
2971
  items: { type: "string" },
2937
2972
  default: []
2938
2973
  },
2974
+ tooltipHeaderField: {
2975
+ 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.",
2976
+ type: "string"
2977
+ },
2939
2978
  resultLimit: {
2940
2979
  description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
2941
2980
  type: "number",
@@ -2999,7 +3038,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2999
3038
  seriesColors: {
3000
3039
  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".',
3001
3040
  type: "array",
3002
- items: { type: "string", pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA },
3041
+ items: {
3042
+ type: "string",
3043
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3044
+ },
3003
3045
  default: visualization_color_palettes_exports.VIZ_CATEGORICAL
3004
3046
  },
3005
3047
  dataColors: {
@@ -3010,7 +3052,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3010
3052
  },
3011
3053
  dataValues: {
3012
3054
  description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
3013
- type: ["string"],
3055
+ type: ["string", "array"],
3014
3056
  items: { type: "number" },
3015
3057
  default: '> primary | seriesByType("number")'
3016
3058
  },
@@ -3020,6 +3062,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3020
3062
  items: { type: "string" },
3021
3063
  default: []
3022
3064
  },
3065
+ tooltipHeaderField: {
3066
+ 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.",
3067
+ type: "string"
3068
+ },
3023
3069
  resultLimit: {
3024
3070
  description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
3025
3071
  type: "number",
@@ -3059,6 +3105,11 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3059
3105
  default: true,
3060
3106
  type: "boolean",
3061
3107
  description: "Specify whether to display coordinates (latitude and longitude) in the tooltip."
3108
+ },
3109
+ icon: {
3110
+ default: "",
3111
+ type: "string",
3112
+ description: 'Specify the url for an svg to display an icon inside bubbles for map. This applies to layers where type: "bubble".'
3062
3113
  }
3063
3114
  });
3064
3115
 
@@ -3501,7 +3552,7 @@ var rectangleOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3501
3552
  default: 1
3502
3553
  },
3503
3554
  strokeWidth: {
3504
- description: "Specify the width of the stroke, in pixels, in the range of 1 - 25 (inclusive).",
3555
+ description: "Specify the width of the stroke, in pixels. The minimum value is 0.",
3505
3556
  type: "number",
3506
3557
  default: 1
3507
3558
  }
@@ -3521,6 +3572,12 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3521
3572
  pattern: getPattern(["categorical", "dynamic"]),
3522
3573
  type: "string"
3523
3574
  },
3575
+ labelDisplay: {
3576
+ default: "off",
3577
+ 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. ",
3578
+ pattern: getPattern(["values", "valuesAndPercentage", "percentage", "off"]),
3579
+ type: "string"
3580
+ },
3524
3581
  linkColors: {
3525
3582
  default: `> linkValues | rangeValue(linkColorRangeConfig)`,
3526
3583
  description: "Specify the coloring method used for the links when the colorMode \u201Cdynamic\u201D is specified.",
@@ -3552,6 +3609,10 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3552
3609
  items: {
3553
3610
  type: "string"
3554
3611
  }
3612
+ },
3613
+ unit: {
3614
+ description: 'Specify text to show on the left of the value in the node label when "labelDisplay" is set to either "values" or "valuesAndPercentage"',
3615
+ type: "string"
3555
3616
  }
3556
3617
  });
3557
3618
 
@@ -4047,7 +4108,10 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4047
4108
  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.",
4048
4109
  type: "string"
4049
4110
  },
4050
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4111
+ underLabel: {
4112
+ description: "Specify the text that appears below the major value.",
4113
+ type: "string"
4114
+ },
4051
4115
  underLabelFontSize: {
4052
4116
  default: 12,
4053
4117
  description: "Specify the font size (px) for the under label text.",
@@ -4079,7 +4143,11 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4079
4143
  pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
4080
4144
  type: "string"
4081
4145
  },
4082
- icon: { default: "default", description: "Specify an icon.", type: "string" },
4146
+ icon: {
4147
+ default: "default",
4148
+ description: "Specify an icon.",
4149
+ type: "string"
4150
+ },
4083
4151
  iconColor: {
4084
4152
  default: null,
4085
4153
  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)".',
@@ -4210,7 +4278,10 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4210
4278
  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.",
4211
4279
  type: "string"
4212
4280
  },
4213
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4281
+ underLabel: {
4282
+ description: "Specify the text that appears below the major value.",
4283
+ type: "string"
4284
+ },
4214
4285
  unit: {
4215
4286
  description: "Specify text to show next to the major value.",
4216
4287
  type: "string"
@@ -4379,7 +4450,10 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4379
4450
  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.",
4380
4451
  type: "string"
4381
4452
  },
4382
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4453
+ underLabel: {
4454
+ description: "Specify the text that appears below the major value.",
4455
+ type: "string"
4456
+ },
4383
4457
  unit: {
4384
4458
  description: "Specify text to show next to the major value.",
4385
4459
  type: "string"
@@ -4432,7 +4506,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4432
4506
  oneOf: [
4433
4507
  { type: "string" },
4434
4508
  { type: "number" },
4435
- { type: "array", items: { type: ["string", "number"] } }
4509
+ {
4510
+ type: "array",
4511
+ items: { type: ["string", "number"] }
4512
+ }
4436
4513
  ]
4437
4514
  }
4438
4515
  },
@@ -4595,7 +4672,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4595
4672
  oneOf: [
4596
4673
  { type: "string" },
4597
4674
  { type: "number" },
4598
- { type: "array", items: { type: ["string", "number"] } }
4675
+ {
4676
+ type: "array",
4677
+ items: { type: ["string", "number"] }
4678
+ }
4599
4679
  ]
4600
4680
  }
4601
4681
  }