@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/cjs/index.js CHANGED
@@ -88,6 +88,7 @@ __export(src_exports, {
88
88
  mapOptionsSchema: () => mapOptionsSchema,
89
89
  markdownOptionsSchema: () => markdownOptionsSchema,
90
90
  markerGaugeOptionsSchema: () => markerGaugeOptionsSchema,
91
+ networkGraphOptionsSchema: () => networkGraphOptionsSchema,
91
92
  parallelCoordinatesOptionsSchema: () => parallelCoordinatesOptionsSchema,
92
93
  pieOptionsSchema: () => pieOptionsSchema,
93
94
  punchcardOptionsSchema: () => punchcardOptionsSchema,
@@ -1264,25 +1265,21 @@ var barOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1264
1265
  description: "Specify the spacing unit between major tick marks along the numeric second y-axis.",
1265
1266
  type: ["string", "number"]
1266
1267
  },
1267
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
1268
1268
  yAxisMax: {
1269
1269
  default: "auto",
1270
1270
  description: "Specify the largest value to display in the visible y-axis range.",
1271
1271
  type: ["string", "number"]
1272
1272
  },
1273
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
1274
1273
  y2AxisMax: {
1275
1274
  default: "auto",
1276
1275
  description: "Specify the largest value to display in the visible second y-axis range.",
1277
1276
  type: ["string", "number"]
1278
1277
  },
1279
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
1280
1278
  yAxisMin: {
1281
1279
  default: "auto",
1282
1280
  description: "Specify the smallest value for the visible y-axis range.",
1283
1281
  type: ["string", "number"]
1284
1282
  },
1285
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
1286
1283
  y2AxisMin: {
1287
1284
  default: "auto",
1288
1285
  description: "Specify the smallest value for the visible second y-axis range.",
@@ -1423,7 +1420,6 @@ var bubbleOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
1423
1420
  description: "Specify whether to round x-axis values to the nearest integer.",
1424
1421
  type: "boolean"
1425
1422
  },
1426
- // TODO: figure out if we want to change splunk-charting behavior for Bubble/Scatter, which hardcodes XMajorGridlines to false
1427
1423
  // showXMajorGridLines: {
1428
1424
  // default: false,
1429
1425
  // description: 'Specify whether major grid lines are visible on the x-axis.',
@@ -2763,25 +2759,21 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2763
2759
  description: "Specify the spacing unit between major tick marks along the numeric y2-axis.",
2764
2760
  type: ["string", "number"]
2765
2761
  },
2766
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
2767
2762
  yAxisMax: {
2768
2763
  default: "auto",
2769
2764
  description: "Specify the maximum number for the visible y-axis range.",
2770
2765
  type: ["string", "number"]
2771
2766
  },
2772
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
2773
2767
  y2AxisMax: {
2774
2768
  default: "auto",
2775
2769
  description: "Specify the maximum number for the visible y2-axis range.",
2776
2770
  type: ["string", "number"]
2777
2771
  },
2778
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
2779
2772
  yAxisMin: {
2780
2773
  default: "auto",
2781
2774
  description: "Specify the minimum number for the visible y-axis range.",
2782
2775
  type: ["string", "number"]
2783
2776
  },
2784
- // TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
2785
2777
  y2AxisMin: {
2786
2778
  default: "auto",
2787
2779
  description: "Specify the minimum number for the visible y2-axis range.",
@@ -2799,7 +2791,6 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2799
2791
  pattern: getPattern(["linear", "log"]),
2800
2792
  type: "string"
2801
2793
  },
2802
- // TODO: Figure out a way to explicitly support string value in addition to an array of strings
2803
2794
  // as UDF won't allow users to proceed if a string value is entered due to schema validation
2804
2795
  overlayFields: {
2805
2796
  description: "Specify field(s) that should be differentiated on the chart and displayed as chart overlays.",
@@ -2867,6 +2858,12 @@ var linkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
2867
2858
  type: "string",
2868
2859
  default: "> nodeColor | maxContrast(nodeTextColorMaxContrast)"
2869
2860
  },
