@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/cjs/index.js CHANGED
@@ -917,6 +917,11 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
917
917
  pattern: getPattern(["standard", "seriesCompare"]),
918
918
  type: "string"
919
919
  },
920
+ legendReversed: {
921
+ default: "false",
922
+ description: "Specify whether to reverse the order of the legend items.",
923
+ type: "boolean"
924
+ },
920
925
  legendTruncation: {
921
926
  default: "ellipsisEnd",
922
927
  description: "Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis.",
@@ -3113,6 +3118,11 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3113
3118
  zoom: {
3114
3119
  description: "Specify the zoom level of the map.",
3115
3120
  type: "number"
3121
+ },
3122
+ showCoordinates: {
3123
+ default: true,
3124
+ type: "boolean",
3125
+ description: "Specify whether to display coordinates (latitude and longitude) in the tooltip."
3116
3126
  }
3117
3127
  });
3118
3128
 
@@ -3323,6 +3333,47 @@ var pieOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3323
3333
  description: "Specify whether the pie should be a donut.",
3324
3334
  type: "boolean"
3325
3335
  },
3336
+ splitByLayout: {
3337
+ default: "off",
3338
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
3339
+ type: "string",
3340
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
3341
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
3342
+ },
3343
+ trellisBackgroundColor: {
3344
+ default: "> themes.defaultBackgroundColor",
3345
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
3346
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
3347
+ type: "string"
3348
+ },
3349
+ trellisColumns: {
3350
+ 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.",
3351
+ type: "number",
3352
+ minimum: 1,
3353
+ default: 3
3354
+ },
3355
+ trellisMinColumnWidth: {
3356
+ default: 250,
3357
+ minimum: 1,
3358
+ 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.",
3359
+ type: "number"
3360
+ },
3361
+ trellisPageCount: {
3362
+ default: 20,
3363
+ minimum: 1,
3364
+ 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.",
3365
+ type: "number"
3366
+ },
3367
+ trellisRowHeight: {
3368
+ default: 180,
3369
+ minimum: 1,
3370
+ 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.",
3371
+ type: "number"
3372
+ },
3373
+ trellisSplitBy: {
3374
+ 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.",
3375
+ type: "string"
3376
+ },
3326
3377
  value: {
3327
3378
  description: "List of numerical values to power the pie chart.",
3328
3379
  type: "array",
@@ -3610,8 +3661,7 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3610
3661
  type: "string"
3611
3662
  },
3612
3663
  legendDisplay: {
3613
- default: "right",
3614
- description: "Specify the location of the legend on the panel.",
3664
+ description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. ",
3615
3665
  pattern: getPattern(["right", "left", "top", "bottom", "off"]),
3616
3666
  type: "string"
3617
3667
  },
@@ -3687,6 +3737,52 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3687
3737
  description: "Specify whether minor grid lines are visible on the y-axis.",
3688
3738
  type: "boolean"
3689
3739
  },
3740
+ splitByLayout: {
3741
+ default: "off",
3742
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
3743
+ type: "string",
3744
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
3745
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
3746
+ },
3747
+ trellisBackgroundColor: {
3748
+ default: "> themes.defaultBackgroundColor",
3749
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
3750
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
3751
+ type: "string"
3752
+ },
3753
+ trellisColumns: {
3754
+ 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.",
3755
+ type: "number",
3756
+ minimum: 1,
3757
+ default: 3
3758
+ },
3759
+ trellisMinColumnWidth: {
3760
+ default: 250,
3761
+ minimum: 1,
3762
+ 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.",
3763
+ type: "number"
3764
+ },
3765
+ trellisPageCount: {
3766
+ default: 20,
3767
+ minimum: 1,
3768
+ 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.",
3769
+ type: "number"
3770
+ },
3771
+ trellisRowHeight: {
3772
+ default: 180,
3773
+ minimum: 1,
3774
+ 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.",
3775
+ type: "number"
3776
+ },
3777
+ trellisSharedScale: {
3778
+ default: true,
3779
+ type: "boolean",
3780
+ description: "Specify whether all visualizations will share the same scale in the trellis container."
3781
+ },
3782
+ trellisSplitBy: {
3783
+ 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.",
3784
+ type: "string"
3785
+ },
3690
3786
  xAxisLabelRotation: {
3691
3787
  default: 0,
3692
3788
  description: "Specify the rotation of the x-axis labels in degrees.",