@splunk/visualization-schemas 27.5.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
  }
@@ -2068,7 +2072,7 @@ var ellipseOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2068
2072
  },
2069
2073
  strokeWidth: {
2070
2074
  default: 1,
2071
- 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.",
2072
2076
  type: "number"
2073
2077
  }
2074
2078
  });
@@ -2895,7 +2899,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2895
2899
  seriesColors: {
2896
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".',
2897
2901
  type: "array",
2898
- items: { type: "string", pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA },
2902
+ items: {
2903
+ type: "string",
2904
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
2905
+ },
2899
2906
  default: visualization_color_palettes_exports.VIZ_CATEGORICAL
2900
2907
  },
2901
2908
  dataColors: {
@@ -3031,7 +3038,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3031
3038
  seriesColors: {
3032
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".',
3033
3040
  type: "array",
3034
- items: { type: "string", pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA },
3041
+ items: {
3042
+ type: "string",
3043
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3044
+ },
3035
3045
  default: visualization_color_palettes_exports.VIZ_CATEGORICAL
3036
3046
  },
3037
3047
  dataColors: {
@@ -3542,7 +3552,7 @@ var rectangleOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3542
3552
  default: 1
3543
3553
  },
3544
3554
  strokeWidth: {
3545
- 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.",
3546
3556
  type: "number",
3547
3557
  default: 1
3548
3558
  }
@@ -3562,6 +3572,12 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3562
3572
  pattern: getPattern(["categorical", "dynamic"]),
3563
3573
  type: "string"
3564
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
+ },
3565
3581
  linkColors: {
3566
3582
  default: `> linkValues | rangeValue(linkColorRangeConfig)`,
3567
3583
  description: "Specify the coloring method used for the links when the colorMode \u201Cdynamic\u201D is specified.",
@@ -3593,6 +3609,10 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3593
3609
  items: {
3594
3610
  type: "string"
3595
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"
3596
3616
  }
3597
3617
  });
3598
3618
 
@@ -4088,7 +4108,10 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4088
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.",
4089
4109
  type: "string"
4090
4110
  },
4091
- 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
+ },
4092
4115
  underLabelFontSize: {
4093
4116
  default: 12,
4094
4117
  description: "Specify the font size (px) for the under label text.",
@@ -4120,7 +4143,11 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4120
4143
  pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
4121
4144
  type: "string"
4122
4145
  },
4123
- icon: { default: "default", description: "Specify an icon.", type: "string" },
4146
+ icon: {
4147
+ default: "default",
4148
+ description: "Specify an icon.",
4149
+ type: "string"
4150
+ },
4124
4151
  iconColor: {
4125
4152
  default: null,
4126
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)".',
@@ -4251,7 +4278,10 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4251
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.",
4252
4279
  type: "string"
4253
4280
  },
4254
- 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
+ },
4255
4285
  unit: {
4256
4286
  description: "Specify text to show next to the major value.",
4257
4287
  type: "string"
@@ -4420,7 +4450,10 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4420
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.",
4421
4451
  type: "string"
4422
4452
  },
4423
- 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
+ },
4424
4457
  unit: {
4425
4458
  description: "Specify text to show next to the major value.",
4426
4459
  type: "string"
@@ -4473,7 +4506,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4473
4506
  oneOf: [
4474
4507
  { type: "string" },
4475
4508
  { type: "number" },
4476
- { type: "array", items: { type: ["string", "number"] } }
4509
+ {
4510
+ type: "array",
4511
+ items: { type: ["string", "number"] }
4512
+ }
4477
4513
  ]
4478
4514
  }
4479
4515
  },
@@ -4636,7 +4672,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4636
4672
  oneOf: [
4637
4673
  { type: "string" },
4638
4674
  { type: "number" },
4639
- { type: "array", items: { type: ["string", "number"] } }
4675
+ {
4676
+ type: "array",
4677
+ items: { type: ["string", "number"] }
4678
+ }
4640
4679
  ]
4641
4680
  }
4642
4681
  }