@splunk/visualization-schemas 27.3.0 → 27.5.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
@@ -416,6 +416,12 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
416
416
  description: "Specify the field to map to the y-axis.",
417
417
  type: "string"
418
418
  },
419
+ additionalTooltipFields: {
420
+ default: [],
421
+ description: "Specify the fields to add to the default set of tooltips. Tooltips appear when you hover over events. These fields and their corresponding values are shown in addition to the ones displayed by default.",
422
+ type: "array",
423
+ items: { type: "string" }
424
+ },
419
425
  annotationColor: {
420
426
  description: `Specify the annotation colors. For example, [\u201C#FF0000\u201D, \u201C#0000FF", \u201C#008000\u201D]. You can use a data source or a hexadecimal code to apply the color.`,
421
427
  type: "array",
@@ -885,6 +891,12 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
885
891
  type: "string"
886
892
  }
887
893
  },
894
+ additionalTooltipFields: {
895
+ default: [],
896
+ description: "Specify the fields to add to the default set of tooltips. Tooltips appear when you hover over events. These fields and their corresponding values are shown in addition to the ones displayed by default.",
897
+ type: "array",
898
+ items: { type: "string" }
899
+ },
888
900
  backgroundColor: {
889
901
  default: "> themes.defaultBackgroundColor",
890
902
  description: "Specify the color used for the background. You can use a data source or hexadecimal code to apply the color.",
@@ -1656,6 +1668,12 @@ var columnOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1656
1668
  type: "string"
1657
1669
  }
1658
1670
  },
1671
+ additionalTooltipFields: {
1672
+ default: [],
1673
+ description: "Specify the fields to add to the default set of tooltips. Tooltips appear when you hover over events. These fields and their corresponding values are shown in addition to the ones displayed by default.",
1674
+ type: "array",
1675
+ items: { type: "string" }
1676
+ },
1659
1677
  annotationColor: {
1660
1678
  description: `Specify the annotation colors. For example, [\u201C#FF0000\u201D, \u201C#0000FF", \u201C#008000\u201D]. You can use a data source or hexadecimal code to apply the color.`,
1661
1679
  type: "array",
@@ -2318,6 +2336,12 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2318
2336
  description: "Specify the field that should be mapped to the y-axis.",
2319
2337
  type: "string"
2320
2338
  },
2339
+ additionalTooltipFields: {
2340
+ default: [],
2341
+ description: "Specify the fields to add to the default set of tooltips. Tooltips appear when you hover over events. These fields and their corresponding values are shown in addition to the ones displayed by default.",
2342
+ type: "array",
2343
+ items: { type: "string" }
2344
+ },
2321
2345
  annotationColor: {
2322
2346
  description: `Specify the annotation colors. You may use a dataSource to apply the color. For example, [\u201C#FF0000\u201D, \u201C#0000FF", \u201C#008000\u201D].`,
2323
2347
  type: "array",
@@ -2946,7 +2970,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2946
2970
  },
2947
2971
  dataValues: {
2948
2972
  description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
2949
- type: ["string"],
2973
+ type: ["string", "array"],
2950
2974
  items: { type: "number" },
2951
2975
  default: '> primary | seriesByType("number")'
2952
2976
  },
@@ -2956,6 +2980,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2956
2980
  items: { type: "string" },
2957
2981
  default: []
2958
2982
  },
2983
+ tooltipHeaderField: {
2984
+ description: "Specify the field to add to the tooltip header. Tooltips appear when you hover over data points. Only the value of this field will be displayed as the header.",
2985
+ type: "string"
2986
+ },
2959
2987
  resultLimit: {
2960
2988
  description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
2961
2989
  type: "number",
@@ -3000,6 +3028,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3000
3028
  items: { type: "string" },
3001
3029
  default: []
3002
3030
  },
3031
+ tooltipHeaderField: {
3032
+ description: "Specify the field to add to the tooltip header. Tooltips appear when you hover over data points. Only the value of this field will be displayed as the header.",
3033
+ type: "string"
3034
+ },
3003
3035
  resultLimit: {
3004
3036
  description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
3005
3037
  type: "number",
@@ -3074,7 +3106,7 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3074
3106
  },
3075
3107
  dataValues: {
3076
3108
  description: 'Specify the data series used to encode colors for dynamic coloring in layers of type "marker" or "bubble".',
3077
- type: ["string"],
3109
+ type: ["string", "array"],
3078
3110
  items: { type: "number" },
3079
3111
  default: '> primary | seriesByType("number")'
3080
3112
  },
@@ -3084,6 +3116,10 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3084
3116
  items: { type: "string" },
3085
3117
  default: []
3086
3118
  },
