@splunk/visualization-schemas 28.3.0 → 28.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.
package/dist/esm/index.js CHANGED
@@ -1200,25 +1200,21 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1200
1200
  description: "Specify the spacing unit between major tick marks along the numeric second y-axis.",
1201
1201
  type: ["string", "number"]
1202
1202
  },
1203
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
1204
1203
  yAxisMax: {
1205
1204
  default: "auto",
1206
1205
  description: "Specify the largest value to display in the visible y-axis range.",
1207
1206
  type: ["string", "number"]
1208
1207
  },
1209
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
1210
1208
  y2AxisMax: {
1211
1209
  default: "auto",
1212
1210
  description: "Specify the largest value to display in the visible second y-axis range.",
1213
1211
  type: ["string", "number"]
1214
1212
  },
1215
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
1216
1213
  yAxisMin: {
1217
1214
  default: "auto",
1218
1215
  description: "Specify the smallest value for the visible y-axis range.",
1219
1216
  type: ["string", "number"]
1220
1217
  },
1221
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
1222
1218
  y2AxisMin: {
1223
1219
  default: "auto",
1224
1220
  description: "Specify the smallest value for the visible second y-axis range.",
@@ -1359,7 +1355,6 @@ var bubbleOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1359
1355
  description: "Specify whether to round x-axis values to the nearest integer.",
1360
1356
  type: "boolean"
1361
1357
  },
1362
- // TODO: figure out if we want to change splunk-charting behavior for Bubble/Scatter, which hardcodes XMajorGridlines to false
1363
1358
  // showXMajorGridLines: {
1364
1359
  // default: false,
1365
1360
  // description: 'Specify whether major grid lines are visible on the x-axis.',
@@ -2699,25 +2694,21 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2699
2694
  description: "Specify the spacing unit between major tick marks along the numeric y2-axis.",
2700
2695
  type: ["string", "number"]
2701
2696
  },
2702
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
2703
2697
  yAxisMax: {
2704
2698
  default: "auto",
2705
2699
  description: "Specify the maximum number for the visible y-axis range.",
2706
2700
  type: ["string", "number"]
2707
2701
  },
2708
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
2709
2702
  y2AxisMax: {
2710
2703
  default: "auto",
2711
2704
  description: "Specify the maximum number for the visible y2-axis range.",
2712
2705
  type: ["string", "number"]
2713
2706
  },
2714
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
2715
2707
  yAxisMin: {
2716
2708
  default: "auto",
2717
2709
  description: "Specify the minimum number for the visible y-axis range.",
2718
2710
  type: ["string", "number"]
2719
2711
  },
2720
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
2721
2712
  y2AxisMin: {
2722
2713
  default: "auto",
2723
2714
  description: "Specify the minimum number for the visible y2-axis range.",
@@ -2735,7 +2726,6 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2735
2726
  pattern: getPattern(["linear", "log"]),
2736
2727
  type: "string"
2737
2728
  },
2738
- // TODO: Figure out a way to explicitly support string value in addition to an array of strings
2739
2729
  // as UDF won't allow users to proceed if a string value is entered due to schema validation
2740
2730
  overlayFields: {
2741
2731
  description: "Specify field(s) that should be differentiated on the chart and displayed as chart overlays.",
@@ -2803,6 +2793,12 @@ var linkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2803
2793
  type: "string",
2804
2794
  default: "> nodeColor | maxContrast(nodeTextColorMaxContrast)"
2805
2795
  },
