@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/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 && { properties: enhanceOptionsSchemaWithDynamicOptions(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({ [opt]: patternProperties[opt] }));
375
+ enhancedPatternProperties = __spreadValues(__spreadValues({}, enhancedPatternProperties), enhanceOptionsSchemaWithDynamicOptions({
376
+ [opt]: patternProperties[opt]
377
+ }));
374
378
  });
375
379
  enhancedOptionsSchema[key].patternProperties = enhancedPatternProperties;
376
380
  }
@@ -2132,7 +2136,7 @@ var ellipseOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2132
2136
  },
2133
2137
  strokeWidth: {
2134
2138
  default: 1,
2135
- description: "Specify the width of the stroke, in pixels, in the range of 1 - 25 (inclusive).",
2139
+ description: "Specify the width of the stroke, in pixels. The minimum value is 0.",
2136
2140
  type: "number"
2137
2141
  }
2138
2142
  });
@@ -2959,7 +2963,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2959
2963
  seriesColors: {
2960
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".',
2961
2965
  type: "array",
2962
- items: { type: "string", pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA },
2966
+ items: {
2967
+ type: "string",
2968
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
2969
+ },
2963
2970
  default: visualization_color_palettes_exports.VIZ_CATEGORICAL
2964
2971
  },
2965
2972
  dataColors: {
@@ -3095,7 +3102,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3095
3102
  seriesColors: {
3096
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".',
3097
3104
  type: "array",
3098
- items: { type: "string", pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA },
3105
+ items: {
3106
+ type: "string",
3107
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3108
+ },
3099
3109
  default: visualization_color_palettes_exports.VIZ_CATEGORICAL
3100
3110
  },
3101
3111
  dataColors: {
@@ -3606,7 +3616,7 @@ var rectangleOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3606
3616
  default: 1
3607
3617
  },
3608
3618
  strokeWidth: {
3609
- description: "Specify the width of the stroke, in pixels, in the range of 1 - 25 (inclusive).",
3619
+ description: "Specify the width of the stroke, in pixels. The minimum value is 0.",
3610
3620
  type: "number",
3611
3621
  default: 1
3612
3622
  }
@@ -3626,6 +3636,12 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3626
3636
  pattern: getPattern(["categorical", "dynamic"]),
3627
3637
  type: "string"
3628
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
+ },
3629
3645
  linkColors: {
3630
3646
  default: `> linkValues | rangeValue(linkColorRangeConfig)`,
3631
3647
  description: "Specify the coloring method used for the links when the colorMode \u201Cdynamic\u201D is specified.",
@@ -3657,6 +3673,10 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3657
3673
  items: {
3658
3674
  type: "string"
3659
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"
3660
3680
  }
3661
3681
  });
3662
3682
 
@@ -4152,7 +4172,10 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4152
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.",
4153
4173
  type: "string"
4154
4174
  },
4155
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4175
+ underLabel: {
4176
+ description: "Specify the text that appears below the major value.",
4177
+ type: "string"
4178
+ },
4156
4179
  underLabelFontSize: {
4157
4180
  default: 12,
4158
4181
  description: "Specify the font size (px) for the under label text.",
@@ -4184,7 +4207,11 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4184
4207
  pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
4185
4208
  type: "string"
4186
4209
  },
4187
- icon: { default: "default", description: "Specify an icon.", type: "string" },
4210
+ icon: {
4211
+ default: "default",
4212
+ description: "Specify an icon.",
4213
+ type: "string"
4214
+ },
4188
4215
  iconColor: {
4189
4216
  default: null,
4190
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)".',
@@ -4315,7 +4342,10 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4315
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.",
4316
4343
  type: "string"
4317
4344
  },
4318
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4345
+ underLabel: {
4346
+ description: "Specify the text that appears below the major value.",
4347
+ type: "string"
4348
+ },
4319
4349
  unit: {
4320
4350
  description: "Specify text to show next to the major value.",
4321
4351
  type: "string"
@@ -4484,7 +4514,10 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4484
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.",
4485
4515
  type: "string"
4486
4516
  },
4487
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4517
+ underLabel: {
4518
+ description: "Specify the text that appears below the major value.",
4519
+ type: "string"
4520
+ },
4488
4521
  unit: {
4489
4522
  description: "Specify text to show next to the major value.",
4490
4523
  type: "string"
@@ -4537,7 +4570,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4537
4570
  oneOf: [
4538
4571
  { type: "string" },
4539
4572
  { type: "number" },
4540
- { type: "array", items: { type: ["string", "number"] } }
4573
+ {
4574
+ type: "array",
4575
+ items: { type: ["string", "number"] }
4576
+ }
4541
4577
  ]
4542
4578
  }
4543
4579
  },
@@ -4700,7 +4736,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4700
4736
  oneOf: [
4701
4737
  { type: "string" },
4702
4738
  { type: "number" },
4703
- { type: "array", items: { type: ["string", "number"] } }
4739
+ {
4740
+ type: "array",
4741
+ items: { type: ["string", "number"] }
4742
+ }
4704
4743
  ]
4705
4744
  }
4706
4745
  }