2861
+ nodeLabelOverflow: {
2862
+ 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.',
2863
+ type: "string",
2864
+ pattern: getPattern(validTextOverflows),
2865
+ default: "ellipsis"
2866
+ },
2870
2867
  nodeHeight: {
2871
2868
  default: 21,
2872
2869
  description: "Specify, in pixels, the height of each node.",
@@ -3337,6 +3334,310 @@ var markerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3337
3334
  default: "number",
3338
3335
  type: "string",
3339
3336
  pattern: getPattern(["number", "percentage", "off"])
3337
+ },
3338
+ splitByLayout: {
3339
+ default: "off",
3340
+ description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
3341
+ type: "string",
3342
+ pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
3343
+ enum: ["off" /* Off */, "trellis" /* Trellis */]
3344
+ },
3345
+ trellisBackgroundColor: {
3346
+ default: "> themes.defaultBackgroundColor",
3347
+ description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
3348
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
3349
+ type: "string"
3350
+ },
3351
+ trellisColumns: {
3352
+ 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.",
3353
+ type: "number",
3354
+ minimum: 1,
3355
+ default: 3
3356
+ },
3357
+ trellisMinColumnWidth: {
3358
+ default: 200,
3359
+ minimum: 1,
3360
+ 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.",
3361
+ type: "number"
3362
+ },
3363
+ trellisPageCount: {
3364
+ default: 20,
3365
+ minimum: 1,
3366
+ 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.",
3367
+ type: "number"
3368
+ },
3369
+ trellisRowHeight: {
3370
+ default: 200,
3371
+ minimum: 1,
3372
+ 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.",
3373
+ type: "number"
3374
+ },
3375
+ trellisSplitBy: {
3376
+ 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.',
3377
+ type: "string"
3378
+ }
3379
+ });
3380
+
3381
+ // src/optionsSchemas/networkGraph.ts
3382
+ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3383
+ backgroundColor: {
3384
+ default: "> themes.defaultBackgroundColor",
3385
+ 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".',
3386
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
3387
+ type: "string"
3388
+ },
3389
+ source: {
3390
+ default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
3391
+ description: "Specify the array of node Ids we are drawing edges from",
3392
+ type: "array",
3393
+ items: {
3394
+ type: "string"
3395
+ }
3396
+ },
3397
+ target: {
3398
+ default: '> primary | frameBySeriesTypes("string") | seriesByIndex(1)',
3399
+ description: "Specify the array of node Ids we are drawing edges to",
3400
+ type: "array",
3401
+ items: {
3402
+ type: "string"
3403
+ }
3404
+ },
3405
+ nodeIds: {
3406
+ default: "> source",
3407
+ description: "Specify the array of node Ids we are using for node styling. By default this is the same as from",
3408
+ type: "array",
3409
+ items: {
3410
+ type: "string"
3411
+ }
3412
+ },
3413
+ nodeTypes: {
3414
+ description: "Specify the array of node types for each node in the from array. Needed for clustering in force algorithm",
3415
+ type: "array",
3416
+ items: {
3417
+ type: "string"
3418
+ }
3419
+ },
3420
+ nodeValues: {
3421
+ default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
3422
+ description: "Specify the array of node values for each node in the from array",
3423
+ type: "array",
3424
+ items: {
3425
+ type: "number"
3426
+ }
3427
+ },
3428
+ nodeTexts: {
3429
+ default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
3430
+ description: "Specify the array of node texts for each node in the from array",
3431
+ type: "array",
3432
+ items: {
3433
+ type: "string"
3434
+ }
3435
+ },
3436
+ nodeColors: {
3437
+ description: "Specify the color used for nodes. You may use a dataSource to apply color dynamically.",
3438
+ type: ["string", "array"],
3439
+ items: {
3440
+ type: "string",
3441
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3442
+ },
3443
+ default: "> themes.defaultNodeColor"
3444
+ },
3445
+ nodeSize: {
3446
+ 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.",
3447
+ type: ["number", "array"],
3448
+ items: {
3449
+ type: "number",
3450
+ minimum: 8,
3451
+ maximum: 200
3452
+ },
3453
+ default: 48
3454
+ },
3455
+ nodeColorValues: {
3456
+ description: "Specify the array of values used for dynamic node coloring.",
3457
+ type: "array",
3458
+ items: {
3459
+ type: ["string", "number"]
3460
+ },
3461
+ default: '> primary | seriesByType("number")'
3462
+ },
3463
+ nodeIcons: {
3464
+ description: "Specify the icon used for nodes. Choose between cylinder, portrait, magnifier, report, servers, code, globe, proxy, alert.",
3465
+ type: "array",
3466
+ items: {
3467
+ type: "string",
3468
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3469
+ }
3470
+ },
3471
+ nodeIconColors: {
3472
+ description: "Specify the color used for node icons. You may use a dataSource to apply color dynamically.",
3473
+ type: ["array", "string"],
3474
+ items: {
3475
+ type: "string",
3476
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3477
+ },
3478
+ default: "> themes.defaultNodeIconColor"
3479
+ },
3480
+ nodeIconColorValues: {
3481
+ description: "Specify the array of values used for dynamic node icon coloring.",
3482
+ type: "array",
3483
+ items: {
3484
+ type: ["string", "number"]
3485
+ },
3486
+ default: '> primary | seriesByType("number")'
3487
+ },
3488
+ linkStyle: {
3489
+ default: "straight",
3490
+ description: "Specify the edge shape used for links. Choose between s, z, c, straight",
3491
+ type: "string",
3492
+ pattern: getPattern(["s", "z", "c", "straight"])
3493
+ },
3494
+ linkColors: {
3495
+ description: "Specify the color used for links. You may use a dataSource to apply color dynamically.",
3496
+ type: ["array", "string"],
3497
+ items: {
3498
+ type: "string",
3499
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
3500
+ },
3501
+ default: "> themes.defaultLinkColor"
3502
+ },
3503
+ linkWidth: {
3504
+ description: "Specify a number for the width of all links in pixels, or an array of numbers for each link.",
3505
+ type: ["number", "array"],
3506
+ items: {
3507
+ type: "number",
3508
+ minimum: 1,
3509
+ maximum: 20
3510
+ },
3511
+ default: 2
3512
+ },
3513
+ linkColorValues: {
3514
+ description: "Specify the array of values used for dynamic link coloring.",
3515
+ type: "array",
3516
+ items: {
3517
+ type: ["string", "number"]
3518
+ },
3519
+ default: '> primary | seriesByType("number")'
3520
+ },
3521
+ showDirection: {
3522
+ default: "bidirection",
3523
+ description: "Specify the directionality of the links. Choose between bidirection, oneWay, none. z and s linkStyles look better with bidirection instead of oneWay.",
3524
+ type: "string",
3525
+ pattern: getPattern(["bidirection", "oneWay", "none"])
3526
+ },
3527
+ layout: {
3528
+ default: "grid",
3529
+ description: "Specify the layout used for the graph. Choose between preset, grid, hierarchical",
3530
+ type: "string",
3531
+ pattern: getPattern(["preset", "grid", "hierarchical", "force"])
3532
+ },
3533
+ nodeHorizontalPadding: {
3534
+ default: 0,
3535
+ description: "Specify the additional padding between nodes horizontally in pixels, in the range of 0 - 500.",
3536
+ type: "number"
3537
+ },
3538
+ nodeVerticalPadding: {
3539
+ default: 0,
3540
+ description: "Specify the additional padding between nodes vertically in pixels, in the range of 0 - 500.",
3541
+ type: "number"
3542
+ },
3543
+ gridColumns: {
3544
+ 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',
3545
+ type: "number"
3546
+ },
3547
+ hierarchyDirection: {
3548
+ description: 'When layout is "hierarchical", specify the direction of the hierarchy. Choose between topBottom, bottomTop, leftRight, rightLeft.',
3549
+ default: "leftRight",
3550
+ pattern: getPattern(["topBottom", "bottomTop", "leftRight", "rightLeft"])
3551
+ },
3552
+ chargeStrength: {
3553
+ default: -30,
3554
+ 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.',
3555
+ type: "number"
3556
+ },
3557
+ chargeTheta: {
3558
+ default: 0.9,
3559
+ 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.',
3560
+ type: "number"
3561
+ },
3562
+ chargeDistanceMax: {
3563
+ description: 'When layout is "force", specify the maximum distance over which the charge force is applied. By default there is no maximum distance.',
3564
+ type: "number"
3565
+ },
3566
+ chargeDistanceMin: {
3567
+ default: 1,
3568
+ description: 'When layout is "force", specify the minimum distance over which the charge force is applied.',
3569
+ type: "number"
3570
+ },
3571
+ collidePadding: {
3572
+ default: 10,
3573
+ 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.',
3574
+ type: "number"
3575
+ },
3576
+ collideStrength: {
3577
+ default: 1,
3578
+ 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.',
3579
+ type: "number"
3580
+ },
3581
+ clusterStrength: {
3582
+ default: 0.05,
3583
+ 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',
3584
+ type: "number"
3585
+ },
3586
+ linkDistance: {
3587
+ default: 30,
3588
+ description: 'When layout is "force", specify the ideal distance between linked nodes. A higher value results in more space between linked nodes.',
3589
+ type: "number"
3590
+ },
3591
+ linkStrength: {
3592
+ 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.',
3593
+ type: "number"
3594
+ },
3595
+ tooltipNodeFields: {
3596
+ description: "Specify node fields to display in the tooltip for each node. When tooltipNodeFields and tooltipHeaderField are empty the tooltip is turned off.",
3597
+ default: [],
3598
+ type: "array",
3599
+ items: {
3600
+ type: "string"
3601
+ }
3602
+ },
3603
+ tooltipHeaderField: {
3604
+ 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.",
3605
+ type: "string"
3606
+ },
3607
+ xPositions: {
3608
+ description: 'When layout is "preset", specify the x positions for each node in the from array',
3609
+ default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
3610
+ type: "array",
3611
+ items: {
3612
+ type: "number"
3613
+ }
3614
+ },
3615
+ yPositions: {
3616
+ description: 'When layout is "preset", specify the y positions for each node in the from array',
3617
+ default: '> primary | frameBySeriesTypes("number") | seriesByIndex(1)',
3618
+ type: "array",
3619
+ items: {
3620
+ type: "number"
3621
+ }
3622
+ },
3623
+ nodeDragPositions: {
3624
+ description: "Specify the positions for nodes by id when nodes are dragged.",
3625
+ type: "object"
3626
+ },
3627
+ preferPorts: {
3628
+ description: "Specify the preferred port alignment for s and z edges. Choose between horizontal, vertical, none.",
3629
+ type: "string",
3630
+ pattern: getPattern(["horizontal", "vertical", "none"])
3631
+ },
3632
+ showZoomControls: {
3633
+ default: true,
3634
+ description: "Specify whether to show the zoom controls on the graph.",
3635
+ type: "boolean"
3636
+ },
3637
+ resultLimit: {
3638
+ default: 1e3,
3639
+ description: "Specify the maximum length of link data points rendered. There is a hard limit at 10,000 data rows.",
3640
+ type: "number"
3340
3641
  }