2796
+ nodeLabelOverflow: {
2797
+ description: 'Controls how the text should be truncated within a particular column. Valid types include "anywhere", "break-word", "ellipsis". Columns and Headers are "break-word" styled by default when "textOverflow" is not configured.',
2798
+ type: "string",
2799
+ pattern: getPattern(validTextOverflows),
2800
+ default: "ellipsis"
2801
+ },
2806
2802
  nodeHeight: {
2807
2803
  default: 21,
2808
2804
  description: "Specify, in pixels, the height of each node.",
@@ -3273,6 +3269,310 @@ var markerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3273
3269
  default: "number",
3274
3270
  type: "string",
3275
3271
  pattern: getPattern(["number", "percentage", "off"])
3272
+ },
3273
+ splitByLayout: {
3274
+ default: "off",
3275
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
3276
+ type: "string",
3277
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
3278
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
3279
+ },
3280
+ trellisBackgroundColor: {
3281
+ default: "> themes.defaultBackgroundColor",
3282
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
3283
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
3284
+ type: "string"
3285
+ },
3286
+ trellisColumns: {
3287
+ 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.",
3288
+ type: "number",
3289
+ minimum: 1,
3290
+ default: 3
3291
+ },
3292
+ trellisMinColumnWidth: {
3293
+ default: 200,
3294
+ minimum: 1,
3295
+ 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.",
3296
+ type: "number"
3297
+ },
3298
+ trellisPageCount: {
3299
+ default: 20,
3300
+ minimum: 1,
3301
+ 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.",
3302
+ type: "number"
3303
+ },
3304
+ trellisRowHeight: {
3305
+ default: 200,
3306
+ minimum: 1,
3307
+ 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.",
3308
+ type: "number"
3309
+ },
3310
+ trellisSplitBy: {
3311
+ description: 'Specify the field name of the column with categories used, or "aggregations", 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.',
3312
+ type: "string"
3313
+ }
3314
+ });
3315
+
3316
+ // src/optionsSchemas/networkGraph.ts
3317
+ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3318
+ backgroundColor: {
3319
+ default: "> themes.defaultBackgroundColor",
3320
+ description: 'Specify the color for the background. You may use a dataSource to apply the color. The default for enterprise light is "#ffffff". The default for enterprise dark is "#000000". The default for prisma dark is "#0b0c0e".',
3321
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
3322
+ type: "string"
3323
+ },
3324
+ source: {
3325
+ default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
3326
+ description: "Specify the array of node Ids we are drawing edges from",
3327
+ type: "array",
3328
+ items: {
3329
+ type: "string"
3330
+ }
3331
+ },
3332
+ target: {
3333
+ default: '> primary | frameBySeriesTypes("string") | seriesByIndex(1)',
3334
+ description: "Specify the array of node Ids we are drawing edges to",
3335
+ type: "array",
3336
+ items: {
3337
+ type: "string"
3338
+ }
3339
+ },
3340
+ nodeIds: {
3341
+ default: "> source",
3342
+ description: "Specify the array of node Ids we are using for node styling. By default this is the same as from",
3343
+ type: "array",
3344
+ items: {
3345
+ type: "string"
3346
+ }
3347
+ },
3348
+ nodeTypes: {
3349
+ description: "Specify the array of node types for each node in the from array. Needed for clustering in force algorithm",
3350
+ type: "array",
3351
+ items: {
3352
+ type: "string"
3353
+ }
3354
+ },
3355
+ nodeValues: {
3356
+ default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
3357
+ description: "Specify the array of node values for each node in the from array",
3358
+ type: "array",
3359
+ items: {
3360
+ type: "number"
3361
+ }
3362
+ },
3363
+ nodeTexts: {
3364
+ default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
3365
+ description: "Specify the array of node texts for each node in the from array",
3366
+ type: "array",
3367
+ items: {
3368
+ type: "string"
3369
+ }
3370
+ },
3371
+ nodeColors: {
3372
+ description: "Specify the color used for nodes. You may use a dataSource to apply color dynamically.",
3373
+ type: ["string", "array"],
3374
+ items: {
3375
+ type: "string",
3376
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3377
+ },
3378
+ default: "> themes.defaultNodeColor"
3379
+ },
3380
+ nodeSize: {
3381
+ description: "Specify a number for the diameter of all nodes, or an array of numbers for each node. Values are clamped between 8px and 200px.",
3382
+ type: ["number", "array"],
3383
+ items: {
3384
+ type: "number",
3385
+ minimum: 8,
3386
+ maximum: 200
3387
+ },
3388
+ default: 48
3389
+ },
3390
+ nodeColorValues: {
3391
+ description: "Specify the array of values used for dynamic node coloring.",
3392
+ type: "array",
3393
+ items: {
3394
+ type: ["string", "number"]
3395
+ },
3396
+ default: '> primary | seriesByType("number")'
3397
+ },
3398
+ nodeIcons: {
3399
+ description: "Specify the icon used for nodes. Choose between cylinder, portrait, magnifier, report, servers, code, globe, proxy, alert.",
3400
+ type: "array",
3401
+ items: {
3402
+ type: "string",
3403
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3404
+ }
3405
+ },
3406
+ nodeIconColors: {
3407
+ description: "Specify the color used for node icons. You may use a dataSource to apply color dynamically.",
3408
+ type: ["array", "string"],
3409
+ items: {
3410
+ type: "string",
3411
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3412
+ },
3413
+ default: "> themes.defaultNodeIconColor"
3414
+ },
3415
+ nodeIconColorValues: {
3416
+ description: "Specify the array of values used for dynamic node icon coloring.",
3417
+ type: "array",
3418
+ items: {
3419
+ type: ["string", "number"]
3420
+ },
3421
+ default: '> primary | seriesByType("number")'
3422
+ },
3423
+ linkStyle: {
3424
+ default: "straight",
3425
+ description: "Specify the edge shape used for links. Choose between s, z, c, straight",
3426
+ type: "string",
3427
+ pattern: getPattern(["s", "z", "c", "straight"])
3428
+ },
3429
+ linkColors: {
3430
+ description: "Specify the color used for links. You may use a dataSource to apply color dynamically.",
3431
+ type: ["array", "string"],
3432
+ items: {
3433
+ type: "string",
3434
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3435
+ },
3436
+ default: "> themes.defaultLinkColor"
3437
+ },
3438
+ linkWidth: {
3439
+ description: "Specify a number for the width of all links in pixels, or an array of numbers for each link.",
3440
+ type: ["number", "array"],
3441
+ items: {
3442
+ type: "number",
3443
+ minimum: 1,
3444
+ maximum: 20
3445
+ },
3446
+ default: 2
3447
+ },
3448
+ linkColorValues: {
3449
+ description: "Specify the array of values used for dynamic link coloring.",
3450
+ type: "array",
3451
+ items: {
3452
+ type: ["string", "number"]
3453
+ },
3454
+ default: '> primary | seriesByType("number")'
3455
+ },
3456
+ showDirection: {
3457
+ default: "bidirection",
3458
+ description: "Specify the directionality of the links. Choose between bidirection, oneWay, none. z and s linkStyles look better with bidirection instead of oneWay.",
3459
+ type: "string",
3460
+ pattern: getPattern(["bidirection", "oneWay", "none"])
3461
+ },
3462
+ layout: {
3463
+ default: "grid",
3464
+ description: "Specify the layout used for the graph. Choose between preset, grid, hierarchical",
3465
+ type: "string",
3466
+ pattern: getPattern(["preset", "grid", "hierarchical", "force"])
3467
+ },
3468
+ nodeHorizontalPadding: {
3469
+ default: 0,
3470
+ description: "Specify the additional padding between nodes horizontally in pixels, in the range of 0 - 500.",
3471
+ type: "number"
3472
+ },
3473
+ nodeVerticalPadding: {
3474
+ default: 0,
3475
+ description: "Specify the additional padding between nodes vertically in pixels, in the range of 0 - 500.",
3476
+ type: "number"
3477
+ },
3478
+ gridColumns: {
3479
+ description: 'When layout is "grid", specify the number of nodes to display per row. By default it uses the ceiling of the square root of the total number of nodes',
3480
+ type: "number"
3481
+ },
3482
+ hierarchyDirection: {
3483
+ description: 'When layout is "hierarchical", specify the direction of the hierarchy. Choose between topBottom, bottomTop, leftRight, rightLeft.',
3484
+ default: "leftRight",
3485
+ pattern: getPattern(["topBottom", "bottomTop", "leftRight", "rightLeft"])
3486
+ },
3487
+ chargeStrength: {
3488
+ default: -30,
3489
+ description: 'When layout is "force", specify the strength of the charge between nodes. A higher absolute value results in stronger repulsion, causing nodes to spread out more. Note that this value can be positive or negative, indicating either attraction or repulsion.',
3490
+ type: "number"
3491
+ },
3492
+ chargeTheta: {
3493
+ default: 0.9,
3494
+ description: 'When layout is "force", specify the Barnes-Hut approximation parameter. A higher value results in faster performance but less accurate positioning of nodes. 0 means no performance benefits.',
3495
+ type: "number"
3496
+ },
3497
+ chargeDistanceMax: {
3498
+ description: 'When layout is "force", specify the maximum distance over which the charge force is applied. By default there is no maximum distance.',
3499
+ type: "number"
3500
+ },
3501
+ chargeDistanceMin: {
3502
+ default: 1,
3503
+ description: 'When layout is "force", specify the minimum distance over which the charge force is applied.',
3504
+ type: "number"
3505
+ },
3506
+ collidePadding: {
3507
+ default: 10,
3508
+ description: 'When layout is "force", specify the additional distance around each node which the collider uses for node repulsion. When clustering is on, this value is used to increase collision distance for clusters.',
3509
+ type: "number"
3510
+ },
3511
+ collideStrength: {
3512
+ default: 1,
3513
+ description: 'When layout is "force", specify the strength of the collider used for node repulsion. A higher value results in stronger repulsion, causing nodes to spread out more. Ideally value should be between 0 - 5 but there is no hard limit.',
3514
+ type: "number"
3515
+ },
3516
+ clusterStrength: {
3517
+ default: 0.05,
3518
+ description: 'When layout is "force", specify the strength of the clustering force between nodes of the same type. A higher value results in stronger clustering, causing nodes of the same type to be positioned closer together. Value is between 0 and 1',
3519
+ type: "number"
3520
+ },
3521
+ linkDistance: {
3522
+ default: 30,
3523
+ description: 'When layout is "force", specify the ideal distance between linked nodes. A higher value results in more space between linked nodes.',
3524
+ type: "number"
3525
+ },
3526
+ linkStrength: {
3527
+ description: 'When layout is "force", specify the strength of the spring force between linked nodes. A higher value results in link lengths being closer to linkDistance. By default, highly connected nodes are assigned lower linkStrengths for stability. Ideally value should be between 0 - 5 but there is no hard limit.',
3528
+ type: "number"
3529
+ },
3530
+ tooltipNodeFields: {
3531
+ description: "Specify node fields to display in the tooltip for each node. When tooltipNodeFields and tooltipHeaderField are empty the tooltip is turned off.",
3532
+ default: [],
3533
+ type: "array",
3534
+ items: {
3535
+ type: "string"
3536
+ }
3537
+ },
3538
+ tooltipHeaderField: {
3539
+ description: "Specify field to display in the header of the tooltip for each node. When tooltipNodeField and tooltipHeaderField are empty the tooltip is turned off.",
3540
+ type: "string"
3541
+ },
3542
+ xPositions: {
3543
+ description: 'When layout is "preset", specify the x positions for each node in the from array',
3544
+ default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
3545
+ type: "array",
3546
+ items: {
3547
+ type: "number"
3548
+ }
3549
+ },
3550
+ yPositions: {
3551
+ description: 'When layout is "preset", specify the y positions for each node in the from array',
3552
+ default: '> primary | frameBySeriesTypes("number") | seriesByIndex(1)',
3553
+ type: "array",
3554
+ items: {
3555
+ type: "number"
3556
+ }
3557
+ },
3558
+ nodeDragPositions: {
3559
+ description: "Specify the positions for nodes by id when nodes are dragged.",
3560
+ type: "object"
3561
+ },
3562
+ preferPorts: {
3563
+ description: "Specify the preferred port alignment for s and z edges. Choose between horizontal, vertical, none.",
3564
+ type: "string",
3565
+ pattern: getPattern(["horizontal", "vertical", "none"])
3566
+ },
3567
+ showZoomControls: {
3568
+ default: true,
3569
+ description: "Specify whether to show the zoom controls on the graph.",
3570
+ type: "boolean"
3571
+ },
3572
+ resultLimit: {
3573
+ default: 1e3,
3574
+ description: "Specify the maximum length of link data points rendered. There is a hard limit at 10,000 data rows.",
3575
+ type: "number"
3276
3576
  }
