@splunk/visualization-schemas 27.5.0 → 28.1.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
  });
@@ -2281,6 +2285,47 @@ var fillerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2281
2285
  pattern: getPattern(["vertical", "horizontal"]),
2282
2286
  type: "string"
2283
2287
  },
2288
+ splitByLayout: {
2289
+ default: "off",
2290
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
2291
+ type: "string",
2292
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
2293
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
2294
+ },
2295
+ trellisBackgroundColor: {
2296
+ default: "> themes.defaultBackgroundColor",
2297
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
2298
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
2299
+ type: "string"
2300
+ },
2301
+ trellisColumns: {
2302
+ 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.",
2303
+ type: "number",
2304
+ minimum: 1,
2305
+ default: 3
2306
+ },
2307
+ trellisMinColumnWidth: {
2308
+ default: 200,
2309
+ minimum: 1,
2310
+ 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.",
2311
+ type: "number"
2312
+ },
2313
+ trellisPageCount: {
2314
+ default: 20,
2315
+ minimum: 1,
2316
+ 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.",
2317
+ type: "number"
2318
+ },
2319
+ trellisRowHeight: {
2320
+ default: 200,
2321
+ minimum: 1,
2322
+ 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.",
2323
+ type: "number"
2324
+ },
2325
+ trellisSplitBy: {
2326
+ 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.",
2327
+ type: "string"
2328
+ },
2284
2329
  value: {
2285
2330
  default: '> primary | seriesByType("number") | lastPoint()',
2286
2331
  description: "Specify the dataSource applied to the value of the filler gauge.",
@@ -2959,7 +3004,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2959
3004
  seriesColors: {
2960
3005
  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
3006
  type: "array",
2962
- items: { type: "string", pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA },
3007
+ items: {
3008
+ type: "string",
3009
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3010
+ },
2963
3011
  default: visualization_color_palettes_exports.VIZ_CATEGORICAL
2964
3012
  },
2965
3013
  dataColors: {
@@ -3095,7 +3143,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3095
3143
  seriesColors: {
3096
3144
  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
3145
  type: "array",
3098
- items: { type: "string", pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA },
3146
+ items: {
3147
+ type: "string",
3148
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3149
+ },
3099
3150
  default: visualization_color_palettes_exports.VIZ_CATEGORICAL
3100
3151
  },
3101
3152
  dataColors: {
@@ -3606,7 +3657,7 @@ var rectangleOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3606
3657
  default: 1
3607
3658
  },
3608
3659
  strokeWidth: {
3609
- description: "Specify the width of the stroke, in pixels, in the range of 1 - 25 (inclusive).",
3660
+ description: "Specify the width of the stroke, in pixels. The minimum value is 0.",
3610
3661
  type: "number",
3611
3662
  default: 1
3612
3663
  }
@@ -3626,6 +3677,12 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3626
3677
  pattern: getPattern(["categorical", "dynamic"]),
3627
3678
  type: "string"
3628
3679
  },
3680
+ labelDisplay: {
3681
+ default: "off",
3682
+ 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. ",
3683
+ pattern: getPattern(["values", "valuesAndPercentage", "percentage", "off"]),
3684
+ type: "string"
3685
+ },
3629
3686
  linkColors: {
3630
3687
  default: `> linkValues | rangeValue(linkColorRangeConfig)`,
3631
3688
  description: "Specify the coloring method used for the links when the colorMode \u201Cdynamic\u201D is specified.",
@@ -3657,6 +3714,10 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3657
3714
  items: {
3658
3715
  type: "string"
3659
3716
  }
3717
+ },
3718
+ unit: {
3719
+ description: 'Specify text to show on the left of the value in the node label when "labelDisplay" is set to either "values" or "valuesAndPercentage"',
3720
+ type: "string"
3660
3721
  }
3661
3722
  });
3662
3723
 
@@ -4152,7 +4213,10 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4152
4213
  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
4214
  type: "string"
4154
4215
  },
4155
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4216
+ underLabel: {
4217
+ description: "Specify the text that appears below the major value.",
4218
+ type: "string"
4219
+ },
4156
4220
  underLabelFontSize: {
4157
4221
  default: 12,
4158
4222
  description: "Specify the font size (px) for the under label text.",
@@ -4184,7 +4248,11 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4184
4248
  pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
4185
4249
  type: "string"
4186
4250
  },
4187
- icon: { default: "default", description: "Specify an icon.", type: "string" },
4251
+ icon: {
4252
+ default: "default",
4253
+ description: "Specify an icon.",
4254
+ type: "string"
4255
+ },
4188
4256
  iconColor: {
4189
4257
  default: null,
4190
4258
  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 +4383,10 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4315
4383
  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
4384
  type: "string"
4317
4385
  },
4318
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4386
+ underLabel: {
4387
+ description: "Specify the text that appears below the major value.",
4388
+ type: "string"
4389
+ },
4319
4390
  unit: {
4320
4391
  description: "Specify text to show next to the major value.",
4321
4392
  type: "string"
@@ -4484,7 +4555,10 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4484
4555
  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
4556
  type: "string"
4486
4557
  },
4487
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4558
+ underLabel: {
4559
+ description: "Specify the text that appears below the major value.",
4560
+ type: "string"
4561
+ },
4488
4562
  unit: {
4489
4563
  description: "Specify text to show next to the major value.",
4490
4564
  type: "string"
@@ -4537,7 +4611,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4537
4611
  oneOf: [
4538
4612
  { type: "string" },
4539
4613
  { type: "number" },
4540
- { type: "array", items: { type: ["string", "number"] } }
4614
+ {
4615
+ type: "array",
4616
+ items: { type: ["string", "number"] }
4617
+ }
4541
4618
  ]
4542
4619
  }
4543
4620
  },
@@ -4638,6 +4715,16 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4638
4715
  description: "Specify the data source key for pagination and sorting.",
4639
4716
  type: "string"
4640
4717
  },
4718
+ showFooterPercentages: {
4719
+ default: false,
4720
+ description: "Specify whether to show a row at the bottom of the table that displays percentage values for applicable columns.",
4721
+ type: "boolean"
4722
+ },
4723
+ showFooterTotals: {
4724
+ default: false,
4725
+ description: "Specify whether to show a row at the bottom of the table that displays total values for applicable columns.",
4726
+ type: "boolean"
4727
+ },
4641
4728
  showInternalFields: {
4642
4729
  default: true,
4643
4730
  description: "Specify whether to show internal fields that start with an underscore. The _time field will still be shown if false.",
@@ -4700,7 +4787,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4700
4787
  oneOf: [
4701
4788
  { type: "string" },
4702
4789
  { type: "number" },
4703
- { type: "array", items: { type: ["string", "number"] } }
4790
+ {
4791
+ type: "array",
4792
+ items: { type: ["string", "number"] }
4793
+ }
4704
4794
  ]
4705
4795
  }
4706
4796
  }