3341
3642
  });
3342
3643
 
@@ -3830,7 +4131,6 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3830
4131
  description: "Specify whether to round x-axis values to the nearest integer.",
3831
4132
  type: "boolean"
3832
4133
  },
3833
- // TODO: figure out if we want to change splunk-charting behavior for Bubble/Scatter, which hardcodes XMajorGridlines to false
3834
4134
  // showXMajorGridLines: {
3835
4135
  // default: false,
3836
4136
  // description: 'Specify whether major grid lines are visible on the x-axis.',
@@ -4111,9 +4411,15 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4111
4411
  },
4112
4412
  shouldSparklineAcceptNullData: {
4113
4413
  default: true,
4114
- description: "Specify whether to convert null and non-numeric values in the sparkline to 0.",
4414
+ description: "Deprecated: Use sparklineNullValueDisplay instead. Specify whether to convert null and non-numeric values in the sparkline to 0.",
4115
4415
  type: "boolean"
4116
4416
  },
4417
+ sparklineNullValueDisplay: {
4418
+ default: "gaps",
4419
+ 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.',
4420
+ pattern: getPattern(["gaps", "zero", "connect"]),
4421
+ type: "string"
4422
+ },
4117
4423
  shouldUseThousandSeparators: {
4118
4424
  default: true,
4119
4425
  description: "Specify whether numeric values use commas as thousandths separators.",
@@ -4188,7 +4494,6 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4188
4494
  },