3277
3577
  });
3278
3578
 
@@ -3766,7 +4066,6 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3766
4066
  description: "Specify whether to round x-axis values to the nearest integer.",
3767
4067
  type: "boolean"
3768
4068
  },
3769
- // TODO: figure out if we want to change splunk-charting behavior for Bubble/Scatter, which hardcodes XMajorGridlines to false
3770
4069
  // showXMajorGridLines: {
3771
4070
  // default: false,
3772
4071
  // description: 'Specify whether major grid lines are visible on the x-axis.',
@@ -4047,9 +4346,15 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4047
4346
  },
4048
4347
  shouldSparklineAcceptNullData: {
4049
4348
  default: true,
4050
- description: "Specify whether to convert null and non-numeric values in the sparkline to 0.",
4349
+ description: "Deprecated: Use sparklineNullValueDisplay instead. Specify whether to convert null and non-numeric values in the sparkline to 0.",
4051
4350
  type: "boolean"
4052
4351
  },
4352
+ sparklineNullValueDisplay: {
4353
+ default: "gaps",
4354
+ description: 'Specify the handling of null values for sparkline. "gaps" shows breaks in the line (default), "zero" treats null as 0, "connect" connects points across nulls.',
4355
+ pattern: getPattern(["gaps", "zero", "connect"]),
4356
+ type: "string"
4357
+ },
4053
4358
  shouldUseThousandSeparators: {
4054
4359
  default: true,
4055
4360
  description: "Specify whether numeric values use commas as thousandths separators.",
@@ -4124,7 +4429,6 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4124
4429
  },