3119
+ tooltipHeaderField: {
3120
+ description: "Specify the field to add to the tooltip header. Tooltips appear when you hover over data points. Only the value of this field will be displayed as the header.",
3121
+ type: "string"
3122
+ },
3087
3123
  resultLimit: {
3088
3124
  description: "Specify the maximum number of data points to render on the map. Adjust the value to improve performance.",
3089
3125
  type: "number",
@@ -3118,6 +3154,16 @@ var mapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3118
3154
  zoom: {
3119
3155
  description: "Specify the zoom level of the map.",
3120
3156
  type: "number"
3157
+ },
3158
+ showCoordinates: {
3159
+ default: true,
3160
+ type: "boolean",
3161
+ description: "Specify whether to display coordinates (latitude and longitude) in the tooltip."
3162
+ },
3163
+ icon: {
3164
+ default: "",
3165
+ type: "string",
3166
+ description: 'Specify the url for an svg to display an icon inside bubbles for map. This applies to layers where type: "bubble".'
3121
3167
  }
3122
3168
  });
3123
3169
 
@@ -3328,6 +3374,47 @@ var pieOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3328
3374
  description: "Specify whether the pie should be a donut.",
3329
3375
  type: "boolean"
3330
3376
  },
3377
+ splitByLayout: {
3378
+ default: "off",
3379
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
3380
+ type: "string",
3381
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
3382
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
3383
+ },
3384
+ trellisBackgroundColor: {
3385
+ default: "> themes.defaultBackgroundColor",
3386
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
3387
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
3388
+ type: "string"
3389
+ },
3390
+ trellisColumns: {
3391
+ 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.",
3392
+ type: "number",
3393
+ minimum: 1,
3394
+ default: 3
3395
+ },
3396
+ trellisMinColumnWidth: {
3397
+ default: 250,
3398
+ minimum: 1,
3399
+ 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.",
3400
+ type: "number"
3401
+ },
3402
+ trellisPageCount: {
3403
+ default: 20,
3404
+ minimum: 1,
3405
+ 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.",
3406
+ type: "number"
3407
+ },
3408
+ trellisRowHeight: {
3409
+ default: 180,
3410
+ minimum: 1,
3411
+ 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.",
3412
+ type: "number"
3413
+ },
3414
+ trellisSplitBy: {
3415
+ 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.",
3416
+ type: "string"
3417
+ },
3331
3418
  value: {
3332
3419
  description: "List of numerical values to power the pie chart.",
3333
3420
  type: "array",
@@ -3615,8 +3702,7 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3615
3702
  type: "string"
3616
3703
  },
3617
3704
  legendDisplay: {
3618
- default: "right",
3619
- description: "Specify the location of the legend on the panel.",
3705
+ description: "Specify the location of the legend on the panel. By default, legendDisplay is off when splitByLayout is trellis, and right otherwise. ",
3620
3706
  pattern: getPattern(["right", "left", "top", "bottom", "off"]),
3621
3707
  type: "string"
3622
3708
  },
@@ -3692,6 +3778,52 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3692
3778
  description: "Specify whether minor grid lines are visible on the y-axis.",
3693
3779
  type: "boolean"
3694
3780
  },
3781
+ splitByLayout: {
3782
+ default: "off",
3783
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
3784
+ type: "string",
3785
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
3786
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
3787
+ },
3788
+ trellisBackgroundColor: {
3789
+ default: "> themes.defaultBackgroundColor",
3790
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
3791
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
3792
+ type: "string"
3793
+ },
3794
+ trellisColumns: {
3795
+ 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.",
3796
+ type: "number",
3797
+ minimum: 1,
3798
+ default: 3
3799
+ },
3800
+ trellisMinColumnWidth: {
3801
+ default: 250,
3802
+ minimum: 1,
3803
+ 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.",
3804
+ type: "number"
3805
+ },
3806
+ trellisPageCount: {
3807
+ default: 20,
3808
+ minimum: 1,
3809
+ 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.",
3810
+ type: "number"
3811
+ },
3812
+ trellisRowHeight: {
3813
+ default: 180,
3814
+ minimum: 1,
3815
+ 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.",
3816
+ type: "number"
3817
+ },
3818
+ trellisSharedScale: {
3819
+ default: true,
3820
+ type: "boolean",
3821
+ description: "Specify whether all visualizations will share the same scale in the trellis container."
3822
+ },
3823
+ trellisSplitBy: {
3824
+ 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.",
3825
+ type: "string"
3826
+ },
3695
3827
  xAxisLabelRotation: {
3696
3828
  default: 0,
3697
3829
  description: "Specify the rotation of the x-axis labels in degrees.",