@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/esm/index.js
CHANGED
|
@@ -378,7 +378,7 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
378
378
|
items: { type: ["string", "number"] }
|
|
379
379
|
},
|
|
380
380
|
areaOpacity: {
|
|
381
|
-
description: "Specify the opacity of the area chart. Values can range from 0 (transparent) to 1 (opaque).",
|
|
381
|
+
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.",
|
|
382
382
|
type: "number",
|
|
383
383
|
default: 0.75
|
|
384
384
|
},
|
|
@@ -2206,7 +2206,7 @@ var fillerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2206
2206
|
type: "string"
|
|
2207
2207
|
},
|
|
2208
2208
|
majorTickInterval: {
|
|
2209
|
-
description: "Specify
|
|
2209
|
+
description: "Specify the interval between major tick marks.",
|
|
2210
2210
|
default: "auto",
|
|
2211
2211
|
type: ["string", "number"]
|
|
2212
2212
|
},
|
|
@@ -2396,6 +2396,17 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2396
2396
|
"longDash", "dashDot", "longDashDot", "longDashDotDot".`,
|
|
2397
2397
|
type: "object"
|
|
2398
2398
|
},
|
|
2399
|
+
stepPosition: {
|
|
2400
|
+
description: 'Specify stepped interpolation position for all line series in accelerated render mode. Valid values: "off", "before", "after".',
|
|
2401
|
+
pattern: getPattern(["off", "before", "after"]),
|
|
2402
|
+
type: "string",
|
|
2403
|
+
default: "off"
|
|
2404
|
+
},
|
|
2405
|
+
stepPositionsByField: {
|
|
2406
|
+
description: `Specify stepped interpolation position for each field in accelerated render mode. For example, {"count": "before", "percent": "off"}.
|
|
2407
|
+
Valid values: "off", "before", "after".`,
|
|
2408
|
+
type: "object"
|
|
2409
|
+
},
|
|
2399
2410
|
lineWidth: {
|
|
2400
2411
|
default: 2,
|
|
2401
2412
|
description: "Specify the line width (px), for all line series.",
|
|
@@ -3249,7 +3260,7 @@ var markerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3249
3260
|
pattern: getPattern(["number", "percentage", "off"])
|
|
3250
3261
|
},
|
|
3251
3262
|
majorTickInterval: {
|
|
3252
|
-
description: "Specify
|
|
3263
|
+
description: "Specify the interval between major tick marks.",
|
|
3253
3264
|
default: "auto",
|
|
3254
3265
|
type: ["string", "number"]
|
|
3255
3266
|
},
|
|
@@ -3323,7 +3334,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3323
3334
|
},
|
|
3324
3335
|
source: {
|
|
3325
3336
|
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
|
|
3326
|
-
description: "Specify the array of node Ids
|
|
3337
|
+
description: "Specify the array of node Ids that links start from.",
|
|
3327
3338
|
type: "array",
|
|
3328
3339
|
items: {
|
|
3329
3340
|
type: "string"
|
|
@@ -3331,7 +3342,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3331
3342
|
},
|
|
3332
3343
|
target: {
|
|
3333
3344
|
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(1)',
|
|
3334
|
-
description: "Specify the array of node Ids
|
|
3345
|
+
description: "Specify the array of node Ids that links go to.",
|
|
3335
3346
|
type: "array",
|
|
3336
3347
|
items: {
|
|
3337
3348
|
type: "string"
|
|
@@ -3339,14 +3350,14 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3339
3350
|
},
|
|
3340
3351
|
nodeIds: {
|
|
3341
3352
|
default: "> source",
|
|
3342
|
-
description: "Specify the array of node Ids
|
|
3353
|
+
description: "Specify the array of node Ids to use for node styling. By default this is the same as the from array.",
|
|
3343
3354
|
type: "array",
|
|
3344
3355
|
items: {
|
|
3345
3356
|
type: "string"
|
|
3346
3357
|
}
|
|
3347
3358
|
},
|
|
3348
3359
|
nodeTypes: {
|
|
3349
|
-
description:
|
|
3360
|
+
description: 'Specify the node type for each node in the nodeIds array. Needed for clustering when layout is "force".',
|
|
3350
3361
|
type: "array",
|
|
3351
3362
|
items: {
|
|
3352
3363
|
type: "string"
|
|
@@ -3354,7 +3365,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3354
3365
|
},
|
|
3355
3366
|
nodeValues: {
|
|
3356
3367
|
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
|
|
3357
|
-
description: "Specify the
|
|
3368
|
+
description: "Specify the node value for each node in the nodeIds array.",
|
|
3358
3369
|
type: "array",
|
|
3359
3370
|
items: {
|
|
3360
3371
|
type: "number"
|
|
@@ -3362,7 +3373,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3362
3373
|
},
|
|
3363
3374
|
nodeTexts: {
|
|
3364
3375
|
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
|
|
3365
|
-
description: "Specify the
|
|
3376
|
+
description: "Specify the text to display under each node in the nodeIds array.",
|
|
3366
3377
|
type: "array",
|
|
3367
3378
|
items: {
|
|
3368
3379
|
type: "string"
|
|
@@ -3378,7 +3389,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3378
3389
|
default: "> themes.defaultNodeColor"
|
|
3379
3390
|
},
|
|
3380
3391
|
nodeSize: {
|
|
3381
|
-
description: "Specify a number
|
|
3392
|
+
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)",
|
|
3382
3393
|
type: ["number", "array"],
|
|
3383
3394
|
items: {
|
|
3384
3395
|
type: "number",
|
|
@@ -3396,7 +3407,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3396
3407
|
default: '> primary | seriesByType("number")'
|
|
3397
3408
|
},
|
|
3398
3409
|
nodeIcons: {
|
|
3399
|
-
description: "Specify the icon used for
|
|
3410
|
+
description: "Specify the icon used for each node (cylinder, portrait, magnifier, etc.).",
|
|
3400
3411
|
type: "array",
|
|
3401
3412
|
items: {
|
|
3402
3413
|
type: "string",
|
|
@@ -3404,7 +3415,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3404
3415
|
}
|
|
3405
3416
|
},
|
|
3406
3417
|
nodeIconColors: {
|
|
3407
|
-
description: "Specify the color used for node
|
|
3418
|
+
description: "Specify the color used for each node icon. You may use a dataSource to apply color dynamically.",
|
|
3408
3419
|
type: ["array", "string"],
|
|
3409
3420
|
items: {
|
|
3410
3421
|
type: "string",
|
|
@@ -3422,7 +3433,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3422
3433
|
},
|
|
3423
3434
|
linkStyle: {
|
|
3424
3435
|
default: "straight",
|
|
3425
|
-
description: "Specify the
|
|
3436
|
+
description: "Specify the link shape (s, z, c, straight).",
|
|
3426
3437
|
type: "string",
|
|
3427
3438
|
pattern: getPattern(["s", "z", "c", "straight"])
|
|
3428
3439
|
},
|
|
@@ -3436,7 +3447,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3436
3447
|
default: "> themes.defaultLinkColor"
|
|
3437
3448
|
},
|
|
3438
3449
|
linkWidth: {
|
|
3439
|
-
description: "Specify a number
|
|
3450
|
+
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.",
|
|
3440
3451
|
type: ["number", "array"],
|
|
3441
3452
|
items: {
|
|
3442
3453
|
type: "number",
|
|
@@ -3467,12 +3478,12 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3467
3478
|
},
|
|
3468
3479
|
nodeHorizontalPadding: {
|
|
3469
3480
|
default: 0,
|
|
3470
|
-
description: "Specify the additional padding between nodes
|
|
3481
|
+
description: "Specify the additional horizontal padding between nodes in pixels (0 - 500).",
|
|
3471
3482
|
type: "number"
|
|
3472
3483
|
},
|
|
3473
3484
|
nodeVerticalPadding: {
|
|
3474
3485
|
default: 0,
|
|
3475
|
-
description: "Specify the additional padding between nodes
|
|
3486
|
+
description: "Specify the additional vertical padding between nodes in pixels (0 - 500).",
|
|
3476
3487
|
type: "number"
|
|
3477
3488
|
},
|
|
3478
3489
|
gridColumns: {
|
|
@@ -3480,27 +3491,27 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3480
3491
|
type: "number"
|
|
3481
3492
|
},
|
|
3482
3493
|
hierarchyDirection: {
|
|
3483
|
-
description: 'When layout is "hierarchical", specify the direction
|
|
3494
|
+
description: 'When layout is "hierarchical", specify the direction (topBottom, bottomTop, leftRight, rightLeft) of the hierarchy.',
|
|
3484
3495
|
default: "leftRight",
|
|
3485
3496
|
pattern: getPattern(["topBottom", "bottomTop", "leftRight", "rightLeft"])
|
|
3486
3497
|
},
|
|
3487
3498
|
chargeStrength: {
|
|
3488
3499
|
default: -30,
|
|
3489
|
-
description: 'When layout is "force", specify the strength of the charge between nodes.
|
|
3500
|
+
description: 'When layout is "force", specify the strength of the charge between nodes. Positive value is attraction and negative value is replusion.',
|
|
3490
3501
|
type: "number"
|
|
3491
3502
|
},
|
|
3492
3503
|
chargeTheta: {
|
|
3493
3504
|
default: 0.9,
|
|
3494
|
-
description: 'When layout is "force", specify the Barnes-Hut approximation parameter.
|
|
3505
|
+
description: 'When layout is "force", specify the Barnes-Hut approximation parameter. Higher value means faster performance but less predictable node positioning.',
|
|
3495
3506
|
type: "number"
|
|
3496
3507
|
},
|
|
3497
3508
|
chargeDistanceMax: {
|
|
3498
|
-
description: 'When layout is "force", specify the maximum distance over which the charge force
|
|
3509
|
+
description: 'When layout is "force", specify the maximum distance over which to apply the charge force.',
|
|
3499
3510
|
type: "number"
|
|
3500
3511
|
},
|
|
3501
3512
|
chargeDistanceMin: {
|
|
3502
3513
|
default: 1,
|
|
3503
|
-
description: 'When layout is "force", specify the minimum distance over which the charge force
|
|
3514
|
+
description: 'When layout is "force", specify the minimum distance over which to apply the charge force.',
|
|
3504
3515
|
type: "number"
|
|
3505
3516
|
},
|
|
3506
3517
|
collidePadding: {
|
|
@@ -3510,10 +3521,12 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3510
3521
|
},
|
|
3511
3522
|
collideStrength: {
|
|
3512
3523
|
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 -
|
|
3524
|
+
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.',
|
|
3514
3525
|
type: "number"
|
|
3515
3526
|
},
|
|
3516
3527
|
clusterStrength: {
|
|
3528
|
+
minimum: 0,
|
|
3529
|
+
maximum: 1,
|
|
3517
3530
|
default: 0.05,
|
|
3518
3531
|
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
3532
|
type: "number"
|
|
@@ -3524,23 +3537,23 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3524
3537
|
type: "number"
|
|
3525
3538
|
},
|
|
3526
3539
|
linkStrength: {
|
|
3527
|
-
|
|
3528
|
-
|
|
3540
|
+
minimum: 0,
|
|
3541
|
+
maximum: 1,
|
|
3542
|
+
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.'
|
|
3529
3543
|
},
|
|
3530
3544
|
tooltipNodeFields: {
|
|
3531
|
-
description: "Specify
|
|
3532
|
-
default: [],
|
|
3545
|
+
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.",
|
|
3533
3546
|
type: "array",
|
|
3534
3547
|
items: {
|
|
3535
3548
|
type: "string"
|
|
3536
3549
|
}
|
|
3537
3550
|
},
|
|
3538
3551
|
tooltipHeaderField: {
|
|
3539
|
-
description: "Specify field to
|
|
3552
|
+
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.",
|
|
3540
3553
|
type: "string"
|
|
3541
3554
|
},
|
|
3542
3555
|
xPositions: {
|
|
3543
|
-
description: 'When layout is "preset", specify the x
|
|
3556
|
+
description: 'When layout is "preset", specify the x position for each node.',
|
|
3544
3557
|
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
|
|
3545
3558
|
type: "array",
|
|
3546
3559
|
items: {
|
|
@@ -3548,7 +3561,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3548
3561
|
}
|
|
3549
3562
|
},
|
|
3550
3563
|
yPositions: {
|
|
3551
|
-
description: 'When layout is "preset", specify the y
|
|
3564
|
+
description: 'When layout is "preset", specify the y position for each node.',
|
|
3552
3565
|
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(1)',
|
|
3553
3566
|
type: "array",
|
|
3554
3567
|
items: {
|
|
@@ -3556,11 +3569,11 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3556
3569
|
}
|
|
3557
3570
|
},
|
|
3558
3571
|
nodeDragPositions: {
|
|
3559
|
-
description: "
|
|
3572
|
+
description: "Stores the positions for nodes by id when the user drags nodes to new positions using the UI.",
|
|
3560
3573
|
type: "object"
|
|
3561
3574
|
},
|
|
3562
3575
|
preferPorts: {
|
|
3563
|
-
description: "Specify the preferred port alignment for s and z
|
|
3576
|
+
description: "Specify the preferred port alignment for s and z links (horizontal, vertical, none).",
|
|
3564
3577
|
type: "string",
|
|
3565
3578
|
pattern: getPattern(["horizontal", "vertical", "none"])
|
|
3566
3579
|
},
|
|
@@ -3571,7 +3584,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3571
3584
|
},
|
|
3572
3585
|
resultLimit: {
|
|
3573
3586
|
default: 1e3,
|
|
3574
|
-
description: "Specify the maximum
|
|
3587
|
+
description: "Specify the maximum number of link data points rendered (hard limit 10,000).",
|
|
3575
3588
|
type: "number"
|
|
3576
3589
|
}
|
|
3577
3590
|
});
|
|
@@ -3620,6 +3633,12 @@ var pieOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3620
3633
|
type: "string",
|
|
3621
3634
|
default: "other"
|
|
3622
3635
|
},
|
|
3636
|
+
legendDisplay: {
|
|
3637
|
+
default: "off",
|
|
3638
|
+
description: "Specify the location of the legend on the panel.",
|
|
3639
|
+
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
3640
|
+
type: "string"
|
|
3641
|
+
},
|
|
3623
3642
|
collapseThreshold: {
|
|
3624
3643
|
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.",
|
|
3625
3644
|
type: "number",
|