4189
4495
  trendValue: {
4190
4496
  default: "> sparklineValues|delta(-2)",
4191
- // todo: may need update delta method
4192
4497
  description: "The trend value to display in the visualization.",
4193
4498
  type: "number"
4194
4499
  },
@@ -4358,7 +4663,6 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4358
4663
  },
4359
4664
  trendValue: {
4360
4665
  default: '> primary|seriesByPrioritizedTypes("number", "string", "time")|delta(-2)',
4361
- // todo: may need update delta method
4362
4666
  description: "The trend value to display in the visualization.",
4363
4667
  type: "number"
4364
4668
  },
@@ -4530,7 +4834,6 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4530
4834
  },
4531
4835
  trendValue: {
4532
4836
  default: '> primary | seriesByPrioritizedTypes("number", "string", "time") | delta(-2)',
4533
- // todo: may need update delta method
4534
4837
  description: "Specify the dataSource applied to the trend value.",
4535
4838
  type: "number"
4536
4839
  },
@@ -4680,6 +4983,12 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4680
4983
  enum: validSparklineTypes.concat()
4681
4984
  }
4682
4985
  },
4986
+ sparklineNullValueDisplay: {
4987
+ 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.',
4988
+ type: "string",
4989
+ default: "gaps",
4990
+ pattern: getPattern(["gaps", "zero", "connect"])
4991
+ },
4683
4992
  textOverflow: {
4684
4993
  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.',
4685
4994
  type: "string",
@@ -4884,6 +5193,12 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4884
5193
  }
4885
5194
  }
4886
5195
  },
5196
+ sparklineNullValueDisplay: {
5197
+ 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.',
5198
+ type: "string",
5199
+ default: "gaps",
5200
+ pattern: getPattern(["gaps", "zero", "connect"])
5201
+ },
4887
5202
  textOverflow: {
4888
5203
  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".',
4889
5204
  type: "string",