4125
4430
  trendValue: {
4126
4431
  default: "> sparklineValues|delta(-2)",
4127
- // todo: may need update delta method
4128
4432
  description: "The trend value to display in the visualization.",
4129
4433
  type: "number"
4130
4434
  },
@@ -4294,7 +4598,6 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4294
4598
  },
4295
4599
  trendValue: {
4296
4600
  default: '> primary|seriesByPrioritizedTypes("number", "string", "time")|delta(-2)',
4297
- // todo: may need update delta method
4298
4601
  description: "The trend value to display in the visualization.",
4299
4602
  type: "number"
4300
4603
  },
@@ -4466,7 +4769,6 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4466
4769
  },
4467
4770
  trendValue: {
4468
4771
  default: '> primary | seriesByPrioritizedTypes("number", "string", "time") | delta(-2)',
4469
- // todo: may need update delta method
4470
4772
  description: "Specify the dataSource applied to the trend value.",
4471
4773
  type: "number"
4472
4774
  },
@@ -4616,6 +4918,12 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4616
4918
  enum: validSparklineTypes.concat()
4617
4919
  }
4618
4920
  },
4921
+ sparklineNullValueDisplay: {
4922
+ description: 'Specify the handling of null values for sparkline cells. "zero" treats null as 0, "gaps" shows breaks in the line, "connect" connects points across nulls.',
4923
+ type: "string",
4924
+ default: "gaps",
4925
+ pattern: getPattern(["gaps", "zero", "connect"])
4926
+ },
4619
4927
  textOverflow: {
4620
4928
  description: 'Controls how the text should be truncated within a particular column. Valid types include "anywhere", "break-word", "ellipsis". Columns and Headers are "break-word" styled by default when "textOverflow" is not configured.',
4621
4929
  type: "string",
@@ -4820,6 +5128,12 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4820
5128
  }
4821
5129
  }
4822
5130
  },
5131
+ sparklineNullValueDisplay: {
5132
+ description: 'Specify the handling of null values for sparkline cells. "zero" treats null as 0, "gaps" shows breaks in the line, "connect" connects points across nulls.',
5133
+ type: "string",
5134
+ default: "gaps",
5135
+ pattern: getPattern(["gaps", "zero", "connect"])
5136
+ },
4823
5137
  textOverflow: {
4824
5138
  description: 'Specify the text overflow for the whole table. Valid overflows include "break-word", "anywhere", and "ellipsis". Default for Column and Headers is "break-word".',
4825
5139
  type: "string",
@@ -4948,6 +5262,7 @@ export {
4948
5262
  mapOptionsSchema,
4949
5263
  markdownOptionsSchema,
4950
5264
  markerGaugeOptionsSchema,
5265
+ networkGraphOptionsSchema,
4951
5266
  parallelCoordinatesOptionsSchema,
4952
5267
  pieOptionsSchema,
4953
5268
  punchcardOptionsSchema,