@splunk/visualization-schemas 28.4.0 → 28.5.1
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 +51 -32
- package/dist/cjs/index.js.map +2 -2
- package/dist/esm/index.js +51 -32
- package/dist/esm/index.js.map +2 -2
- package/package.json +3 -3
package/dist/cjs/index.js
CHANGED
|
@@ -443,7 +443,7 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
443
443
|
items: { type: ["string", "number"] }
|
|
444
444
|
},
|
|
445
445
|
areaOpacity: {
|
|
446
|
-
description: "Specify the opacity of the area chart. Values can range from 0 (transparent) to 1 (opaque).",
|
|
446
|
+
description: "Specify the opacity of the area chart. Values can range from 0 (transparent) to 1 (opaque). The fill opacity is calculated by applying areaOpacity squared.",
|
|
447
447
|
type: "number",
|
|
448
448
|
default: 0.75
|
|
449
449
|
},
|
|
@@ -2271,7 +2271,7 @@ var fillerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2271
2271
|
type: "string"
|
|
2272
2272
|
},
|
|
2273
2273
|
majorTickInterval: {
|
|
2274
|
-
description: "Specify
|
|
2274
|
+
description: "Specify the interval between major tick marks.",
|
|
2275
2275
|
default: "auto",
|
|
2276
2276
|
type: ["string", "number"]
|
|
2277
2277
|
},
|
|
@@ -2461,6 +2461,17 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2461
2461
|
"longDash", "dashDot", "longDashDot", "longDashDotDot".`,
|
|
2462
2462
|
type: "object"
|
|
2463
2463
|
},
|
|
2464
|
+
stepPosition: {
|
|
2465
|
+
description: 'Specify stepped interpolation position for all line series in accelerated render mode. Valid values: "off", "before", "after".',
|
|
2466
|
+
pattern: getPattern(["off", "before", "after"]),
|
|
2467
|
+
type: "string",
|
|
2468
|
+
default: "off"
|
|
2469
|
+
},
|
|
2470
|
+
stepPositionsByField: {
|
|
2471
|
+
description: `Specify stepped interpolation position for each field in accelerated render mode. For example, {"count": "before", "percent": "off"}.
|
|
2472
|
+
Valid values: "off", "before", "after".`,
|
|
2473
|
+
type: "object"
|
|
2474
|
+
},
|
|
2464
2475
|
lineWidth: {
|
|
2465
2476
|
default: 2,
|
|
2466
2477
|
description: "Specify the line width (px), for all line series.",
|
|
@@ -3314,7 +3325,7 @@ var markerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3314
3325
|
pattern: getPattern(["number", "percentage", "off"])
|
|
3315
3326
|
},
|
|
3316
3327
|
majorTickInterval: {
|
|
3317
|
-
description: "Specify
|
|
3328
|
+
description: "Specify the interval between major tick marks.",
|
|
3318
3329
|
default: "auto",
|
|
3319
3330
|
type: ["string", "number"]
|
|
3320
3331
|
},
|
|
@@ -3388,7 +3399,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3388
3399
|
},
|
|
3389
3400
|
source: {
|
|
3390
3401
|
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
|
|
3391
|
-
description: "Specify the array of node Ids
|
|
3402
|
+
description: "Specify the array of node Ids that links start from.",
|
|
3392
3403
|
type: "array",
|
|
3393
3404
|
items: {
|
|
3394
3405
|
type: "string"
|
|
@@ -3396,7 +3407,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3396
3407
|
},
|
|
3397
3408
|
target: {
|
|
3398
3409
|
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(1)',
|
|
3399
|
-
description: "Specify the array of node Ids
|
|
3410
|
+
description: "Specify the array of node Ids that links go to.",
|
|
3400
3411
|
type: "array",
|
|
3401
3412
|
items: {
|
|
3402
3413
|
type: "string"
|
|
@@ -3404,14 +3415,14 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3404
3415
|
},
|
|
3405
3416
|
nodeIds: {
|
|
3406
3417
|
default: "> source",
|
|
3407
|
-
description: "Specify the array of node Ids
|
|
3418
|
+
description: "Specify the array of node Ids to use for node styling. By default this is the same as the from array.",
|
|
3408
3419
|
type: "array",
|
|
3409
3420
|
items: {
|
|
3410
3421
|
type: "string"
|
|
3411
3422
|
}
|
|
3412
3423
|
},
|
|
3413
3424
|
nodeTypes: {
|
|
3414
|
-
description:
|
|
3425
|
+
description: 'Specify the node type for each node in the nodeIds array. Needed for clustering when layout is "force".',
|
|
3415
3426
|
type: "array",
|
|
3416
3427
|
items: {
|
|
3417
3428
|
type: "string"
|
|
@@ -3419,7 +3430,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3419
3430
|
},
|
|
3420
3431
|
nodeValues: {
|
|
3421
3432
|
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
|
|
3422
|
-
description: "Specify the
|
|
3433
|
+
description: "Specify the node value for each node in the nodeIds array.",
|
|
3423
3434
|
type: "array",
|
|
3424
3435
|
items: {
|
|
3425
3436
|
type: "number"
|
|
@@ -3427,7 +3438,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3427
3438
|
},
|
|
3428
3439
|
nodeTexts: {
|
|
3429
3440
|
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
|
|
3430
|
-
description: "Specify the
|
|
3441
|
+
description: "Specify the text to display under each node in the nodeIds array.",
|
|
3431
3442
|
type: "array",
|
|
3432
3443
|
items: {
|
|
3433
3444
|
type: "string"
|
|
@@ -3443,7 +3454,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3443
3454
|
default: "> themes.defaultNodeColor"
|
|
3444
3455
|
},
|
|
3445
3456
|
nodeSize: {
|
|
3446
|
-
description: "Specify a number
|
|
3457
|
+
description: "Specify a number to set the same diameter for all nodes or an array of numbers to set a custom diameter for each node. (8px - 200px)",
|
|
3447
3458
|
type: ["number", "array"],
|
|
3448
3459
|
items: {
|
|
3449
3460
|
type: "number",
|
|
@@ -3461,7 +3472,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3461
3472
|
default: '> primary | seriesByType("number")'
|
|
3462
3473
|
},
|
|
3463
3474
|
nodeIcons: {
|
|
3464
|
-
description: "Specify the icon used for
|
|
3475
|
+
description: "Specify the icon used for each node (cylinder, portrait, magnifier, etc.).",
|
|
3465
3476
|
type: "array",
|
|
3466
3477
|
items: {
|
|
3467
3478
|
type: "string",
|
|
@@ -3469,7 +3480,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3469
3480
|
}
|
|
3470
3481
|
},
|
|
3471
3482
|
nodeIconColors: {
|
|
3472
|
-
description: "Specify the color used for node
|
|
3483
|
+
description: "Specify the color used for each node icon. You may use a dataSource to apply color dynamically.",
|
|
3473
3484
|
type: ["array", "string"],
|
|
3474
3485
|
items: {
|
|
3475
3486
|
type: "string",
|
|
@@ -3487,7 +3498,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3487
3498
|
},
|
|
3488
3499
|
linkStyle: {
|
|
3489
3500
|
default: "straight",
|
|
3490
|
-
description: "Specify the
|
|
3501
|
+
description: "Specify the link shape (s, z, c, straight).",
|
|
3491
3502
|
type: "string",
|
|
3492
3503
|
pattern: getPattern(["s", "z", "c", "straight"])
|
|
3493
3504
|
},
|
|
@@ -3501,7 +3512,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3501
3512
|
default: "> themes.defaultLinkColor"
|
|
3502
3513
|
},
|
|
3503
3514
|
linkWidth: {
|
|
3504
|
-
description: "Specify a number
|
|
3515
|
+
description: "Specify a number to set the same width of all links or an array of numbers to set a custom width for each link. Width is in pixels.",
|
|
3505
3516
|
type: ["number", "array"],
|
|
3506
3517
|
items: {
|
|
3507
3518
|
type: "number",
|
|
@@ -3532,12 +3543,12 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3532
3543
|
},
|
|
3533
3544
|
nodeHorizontalPadding: {
|
|
3534
3545
|
default: 0,
|
|
3535
|
-
description: "Specify the additional padding between nodes
|
|
3546
|
+
description: "Specify the additional horizontal padding between nodes in pixels (0 - 500).",
|
|
3536
3547
|
type: "number"
|
|
3537
3548
|
},
|
|
3538
3549
|
nodeVerticalPadding: {
|
|
3539
3550
|
default: 0,
|
|
3540
|
-
description: "Specify the additional padding between nodes
|
|
3551
|
+
description: "Specify the additional vertical padding between nodes in pixels (0 - 500).",
|
|
3541
3552
|
type: "number"
|
|
3542
3553
|
},
|
|
3543
3554
|
gridColumns: {
|
|
@@ -3545,27 +3556,27 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3545
3556
|
type: "number"
|
|
3546
3557
|
},
|
|
3547
3558
|
hierarchyDirection: {
|
|
3548
|
-
description: 'When layout is "hierarchical", specify the direction
|
|
3559
|
+
description: 'When layout is "hierarchical", specify the direction (topBottom, bottomTop, leftRight, rightLeft) of the hierarchy.',
|
|
3549
3560
|
default: "leftRight",
|
|
3550
3561
|
pattern: getPattern(["topBottom", "bottomTop", "leftRight", "rightLeft"])
|
|
3551
3562
|
},
|
|
3552
3563
|
chargeStrength: {
|
|
3553
3564
|
default: -30,
|
|
3554
|
-
description: 'When layout is "force", specify the strength of the charge between nodes.
|
|
3565
|
+
description: 'When layout is "force", specify the strength of the charge between nodes. Positive value is attraction and negative value is replusion.',
|
|
3555
3566
|
type: "number"
|
|
3556
3567
|
},
|
|
3557
3568
|
chargeTheta: {
|
|
3558
3569
|
default: 0.9,
|
|
3559
|
-
description: 'When layout is "force", specify the Barnes-Hut approximation parameter.
|
|
3570
|
+
description: 'When layout is "force", specify the Barnes-Hut approximation parameter. Higher value means faster performance but less predictable node positioning.',
|
|
3560
3571
|
type: "number"
|
|
3561
3572
|
},
|
|
3562
3573
|
chargeDistanceMax: {
|
|
3563
|
-
description: 'When layout is "force", specify the maximum distance over which the charge force
|
|
3574
|
+
description: 'When layout is "force", specify the maximum distance over which to apply the charge force.',
|
|
3564
3575
|
type: "number"
|
|
3565
3576
|
},
|
|
3566
3577
|
chargeDistanceMin: {
|
|
3567
3578
|
default: 1,
|
|
3568
|
-
description: 'When layout is "force", specify the minimum distance over which the charge force
|
|
3579
|
+
description: 'When layout is "force", specify the minimum distance over which to apply the charge force.',
|
|
3569
3580
|
type: "number"
|
|
3570
3581
|
},
|
|
3571
3582
|
collidePadding: {
|
|
@@ -3575,10 +3586,12 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3575
3586
|
},
|
|
3576
3587
|
collideStrength: {
|
|
3577
3588
|
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 -
|
|
3589
|
+
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 - 1 but there is no hard limit.',
|
|
3579
3590
|
type: "number"
|
|
3580
3591
|
},
|
|
3581
3592
|
clusterStrength: {
|
|
3593
|
+
minimum: 0,
|
|
3594
|
+
maximum: 1,
|
|
3582
3595
|
default: 0.05,
|
|
3583
3596
|
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
3597
|
type: "number"
|
|
@@ -3589,23 +3602,23 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3589
3602
|
type: "number"
|
|
3590
3603
|
},
|
|
3591
3604
|
linkStrength: {
|
|
3592
|
-
|
|
3593
|
-
|
|
3605
|
+
minimum: 0,
|
|
3606
|
+
maximum: 1,
|
|
3607
|
+
description: 'When layout is "force", specify the strength of the spring force between linked nodes. Higher value makes link lengths closer to the linkDistance value.'
|
|
3594
3608
|
},
|
|
3595
3609
|
tooltipNodeFields: {
|
|
3596
|
-
description: "Specify
|
|
3597
|
-
default: [],
|
|
3610
|
+
description: "Specify the fields to add to the tooltips. Tooltips appear when you hover over nodes. These fields and their corresponding values display for each node in its tooltip.",
|
|
3598
3611
|
type: "array",
|
|
3599
3612
|
items: {
|
|
3600
3613
|
type: "string"
|
|
3601
3614
|
}
|
|
3602
3615
|
},
|
|
3603
3616
|
tooltipHeaderField: {
|
|
3604
|
-
description: "Specify field to
|
|
3617
|
+
description: "Specify the field to add to the tooltip header. Tooltips appear when you hover over nodes. Only the value of this field for the node displays as the header.",
|
|
3605
3618
|
type: "string"
|
|
3606
3619
|
},
|
|
3607
3620
|
xPositions: {
|
|
3608
|
-
description: 'When layout is "preset", specify the x
|
|
3621
|
+
description: 'When layout is "preset", specify the x position for each node.',
|
|
3609
3622
|
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
|
|
3610
3623
|
type: "array",
|
|
3611
3624
|
items: {
|
|
@@ -3613,7 +3626,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3613
3626
|
}
|
|
3614
3627
|
},
|
|
3615
3628
|
yPositions: {
|
|
3616
|
-
description: 'When layout is "preset", specify the y
|
|
3629
|
+
description: 'When layout is "preset", specify the y position for each node.',
|
|
3617
3630
|
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(1)',
|
|
3618
3631
|
type: "array",
|
|
3619
3632
|
items: {
|
|
@@ -3621,11 +3634,11 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3621
3634
|
}
|
|
3622
3635
|
},
|
|
3623
3636
|
nodeDragPositions: {
|
|
3624
|
-
description: "
|
|
3637
|
+
description: "Stores the positions for nodes by id when the user drags nodes to new positions using the UI.",
|
|
3625
3638
|
type: "object"
|
|
3626
3639
|
},
|
|
3627
3640
|
preferPorts: {
|
|
3628
|
-
description: "Specify the preferred port alignment for s and z
|
|
3641
|
+
description: "Specify the preferred port alignment for s and z links (horizontal, vertical, none).",
|
|
3629
3642
|
type: "string",
|
|
3630
3643
|
pattern: getPattern(["horizontal", "vertical", "none"])
|
|
3631
3644
|
},
|
|
@@ -3636,7 +3649,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3636
3649
|
},
|
|
3637
3650
|
resultLimit: {
|
|
3638
3651
|
default: 1e3,
|
|
3639
|
-
description: "Specify the maximum
|
|
3652
|
+
description: "Specify the maximum number of link data points rendered (hard limit 10,000).",
|
|
3640
3653
|
type: "number"
|
|
3641
3654
|
}
|
|
3642
3655
|
});
|
|
@@ -3685,6 +3698,12 @@ var pieOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3685
3698
|
type: "string",
|
|
3686
3699
|
default: "other"
|
|
3687
3700
|
},
|
|
3701
|
+
legendDisplay: {
|
|
3702
|
+
default: "off",
|
|
3703
|
+
description: "Specify the location of the legend on the panel.",
|
|
3704
|
+
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
3705
|
+
type: "string"
|
|
3706
|
+
},
|
|
3688
3707
|
collapseThreshold: {
|
|
3689
3708
|
description: "Specify the size threshold as a number between 0 and 1 (inclusive), of the whole pie at which slices collapse into one consolidated slice.",
|
|
3690
3709
|
type: "number",
|