@splunk/visualization-schemas 27.2.1 → 27.4.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.
Files changed (37) hide show
  1. package/dist/cjs/index.js +98 -2
  2. package/dist/cjs/index.js.map +2 -2
  3. package/dist/esm/index.js +98 -2
  4. package/dist/esm/index.js.map +2 -2
  5. package/dist/types/index.d.ts +4 -0
  6. package/dist/types/optionsSchemas/area.d.ts +1 -0
  7. package/dist/types/optionsSchemas/bar.d.ts +1 -0
  8. package/dist/types/optionsSchemas/bubble.d.ts +1 -0
  9. package/dist/types/optionsSchemas/choroplethSvg.d.ts +1 -0
  10. package/dist/types/optionsSchemas/column.d.ts +1 -0
  11. package/dist/types/optionsSchemas/ellipse.d.ts +1 -0
  12. package/dist/types/optionsSchemas/events.d.ts +1 -0
  13. package/dist/types/optionsSchemas/fillerGauge.d.ts +1 -0
  14. package/dist/types/optionsSchemas/image.d.ts +1 -0
  15. package/dist/types/optionsSchemas/index.d.ts +25 -0
  16. package/dist/types/optionsSchemas/line.d.ts +1 -0
  17. package/dist/types/optionsSchemas/linkGraph.d.ts +1 -0
  18. package/dist/types/optionsSchemas/map.d.ts +1 -0
  19. package/dist/types/optionsSchemas/markdown.d.ts +1 -0
  20. package/dist/types/optionsSchemas/markerGauge.d.ts +1 -0
  21. package/dist/types/optionsSchemas/parallelCoordinates.d.ts +1 -0
  22. package/dist/types/optionsSchemas/pie.d.ts +1 -0
  23. package/dist/types/optionsSchemas/punchcard.d.ts +1 -0
  24. package/dist/types/optionsSchemas/rectangle.d.ts +1 -0
  25. package/dist/types/optionsSchemas/sankey.d.ts +1 -0
  26. package/dist/types/optionsSchemas/scatter.d.ts +1 -0
  27. package/dist/types/optionsSchemas/singleValue.d.ts +1 -0
  28. package/dist/types/optionsSchemas/singleValueIcon.d.ts +1 -0
  29. package/dist/types/optionsSchemas/singleValueRadial.d.ts +1 -0
  30. package/dist/types/optionsSchemas/table.d.ts +1 -0
  31. package/dist/types/optionsSchemas/timeline.d.ts +1 -0
  32. package/dist/types/types/index.d.ts +4 -0
  33. package/dist/types/utils/constants.d.ts +24 -0
  34. package/dist/types/utils/enhanceSchemaWithDynamicOptions.d.ts +8 -0
  35. package/dist/types/utils/index.d.ts +3 -0
  36. package/dist/types/utils/schemaUtils.d.ts +244 -0
  37. package/package.json +8 -9
package/dist/esm/index.js CHANGED
@@ -853,6 +853,11 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
853
853
  pattern: getPattern(["standard", "seriesCompare"]),
854
854
  type: "string"
855
855
  },
856
+ legendReversed: {
857
+ default: "false",
858
+ description: "Specify whether to reverse the order of the legend items.",
859
+ type: "boolean"
860
+ },
856
861
  legendTruncation: {
857
862
  default: "ellipsisEnd",
858
863
  description: "Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis.",
@@ -3049,6 +3054,11 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3049
3054
  zoom: {
3050
3055
  description: "Specify the zoom level of the map.",
3051
3056
  type: "number"
3057
+ },
3058
+ showCoordinates: {
3059
+ default: true,
3060
+ type: "boolean",
3061
+ description: "Specify whether to display coordinates (latitude and longitude) in the tooltip."
3052
3062
  }
3053
3063
  });
3054
3064
 
@@ -3259,6 +3269,47 @@ var pieOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3259
3269
  description: "Specify whether the pie should be a donut.",
3260
3270
  type: "boolean"
3261
3271
  },
3272
+ splitByLayout: {
3273
+ default: "off",
3274
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
3275
+ type: "string",
3276
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
3277
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
3278
+ },
3279
+ trellisBackgroundColor: {
3280
+ default: "> themes.defaultBackgroundColor",
3281
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
3282
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
3283
+ type: "string"
3284
+ },
3285
+ trellisColumns: {
3286
+ 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.",
3287
+ type: "number",
3288
+ minimum: 1,
3289
+ default: 3
3290
+ },
3291
+ trellisMinColumnWidth: {
3292
+ default: 250,
3293
+ minimum: 1,
3294
+ 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.",
3295
+ type: "number"
3296
+ },
3297
+ trellisPageCount: {
3298
+ default: 20,
3299
+ minimum: 1,
3300
+ 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.",
3301
+ type: "number"
3302
+ },
3303
+ trellisRowHeight: {
3304
+ default: 180,
3305
+ minimum: 1,
3306
+ 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.",
3307
+ type: "number"
3308
+ },
3309
+ trellisSplitBy: {
3310
+ 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.",
3311
+ type: "string"
3312
+ },
3262
3313
  value: {
3263
3314
  description: "List of numerical values to power the pie chart.",
3264
3315
  type: "array",
@@ -3546,8 +3597,7 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3546
3597
  type: "string"
3547
3598
  },
3548
3599
  legendDisplay: {
3549
- default: "right",
3550
- description: "Specify the location of the legend on the panel.",
3600
+ description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. ",
3551
3601
  pattern: getPattern(["right", "left", "top", "bottom", "off"]),
3552
3602
  type: "string"
3553
3603
  },
@@ -3623,6 +3673,52 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3623
3673
  description: "Specify whether minor grid lines are visible on the y-axis.",
3624
3674
  type: "boolean"
3625
3675
  },
3676
+ splitByLayout: {
3677
+ default: "off",
3678
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
3679
+ type: "string",
3680
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
3681
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
3682
+ },
3683
+ trellisBackgroundColor: {
3684
+ default: "> themes.defaultBackgroundColor",
3685
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
3686
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
3687
+ type: "string"
3688
+ },
3689
+ trellisColumns: {
3690
+ 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.",
3691
+ type: "number",
3692
+ minimum: 1,
3693
+ default: 3
3694
+ },
3695
+ trellisMinColumnWidth: {
3696
+ default: 250,
3697
+ minimum: 1,
3698
+ 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.",
3699
+ type: "number"
3700
+ },
3701
+ trellisPageCount: {
3702
+ default: 20,
3703
+ minimum: 1,
3704
+ 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.",
3705
+ type: "number"
3706
+ },
3707
+ trellisRowHeight: {
3708
+ default: 180,
3709
+ minimum: 1,
3710
+ 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.",
3711
+ type: "number"
3712
+ },
3713
+ trellisSharedScale: {
3714
+ default: true,
3715
+ type: "boolean",
3716
+ description: "Specify whether all visualizations will share the same scale in the trellis container."
3717
+ },
3718
+ trellisSplitBy: {
3719
+ 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 `stats` command is used, this may default to the first string field.",
3720
+ type: "string"
3721
+ },
3626
3722
  xAxisLabelRotation: {
3627
3723
  default: 0,
3628
3724
  description: "Specify the rotation of the x-axis labels in degrees.",