@splunk/visualization-schemas 28.3.0 → 28.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
|
@@ -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,
|
|
@@ -442,7 +443,7 @@ var areaOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
442
443
|
items: { type: ["string", "number"] }
|
|
443
444
|
},
|
|
444
445
|
areaOpacity: {
|
|
445
|
-
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.",
|
|
446
447
|
type: "number",
|
|
447
448
|
default: 0.75
|
|
448
449
|
},
|
|
@@ -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.',
|
|
@@ -2275,7 +2271,7 @@ var fillerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2275
2271
|
type: "string"
|
|
2276
2272
|
},
|
|
2277
2273
|
majorTickInterval: {
|
|
2278
|
-
description: "Specify
|
|
2274
|
+
description: "Specify the interval between major tick marks.",
|
|
2279
2275
|
default: "auto",
|
|
2280
2276
|
type: ["string", "number"]
|
|
2281
2277
|
},
|
|
@@ -2465,6 +2461,17 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2465
2461
|
"longDash", "dashDot", "longDashDot", "longDashDotDot".`,
|
|
2466
2462
|
type: "object"
|
|
2467
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
|
+
},
|
|
2468
2475
|
lineWidth: {
|
|
2469
2476
|
default: 2,
|
|
2470
2477
|
description: "Specify the line width (px), for all line series.",
|
|
@@ -2763,25 +2770,21 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2763
2770
|
description: "Specify the spacing unit between major tick marks along the numeric y2-axis.",
|
|
2764
2771
|
type: ["string", "number"]
|
|
2765
2772
|
},
|
|
2766
|
-
// TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
|
|
2767
2773
|
yAxisMax: {
|
|
2768
2774
|
default: "auto",
|
|
2769
2775
|
description: "Specify the maximum number for the visible y-axis range.",
|
|
2770
2776
|
type: ["string", "number"]
|
|
2771
2777
|
},
|
|
2772
|
-
// TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
|
|
2773
2778
|
y2AxisMax: {
|
|
2774
2779
|
default: "auto",
|
|
2775
2780
|
description: "Specify the maximum number for the visible y2-axis range.",
|
|
2776
2781
|
type: ["string", "number"]
|
|
2777
2782
|
},
|
|
2778
|
-
// TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
|
|
2779
2783
|
yAxisMin: {
|
|
2780
2784
|
default: "auto",
|
|
2781
2785
|
description: "Specify the minimum number for the visible y-axis range.",
|
|
2782
2786
|
type: ["string", "number"]
|
|
2783
2787
|
},
|
|
2784
|
-
// TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
|
|
2785
2788
|
y2AxisMin: {
|
|
2786
2789
|
default: "auto",
|
|
2787
2790
|
description: "Specify the minimum number for the visible y2-axis range.",
|
|
@@ -2799,7 +2802,6 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2799
2802
|
pattern: getPattern(["linear", "log"]),
|
|
2800
2803
|
type: "string"
|
|
2801
2804
|
},
|
|
2802
|
-
// TODO: Figure out a way to explicitly support string value in addition to an array of strings
|
|
2803
2805
|
// as UDF won't allow users to proceed if a string value is entered due to schema validation
|
|
2804
2806
|
overlayFields: {
|
|
2805
2807
|
description: "Specify field(s) that should be differentiated on the chart and displayed as chart overlays.",
|
|
@@ -2867,6 +2869,12 @@ var linkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2867
2869
|
type: "string",
|
|
2868
2870
|
default: "> nodeColor | maxContrast(nodeTextColorMaxContrast)"
|
|
2869
2871
|
},
|
|
2872
|
+
nodeLabelOverflow: {
|
|
2873
|
+
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.',
|
|
2874
|
+
type: "string",
|
|
2875
|
+
pattern: getPattern(validTextOverflows),
|
|
2876
|
+
default: "ellipsis"
|
|
2877
|
+
},
|
|
2870
2878
|
nodeHeight: {
|
|
2871
2879
|
default: 21,
|
|
2872
2880
|
description: "Specify, in pixels, the height of each node.",
|
|
@@ -3317,7 +3325,7 @@ var markerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3317
3325
|
pattern: getPattern(["number", "percentage", "off"])
|
|
3318
3326
|
},
|
|
3319
3327
|
majorTickInterval: {
|
|
3320
|
-
description: "Specify
|
|
3328
|
+
description: "Specify the interval between major tick marks.",
|
|
3321
3329
|
default: "auto",
|
|
3322
3330
|
type: ["string", "number"]
|
|
3323
3331
|
},
|
|
@@ -3337,6 +3345,308 @@ var markerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3337
3345
|
default: "number",
|
|
3338
3346
|
type: "string",
|
|
3339
3347
|
pattern: getPattern(["number", "percentage", "off"])
|
|
3348
|
+
},
|
|
3349
|
+
splitByLayout: {
|
|
3350
|
+
default: "off",
|
|
3351
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
3352
|
+
type: "string",
|
|
3353
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
3354
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
3355
|
+
},
|
|
3356
|
+
trellisBackgroundColor: {
|
|
3357
|
+
default: "> themes.defaultBackgroundColor",
|
|
3358
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
3359
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
3360
|
+
type: "string"
|
|
3361
|
+
},
|
|
3362
|
+
trellisColumns: {
|
|
3363
|
+
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.",
|
|
3364
|
+
type: "number",
|
|
3365
|
+
minimum: 1,
|
|
3366
|
+
default: 3
|
|
3367
|
+
},
|
|
3368
|
+
trellisMinColumnWidth: {
|
|
3369
|
+
default: 200,
|
|
3370
|
+
minimum: 1,
|
|
3371
|
+
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.",
|
|
3372
|
+
type: "number"
|
|
3373
|
+
},
|
|
3374
|
+
trellisPageCount: {
|
|
3375
|
+
default: 20,
|
|
3376
|
+
minimum: 1,
|
|
3377
|
+
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.",
|
|
3378
|
+
type: "number"
|
|
3379
|
+
},
|
|
3380
|
+
trellisRowHeight: {
|
|
3381
|
+
default: 200,
|
|
3382
|
+
minimum: 1,
|
|
3383
|
+
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.",
|
|
3384
|
+
type: "number"
|
|
3385
|
+
},
|
|
3386
|
+
trellisSplitBy: {
|
|
3387
|
+
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.',
|
|
3388
|
+
type: "string"
|
|
3389
|
+
}
|
|
3390
|
+
});
|
|
3391
|
+
|
|
3392
|
+
// src/optionsSchemas/networkGraph.ts
|
|
3393
|
+
var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
3394
|
+
backgroundColor: {
|
|
3395
|
+
default: "> themes.defaultBackgroundColor",
|
|
3396
|
+
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".',
|
|
3397
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
3398
|
+
type: "string"
|
|
3399
|
+
},
|
|
3400
|
+
source: {
|
|
3401
|
+
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
|
|
3402
|
+
description: "Specify the array of node Ids that links start from.",
|
|
3403
|
+
type: "array",
|
|
3404
|
+
items: {
|
|
3405
|
+
type: "string"
|
|
3406
|
+
}
|
|
3407
|
+
},
|
|
3408
|
+
target: {
|
|
3409
|
+
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(1)',
|
|
3410
|
+
description: "Specify the array of node Ids that links go to.",
|
|
3411
|
+
type: "array",
|
|
3412
|
+
items: {
|
|
3413
|
+
type: "string"
|
|
3414
|
+
}
|
|
3415
|
+
},
|
|
3416
|
+
nodeIds: {
|
|
3417
|
+
default: "> source",
|
|
3418
|
+
description: "Specify the array of node Ids to use for node styling. By default this is the same as the from array.",
|
|
3419
|
+
type: "array",
|
|
3420
|
+
items: {
|
|
3421
|
+
type: "string"
|
|
3422
|
+
}
|
|
3423
|
+
},
|
|
3424
|
+
nodeTypes: {
|
|
3425
|
+
description: 'Specify the node type for each node in the nodeIds array. Needed for clustering when layout is "force".',
|
|
3426
|
+
type: "array",
|
|
3427
|
+
items: {
|
|
3428
|
+
type: "string"
|
|
3429
|
+
}
|
|
3430
|
+
},
|
|
3431
|
+
nodeValues: {
|
|
3432
|
+
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
|
|
3433
|
+
description: "Specify the node value for each node in the nodeIds array.",
|
|
3434
|
+
type: "array",
|
|
3435
|
+
items: {
|
|
3436
|
+
type: "number"
|
|
3437
|
+
}
|
|
3438
|
+
},
|
|
3439
|
+
nodeTexts: {
|
|
3440
|
+
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
|
|
3441
|
+
description: "Specify the text to display under each node in the nodeIds array.",
|
|
3442
|
+
type: "array",
|
|
3443
|
+
items: {
|
|
3444
|
+
type: "string"
|
|
3445
|
+
}
|
|
3446
|
+
},
|
|
3447
|
+
nodeColors: {
|
|
3448
|
+
description: "Specify the color used for nodes. You may use a dataSource to apply color dynamically.",
|
|
3449
|
+
type: ["string", "array"],
|
|
3450
|
+
items: {
|
|
3451
|
+
type: "string",
|
|
3452
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
|
|
3453
|
+
},
|
|
3454
|
+
default: "> themes.defaultNodeColor"
|
|
3455
|
+
},
|
|
3456
|
+
nodeSize: {
|
|
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)",
|
|
3458
|
+
type: ["number", "array"],
|
|
3459
|
+
items: {
|
|
3460
|
+
type: "number",
|
|
3461
|
+
minimum: 8,
|
|
3462
|
+
maximum: 200
|
|
3463
|
+
},
|
|
3464
|
+
default: 48
|
|
3465
|
+
},
|
|
3466
|
+
nodeColorValues: {
|
|
3467
|
+
description: "Specify the array of values used for dynamic node coloring.",
|
|
3468
|
+
type: "array",
|
|
3469
|
+
items: {
|
|
3470
|
+
type: ["string", "number"]
|
|
3471
|
+
},
|
|
3472
|
+
default: '> primary | seriesByType("number")'
|
|
3473
|
+
},
|
|
3474
|
+
nodeIcons: {
|
|
3475
|
+
description: "Specify the icon used for each node (cylinder, portrait, magnifier, etc.).",
|
|
3476
|
+
type: "array",
|
|
3477
|
+
items: {
|
|
3478
|
+
type: "string",
|
|
3479
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
|
|
3480
|
+
}
|
|
3481
|
+
},
|
|
3482
|
+
nodeIconColors: {
|
|
3483
|
+
description: "Specify the color used for each node icon. You may use a dataSource to apply color dynamically.",
|
|
3484
|
+
type: ["array", "string"],
|
|
3485
|
+
items: {
|
|
3486
|
+
type: "string",
|
|
3487
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
|
|
3488
|
+
},
|
|
3489
|
+
default: "> themes.defaultNodeIconColor"
|
|
3490
|
+
},
|
|
3491
|
+
nodeIconColorValues: {
|
|
3492
|
+
description: "Specify the array of values used for dynamic node icon coloring.",
|
|
3493
|
+
type: "array",
|
|
3494
|
+
items: {
|
|
3495
|
+
type: ["string", "number"]
|
|
3496
|
+
},
|
|
3497
|
+
default: '> primary | seriesByType("number")'
|
|
3498
|
+
},
|
|
3499
|
+
linkStyle: {
|
|
3500
|
+
default: "straight",
|
|
3501
|
+
description: "Specify the link shape (s, z, c, straight).",
|
|
3502
|
+
type: "string",
|
|
3503
|
+
pattern: getPattern(["s", "z", "c", "straight"])
|
|
3504
|
+
},
|
|
3505
|
+
linkColors: {
|
|
3506
|
+
description: "Specify the color used for links. You may use a dataSource to apply color dynamically.",
|
|
3507
|
+
type: ["array", "string"],
|
|
3508
|
+
items: {
|
|
3509
|
+
type: "string",
|
|
3510
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
|
|
3511
|
+
},
|
|
3512
|
+
default: "> themes.defaultLinkColor"
|
|
3513
|
+
},
|
|
3514
|
+
linkWidth: {
|
|
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.",
|
|
3516
|
+
type: ["number", "array"],
|
|
3517
|
+
items: {
|
|
3518
|
+
type: "number",
|
|
3519
|
+
minimum: 1,
|
|
3520
|
+
maximum: 20
|
|
3521
|
+
},
|
|
3522
|
+
default: 2
|
|
3523
|
+
},
|
|
3524
|
+
linkColorValues: {
|
|
3525
|
+
description: "Specify the array of values used for dynamic link coloring.",
|
|
3526
|
+
type: "array",
|
|
3527
|
+
items: {
|
|
3528
|
+
type: ["string", "number"]
|
|
3529
|
+
},
|
|
3530
|
+
default: '> primary | seriesByType("number")'
|
|
3531
|
+
},
|
|
3532
|
+
showDirection: {
|
|
3533
|
+
default: "bidirection",
|
|
3534
|
+
description: "Specify the directionality of the links. Choose between bidirection, oneWay, none. z and s linkStyles look better with bidirection instead of oneWay.",
|
|
3535
|
+
type: "string",
|
|
3536
|
+
pattern: getPattern(["bidirection", "oneWay", "none"])
|
|
3537
|
+
},
|
|
3538
|
+
layout: {
|
|
3539
|
+
default: "grid",
|
|
3540
|
+
description: "Specify the layout used for the graph. Choose between preset, grid, hierarchical",
|
|
3541
|
+
type: "string",
|
|
3542
|
+
pattern: getPattern(["preset", "grid", "hierarchical", "force"])
|
|
3543
|
+
},
|
|
3544
|
+
nodeHorizontalPadding: {
|
|
3545
|
+
default: 0,
|
|
3546
|
+
description: "Specify the additional horizontal padding between nodes in pixels (0 - 500).",
|
|
3547
|
+
type: "number"
|
|
3548
|
+
},
|
|
3549
|
+
nodeVerticalPadding: {
|
|
3550
|
+
default: 0,
|
|
3551
|
+
description: "Specify the additional vertical padding between nodes in pixels (0 - 500).",
|
|
3552
|
+
type: "number"
|
|
3553
|
+
},
|
|
3554
|
+
gridColumns: {
|
|
3555
|
+
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',
|
|
3556
|
+
type: "number"
|
|
3557
|
+
},
|
|
3558
|
+
hierarchyDirection: {
|
|
3559
|
+
description: 'When layout is "hierarchical", specify the direction (topBottom, bottomTop, leftRight, rightLeft) of the hierarchy.',
|
|
3560
|
+
default: "leftRight",
|
|
3561
|
+
pattern: getPattern(["topBottom", "bottomTop", "leftRight", "rightLeft"])
|
|
3562
|
+
},
|
|
3563
|
+
chargeStrength: {
|
|
3564
|
+
default: -30,
|
|
3565
|
+
description: 'When layout is "force", specify the strength of the charge between nodes. Positive value is attraction and negative value is replusion.',
|
|
3566
|
+
type: "number"
|
|
3567
|
+
},
|
|
3568
|
+
chargeTheta: {
|
|
3569
|
+
default: 0.9,
|
|
3570
|
+
description: 'When layout is "force", specify the Barnes-Hut approximation parameter. Higher value means faster performance but less predictable node positioning.',
|
|
3571
|
+
type: "number"
|
|
3572
|
+
},
|
|
3573
|
+
chargeDistanceMax: {
|
|
3574
|
+
description: 'When layout is "force", specify the maximum distance over which to apply the charge force.',
|
|
3575
|
+
type: "number"
|
|
3576
|
+
},
|
|
3577
|
+
chargeDistanceMin: {
|
|
3578
|
+
default: 1,
|
|
3579
|
+
description: 'When layout is "force", specify the minimum distance over which to apply the charge force.',
|
|
3580
|
+
type: "number"
|
|
3581
|
+
},
|
|
3582
|
+
collidePadding: {
|
|
3583
|
+
default: 10,
|
|
3584
|
+
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.',
|
|
3585
|
+
type: "number"
|
|
3586
|
+
},
|
|
3587
|
+
collideStrength: {
|
|
3588
|
+
default: 1,
|
|
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 - 5 but there is no hard limit.',
|
|
3590
|
+
type: "number"
|
|
3591
|
+
},
|
|
3592
|
+
clusterStrength: {
|
|
3593
|
+
default: 0.05,
|
|
3594
|
+
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',
|
|
3595
|
+
type: "number"
|
|
3596
|
+
},
|
|
3597
|
+
linkDistance: {
|
|
3598
|
+
default: 30,
|
|
3599
|
+
description: 'When layout is "force", specify the ideal distance between linked nodes. A higher value results in more space between linked nodes.',
|
|
3600
|
+
type: "number"
|
|
3601
|
+
},
|
|
3602
|
+
linkStrength: {
|
|
3603
|
+
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.'
|
|
3604
|
+
},
|
|
3605
|
+
tooltipNodeFields: {
|
|
3606
|
+
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.",
|
|
3607
|
+
type: "array",
|
|
3608
|
+
items: {
|
|
3609
|
+
type: "string"
|
|
3610
|
+
}
|
|
3611
|
+
},
|
|
3612
|
+
tooltipHeaderField: {
|
|
3613
|
+
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.",
|
|
3614
|
+
type: "string"
|
|
3615
|
+
},
|
|
3616
|
+
xPositions: {
|
|
3617
|
+
description: 'When layout is "preset", specify the x position for each node.',
|
|
3618
|
+
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
|
|
3619
|
+
type: "array",
|
|
3620
|
+
items: {
|
|
3621
|
+
type: "number"
|
|
3622
|
+
}
|
|
3623
|
+
},
|
|
3624
|
+
yPositions: {
|
|
3625
|
+
description: 'When layout is "preset", specify the y position for each node.',
|
|
3626
|
+
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(1)',
|
|
3627
|
+
type: "array",
|
|
3628
|
+
items: {
|
|
3629
|
+
type: "number"
|
|
3630
|
+
}
|
|
3631
|
+
},
|
|
3632
|
+
nodeDragPositions: {
|
|
3633
|
+
description: "Stores the positions for nodes by id when the user drags nodes to new positions using the UI.",
|
|
3634
|
+
type: "object"
|
|
3635
|
+
},
|
|
3636
|
+
preferPorts: {
|
|
3637
|
+
description: "Specify the preferred port alignment for s and z links (horizontal, vertical, none).",
|
|
3638
|
+
type: "string",
|
|
3639
|
+
pattern: getPattern(["horizontal", "vertical", "none"])
|
|
3640
|
+
},
|
|
3641
|
+
showZoomControls: {
|
|
3642
|
+
default: true,
|
|
3643
|
+
description: "Specify whether to show the zoom controls on the graph.",
|
|
3644
|
+
type: "boolean"
|
|
3645
|
+
},
|
|
3646
|
+
resultLimit: {
|
|
3647
|
+
default: 1e3,
|
|
3648
|
+
description: "Specify the maximum number of link data points rendered (hard limit 10,000).",
|
|
3649
|
+
type: "number"
|
|
3340
3650
|
}
|
|
3341
3651
|
});
|
|
3342
3652
|
|
|
@@ -3384,6 +3694,12 @@ var pieOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3384
3694
|
type: "string",
|
|
3385
3695
|
default: "other"
|
|
3386
3696
|
},
|
|
3697
|
+
legendDisplay: {
|
|
3698
|
+
default: "off",
|
|
3699
|
+
description: "Specify the location of the legend on the panel.",
|
|
3700
|
+
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
3701
|
+
type: "string"
|
|
3702
|
+
},
|
|
3387
3703
|
collapseThreshold: {
|
|
3388
3704
|
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.",
|
|
3389
3705
|
type: "number",
|
|
@@ -3830,7 +4146,6 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3830
4146
|
description: "Specify whether to round x-axis values to the nearest integer.",
|
|
3831
4147
|
type: "boolean"
|
|
3832
4148
|
},
|
|
3833
|
-
// TODO: figure out if we want to change splunk-charting behavior for Bubble/Scatter, which hardcodes XMajorGridlines to false
|
|
3834
4149
|
// showXMajorGridLines: {
|
|
3835
4150
|
// default: false,
|
|
3836
4151
|
// description: 'Specify whether major grid lines are visible on the x-axis.',
|
|
@@ -4111,9 +4426,15 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4111
4426
|
},
|
|
4112
4427
|
shouldSparklineAcceptNullData: {
|
|
4113
4428
|
default: true,
|
|
4114
|
-
description: "Specify whether to convert null and non-numeric values in the sparkline to 0.",
|
|
4429
|
+
description: "Deprecated: Use sparklineNullValueDisplay instead. Specify whether to convert null and non-numeric values in the sparkline to 0.",
|
|
4115
4430
|
type: "boolean"
|
|
4116
4431
|
},
|
|
4432
|
+
sparklineNullValueDisplay: {
|
|
4433
|
+
default: "gaps",
|
|
4434
|
+
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.',
|
|
4435
|
+
pattern: getPattern(["gaps", "zero", "connect"]),
|
|
4436
|
+
type: "string"
|
|
4437
|
+
},
|
|
4117
4438
|
shouldUseThousandSeparators: {
|
|
4118
4439
|
default: true,
|
|
4119
4440
|
description: "Specify whether numeric values use commas as thousandths separators.",
|
|
@@ -4188,7 +4509,6 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4188
4509
|
},
|
|
4189
4510
|
trendValue: {
|
|
4190
4511
|
default: "> sparklineValues|delta(-2)",
|
|
4191
|
-
// todo: may need update delta method
|
|
4192
4512
|
description: "The trend value to display in the visualization.",
|
|
4193
4513
|
type: "number"
|
|
4194
4514
|
},
|
|
@@ -4358,7 +4678,6 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4358
4678
|
},
|
|
4359
4679
|
trendValue: {
|
|
4360
4680
|
default: '> primary|seriesByPrioritizedTypes("number", "string", "time")|delta(-2)',
|
|
4361
|
-
// todo: may need update delta method
|
|
4362
4681
|
description: "The trend value to display in the visualization.",
|
|
4363
4682
|
type: "number"
|
|
4364
4683
|
},
|
|
@@ -4530,7 +4849,6 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4530
4849
|
},
|
|
4531
4850
|
trendValue: {
|
|
4532
4851
|
default: '> primary | seriesByPrioritizedTypes("number", "string", "time") | delta(-2)',
|
|
4533
|
-
// todo: may need update delta method
|
|
4534
4852
|
description: "Specify the dataSource applied to the trend value.",
|
|
4535
4853
|
type: "number"
|
|
4536
4854
|
},
|
|
@@ -4680,6 +4998,12 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4680
4998
|
enum: validSparklineTypes.concat()
|
|
4681
4999
|
}
|
|
4682
5000
|
},
|
|
5001
|
+
sparklineNullValueDisplay: {
|
|
5002
|
+
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.',
|
|
5003
|
+
type: "string",
|
|
5004
|
+
default: "gaps",
|
|
5005
|
+
pattern: getPattern(["gaps", "zero", "connect"])
|
|
5006
|
+
},
|
|
4683
5007
|
textOverflow: {
|
|
4684
5008
|
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
5009
|
type: "string",
|
|
@@ -4884,6 +5208,12 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4884
5208
|
}
|
|
4885
5209
|
}
|
|
4886
5210
|
},
|
|
5211
|
+
sparklineNullValueDisplay: {
|
|
5212
|
+
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.',
|
|
5213
|
+
type: "string",
|
|
5214
|
+
default: "gaps",
|
|
5215
|
+
pattern: getPattern(["gaps", "zero", "connect"])
|
|
5216
|
+
},
|
|
4887
5217
|
textOverflow: {
|
|
4888
5218
|
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
5219
|
type: "string",
|