@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/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
  });
@@ -2217,6 +2221,47 @@ var fillerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2217
2221
  pattern: getPattern(["vertical", "horizontal"]),
2218
2222
  type: "string"
2219
2223
  },
2224
+ splitByLayout: {
2225
+ default: "off",
2226
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
2227
+ type: "string",
2228
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
2229
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
2230
+ },
2231
+ trellisBackgroundColor: {
2232
+ default: "> themes.defaultBackgroundColor",
2233
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
2234
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
2235
+ type: "string"
2236
+ },
2237
+ trellisColumns: {
2238
+ 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.",
2239
+ type: "number",
2240
+ minimum: 1,
2241
+ default: 3
2242
+ },
2243
+ trellisMinColumnWidth: {
2244
+ default: 200,
2245
+ minimum: 1,
2246
+ 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.",
2247
+ type: "number"
2248
+ },
2249
+ trellisPageCount: {
2250
+ default: 20,
2251
+ minimum: 1,
2252
+ 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.",
2253
+ type: "number"
2254
+ },
2255
+ trellisRowHeight: {
2256
+ default: 200,
2257
+ minimum: 1,
2258
+ 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.",
2259
+ type: "number"
2260
+ },
2261
+ trellisSplitBy: {
2262
+ 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.",
2263
+ type: "string"
2264
+ },
2220
2265
  value: {
2221
2266
  default: '> primary | seriesByType("number") | lastPoint()',
2222
2267
  description: "Specify the dataSource applied to the value of the filler gauge.",
@@ -2895,7 +2940,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2895
2940
  seriesColors: {
2896
2941
  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
2942
  type: "array",
2898
- items: { type: "string", pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA },
2943
+ items: {
2944
+ type: "string",
2945
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
2946
+ },
2899
2947
  default: visualization_color_palettes_exports.VIZ_CATEGORICAL
2900
2948
  },
2901
2949
  dataColors: {
@@ -3031,7 +3079,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3031
3079
  seriesColors: {
3032
3080
  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
3081
  type: "array",
3034
- items: { type: "string", pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA },
3082
+ items: {
3083
+ type: "string",
3084
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3085
+ },
3035
3086
  default: visualization_color_palettes_exports.VIZ_CATEGORICAL
3036
3087
  },
3037
3088
  dataColors: {
@@ -3542,7 +3593,7 @@ var rectangleOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3542
3593
  default: 1
3543
3594
  },
3544
3595
  strokeWidth: {
3545
- description: "Specify the width of the stroke, in pixels, in the range of 1 - 25 (inclusive).",
3596
+ description: "Specify the width of the stroke, in pixels. The minimum value is 0.",
3546
3597
  type: "number",
3547
3598
  default: 1
3548
3599
  }
@@ -3562,6 +3613,12 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3562
3613
  pattern: getPattern(["categorical", "dynamic"]),
3563
3614
  type: "string"
3564
3615
  },
3616
+ labelDisplay: {
3617
+ default: "off",
3618
+ 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. ",
3619
+ pattern: getPattern(["values", "valuesAndPercentage", "percentage", "off"]),
3620
+ type: "string"
3621
+ },
3565
3622
  linkColors: {
3566
3623
  default: `> linkValues | rangeValue(linkColorRangeConfig)`,
3567
3624
  description: "Specify the coloring method used for the links when the colorMode \u201Cdynamic\u201D is specified.",
@@ -3593,6 +3650,10 @@ var sankeyOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3593
3650
  items: {
3594
3651
  type: "string"
3595
3652
  }
3653
+ },
3654
+ unit: {
3655
+ description: 'Specify text to show on the left of the value in the node label when "labelDisplay" is set to either "values" or "valuesAndPercentage"',
3656
+ type: "string"
3596
3657
  }
3597
3658
  });
3598
3659
 
@@ -4088,7 +4149,10 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4088
4149
  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
4150
  type: "string"
4090
4151
  },
4091
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4152
+ underLabel: {
4153
+ description: "Specify the text that appears below the major value.",
4154
+ type: "string"
4155
+ },
4092
4156
  underLabelFontSize: {
4093
4157
  default: 12,
4094
4158
  description: "Specify the font size (px) for the under label text.",
@@ -4120,7 +4184,11 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4120
4184
  pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
4121
4185
  type: "string"
4122
4186
  },
4123
- icon: { default: "default", description: "Specify an icon.", type: "string" },
4187
+ icon: {
4188
+ default: "default",
4189
+ description: "Specify an icon.",
4190
+ type: "string"
4191
+ },
4124
4192
  iconColor: {
4125
4193
  default: null,
4126
4194
  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 +4319,10 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4251
4319
  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
4320
  type: "string"
4253
4321
  },
4254
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4322
+ underLabel: {
4323
+ description: "Specify the text that appears below the major value.",
4324
+ type: "string"
4325
+ },
4255
4326
  unit: {
4256
4327
  description: "Specify text to show next to the major value.",
4257
4328
  type: "string"
@@ -4420,7 +4491,10 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4420
4491
  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
4492
  type: "string"
4422
4493
  },
4423
- underLabel: { description: "Specify the text that appears below the major value.", type: "string" },
4494
+ underLabel: {
4495
+ description: "Specify the text that appears below the major value.",
4496
+ type: "string"
4497
+ },
4424
4498
  unit: {
4425
4499
  description: "Specify text to show next to the major value.",
4426
4500
  type: "string"
@@ -4473,7 +4547,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4473
4547
  oneOf: [
4474
4548
  { type: "string" },
4475
4549
  { type: "number" },
4476
- { type: "array", items: { type: ["string", "number"] } }
4550
+ {
4551
+ type: "array",
4552
+ items: { type: ["string", "number"] }
4553
+ }
4477
4554
  ]
4478
4555
  }
4479
4556
  },
@@ -4574,6 +4651,16 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4574
4651
  description: "Specify the data source key for pagination and sorting.",
4575
4652
  type: "string"
4576
4653
  },
4654
+ showFooterPercentages: {
4655
+ default: false,
4656
+ description: "Specify whether to show a row at the bottom of the table that displays percentage values for applicable columns.",
4657
+ type: "boolean"
4658
+ },
4659
+ showFooterTotals: {
4660
+ default: false,
4661
+ description: "Specify whether to show a row at the bottom of the table that displays total values for applicable columns.",
4662
+ type: "boolean"
4663
+ },
4577
4664
  showInternalFields: {
4578
4665
  default: true,
4579
4666
  description: "Specify whether to show internal fields that start with an underscore. The _time field will still be shown if false.",
@@ -4636,7 +4723,10 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4636
4723
  oneOf: [
4637
4724
  { type: "string" },
4638
4725
  { type: "number" },
4639
- { type: "array", items: { type: ["string", "number"] } }
4726
+ {
4727
+ type: "array",
4728
+ items: { type: ["string", "number"] }
4729
+ }
4640
4730
  ]
4641
4731
  }
4642
4732
  }