@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/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
|
},
|
|
@@ -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.',
|
|
@@ -2211,7 +2206,7 @@ var fillerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2211
2206
|
type: "string"
|
|
2212
2207
|
},
|
|
2213
2208
|
majorTickInterval: {
|
|
2214
|
-
description: "Specify
|
|
2209
|
+
description: "Specify the interval between major tick marks.",
|
|
2215
2210
|
default: "auto",
|
|
2216
2211
|
type: ["string", "number"]
|
|
2217
2212
|
},
|
|
@@ -2401,6 +2396,17 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2401
2396
|
"longDash", "dashDot", "longDashDot", "longDashDotDot".`,
|
|
2402
2397
|
type: "object"
|
|
2403
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
|
+
},
|
|
2404
2410
|
lineWidth: {
|
|
2405
2411
|
default: 2,
|
|
2406
2412
|
description: "Specify the line width (px), for all line series.",
|
|
@@ -2699,25 +2705,21 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2699
2705
|
description: "Specify the spacing unit between major tick marks along the numeric y2-axis.",
|
|
2700
2706
|
type: ["string", "number"]
|
|
2701
2707
|
},
|
|
2702
|
-
// TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
|
|
2703
2708
|
yAxisMax: {
|
|
2704
2709
|
default: "auto",
|
|
2705
2710
|
description: "Specify the maximum number for the visible y-axis range.",
|
|
2706
2711
|
type: ["string", "number"]
|
|
2707
2712
|
},
|
|
2708
|
-
// TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
|
|
2709
2713
|
y2AxisMax: {
|
|
2710
2714
|
default: "auto",
|
|
2711
2715
|
description: "Specify the maximum number for the visible y2-axis range.",
|
|
2712
2716
|
type: ["string", "number"]
|
|
2713
2717
|
},
|
|
2714
|
-
// TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
|
|
2715
2718
|
yAxisMin: {
|
|
2716
2719
|
default: "auto",
|
|
2717
2720
|
description: "Specify the minimum number for the visible y-axis range.",
|
|
2718
2721
|
type: ["string", "number"]
|
|
2719
2722
|
},
|
|
2720
|
-
// TODO(SCP-40274): Restrict string value to only 'auto' to achieve precise schema validation
|
|
2721
2723
|
y2AxisMin: {
|
|
2722
2724
|
default: "auto",
|
|
2723
2725
|
description: "Specify the minimum number for the visible y2-axis range.",
|
|
@@ -2735,7 +2737,6 @@ var lineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2735
2737
|
pattern: getPattern(["linear", "log"]),
|
|
2736
2738
|
type: "string"
|
|
2737
2739
|
},
|
|
2738
|
-
// TODO: Figure out a way to explicitly support string value in addition to an array of strings
|
|
2739
2740
|
// as UDF won't allow users to proceed if a string value is entered due to schema validation
|
|
2740
2741
|
overlayFields: {
|
|
2741
2742
|
description: "Specify field(s) that should be differentiated on the chart and displayed as chart overlays.",
|
|
@@ -2803,6 +2804,12 @@ var linkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
2803
2804
|
type: "string",
|
|
2804
2805
|
default: "> nodeColor | maxContrast(nodeTextColorMaxContrast)"
|
|
2805
2806
|
},
|
|
2807
|
+
nodeLabelOverflow: {
|
|
2808
|
+
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.',
|
|
2809
|
+
type: "string",
|
|
2810
|
+
pattern: getPattern(validTextOverflows),
|
|
2811
|
+
default: "ellipsis"
|
|
2812
|
+
},
|
|
2806
2813
|
nodeHeight: {
|
|
2807
2814
|
default: 21,
|
|
2808
2815
|
description: "Specify, in pixels, the height of each node.",
|
|
@@ -3253,7 +3260,7 @@ var markerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3253
3260
|
pattern: getPattern(["number", "percentage", "off"])
|
|
3254
3261
|
},
|
|
3255
3262
|
majorTickInterval: {
|
|
3256
|
-
description: "Specify
|
|
3263
|
+
description: "Specify the interval between major tick marks.",
|
|
3257
3264
|
default: "auto",
|
|
3258
3265
|
type: ["string", "number"]
|
|
3259
3266
|
},
|
|
@@ -3273,6 +3280,308 @@ var markerGaugeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3273
3280
|
default: "number",
|
|
3274
3281
|
type: "string",
|
|
3275
3282
|
pattern: getPattern(["number", "percentage", "off"])
|
|
3283
|
+
},
|
|
3284
|
+
splitByLayout: {
|
|
3285
|
+
default: "off",
|
|
3286
|
+
description: "Specify the layout method by which to display the visualization, which splits the data into individual visualizations based on a certain category.",
|
|
3287
|
+
type: "string",
|
|
3288
|
+
pattern: getPattern(["off" /* Off */, "trellis" /* Trellis */]),
|
|
3289
|
+
enum: ["off" /* Off */, "trellis" /* Trellis */]
|
|
3290
|
+
},
|
|
3291
|
+
trellisBackgroundColor: {
|
|
3292
|
+
default: "> themes.defaultBackgroundColor",
|
|
3293
|
+
description: "Specify the color used for the trellis container background by using a hexadecimal code. For example, #0000FF.",
|
|
3294
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
3295
|
+
type: "string"
|
|
3296
|
+
},
|
|
3297
|
+
trellisColumns: {
|
|
3298
|
+
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.",
|
|
3299
|
+
type: "number",
|
|
3300
|
+
minimum: 1,
|
|
3301
|
+
default: 3
|
|
3302
|
+
},
|
|
3303
|
+
trellisMinColumnWidth: {
|
|
3304
|
+
default: 200,
|
|
3305
|
+
minimum: 1,
|
|
3306
|
+
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.",
|
|
3307
|
+
type: "number"
|
|
3308
|
+
},
|
|
3309
|
+
trellisPageCount: {
|
|
3310
|
+
default: 20,
|
|
3311
|
+
minimum: 1,
|
|
3312
|
+
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.",
|
|
3313
|
+
type: "number"
|
|
3314
|
+
},
|
|
3315
|
+
trellisRowHeight: {
|
|
3316
|
+
default: 200,
|
|
3317
|
+
minimum: 1,
|
|
3318
|
+
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.",
|
|
3319
|
+
type: "number"
|
|
3320
|
+
},
|
|
3321
|
+
trellisSplitBy: {
|
|
3322
|
+
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.',
|
|
3323
|
+
type: "string"
|
|
3324
|
+
}
|
|
3325
|
+
});
|
|
3326
|
+
|
|
3327
|
+
// src/optionsSchemas/networkGraph.ts
|
|
3328
|
+
var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
3329
|
+
backgroundColor: {
|
|
3330
|
+
default: "> themes.defaultBackgroundColor",
|
|
3331
|
+
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".',
|
|
3332
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
|
|
3333
|
+
type: "string"
|
|
3334
|
+
},
|
|
3335
|
+
source: {
|
|
3336
|
+
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
|
|
3337
|
+
description: "Specify the array of node Ids that links start from.",
|
|
3338
|
+
type: "array",
|
|
3339
|
+
items: {
|
|
3340
|
+
type: "string"
|
|
3341
|
+
}
|
|
3342
|
+
},
|
|
3343
|
+
target: {
|
|
3344
|
+
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(1)',
|
|
3345
|
+
description: "Specify the array of node Ids that links go to.",
|
|
3346
|
+
type: "array",
|
|
3347
|
+
items: {
|
|
3348
|
+
type: "string"
|
|
3349
|
+
}
|
|
3350
|
+
},
|
|
3351
|
+
nodeIds: {
|
|
3352
|
+
default: "> source",
|
|
3353
|
+
description: "Specify the array of node Ids to use for node styling. By default this is the same as the from array.",
|
|
3354
|
+
type: "array",
|
|
3355
|
+
items: {
|
|
3356
|
+
type: "string"
|
|
3357
|
+
}
|
|
3358
|
+
},
|
|
3359
|
+
nodeTypes: {
|
|
3360
|
+
description: 'Specify the node type for each node in the nodeIds array. Needed for clustering when layout is "force".',
|
|
3361
|
+
type: "array",
|
|
3362
|
+
items: {
|
|
3363
|
+
type: "string"
|
|
3364
|
+
}
|
|
3365
|
+
},
|
|
3366
|
+
nodeValues: {
|
|
3367
|
+
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
|
|
3368
|
+
description: "Specify the node value for each node in the nodeIds array.",
|
|
3369
|
+
type: "array",
|
|
3370
|
+
items: {
|
|
3371
|
+
type: "number"
|
|
3372
|
+
}
|
|
3373
|
+
},
|
|
3374
|
+
nodeTexts: {
|
|
3375
|
+
default: '> primary | frameBySeriesTypes("string") | seriesByIndex(0)',
|
|
3376
|
+
description: "Specify the text to display under each node in the nodeIds array.",
|
|
3377
|
+
type: "array",
|
|
3378
|
+
items: {
|
|
3379
|
+
type: "string"
|
|
3380
|
+
}
|
|
3381
|
+
},
|
|
3382
|
+
nodeColors: {
|
|
3383
|
+
description: "Specify the color used for nodes. You may use a dataSource to apply color dynamically.",
|
|
3384
|
+
type: ["string", "array"],
|
|
3385
|
+
items: {
|
|
3386
|
+
type: "string",
|
|
3387
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
|
|
3388
|
+
},
|
|
3389
|
+
default: "> themes.defaultNodeColor"
|
|
3390
|
+
},
|
|
3391
|
+
nodeSize: {
|
|
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)",
|
|
3393
|
+
type: ["number", "array"],
|
|
3394
|
+
items: {
|
|
3395
|
+
type: "number",
|
|
3396
|
+
minimum: 8,
|
|
3397
|
+
maximum: 200
|
|
3398
|
+
},
|
|
3399
|
+
default: 48
|
|
3400
|
+
},
|
|
3401
|
+
nodeColorValues: {
|
|
3402
|
+
description: "Specify the array of values used for dynamic node coloring.",
|
|
3403
|
+
type: "array",
|
|
3404
|
+
items: {
|
|
3405
|
+
type: ["string", "number"]
|
|
3406
|
+
},
|
|
3407
|
+
default: '> primary | seriesByType("number")'
|
|
3408
|
+
},
|
|
3409
|
+
nodeIcons: {
|
|
3410
|
+
description: "Specify the icon used for each node (cylinder, portrait, magnifier, etc.).",
|
|
3411
|
+
type: "array",
|
|
3412
|
+
items: {
|
|
3413
|
+
type: "string",
|
|
3414
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
|
|
3415
|
+
}
|
|
3416
|
+
},
|
|
3417
|
+
nodeIconColors: {
|
|
3418
|
+
description: "Specify the color used for each node icon. You may use a dataSource to apply color dynamically.",
|
|
3419
|
+
type: ["array", "string"],
|
|
3420
|
+
items: {
|
|
3421
|
+
type: "string",
|
|
3422
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
|
|
3423
|
+
},
|
|
3424
|
+
default: "> themes.defaultNodeIconColor"
|
|
3425
|
+
},
|
|
3426
|
+
nodeIconColorValues: {
|
|
3427
|
+
description: "Specify the array of values used for dynamic node icon coloring.",
|
|
3428
|
+
type: "array",
|
|
3429
|
+
items: {
|
|
3430
|
+
type: ["string", "number"]
|
|
3431
|
+
},
|
|
3432
|
+
default: '> primary | seriesByType("number")'
|
|
3433
|
+
},
|
|
3434
|
+
linkStyle: {
|
|
3435
|
+
default: "straight",
|
|
3436
|
+
description: "Specify the link shape (s, z, c, straight).",
|
|
3437
|
+
type: "string",
|
|
3438
|
+
pattern: getPattern(["s", "z", "c", "straight"])
|
|
3439
|
+
},
|
|
3440
|
+
linkColors: {
|
|
3441
|
+
description: "Specify the color used for links. You may use a dataSource to apply color dynamically.",
|
|
3442
|
+
type: ["array", "string"],
|
|
3443
|
+
items: {
|
|
3444
|
+
type: "string",
|
|
3445
|
+
pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA
|
|
3446
|
+
},
|
|
3447
|
+
default: "> themes.defaultLinkColor"
|
|
3448
|
+
},
|
|
3449
|
+
linkWidth: {
|
|
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.",
|
|
3451
|
+
type: ["number", "array"],
|
|
3452
|
+
items: {
|
|
3453
|
+
type: "number",
|
|
3454
|
+
minimum: 1,
|
|
3455
|
+
maximum: 20
|
|
3456
|
+
},
|
|
3457
|
+
default: 2
|
|
3458
|
+
},
|
|
3459
|
+
linkColorValues: {
|
|
3460
|
+
description: "Specify the array of values used for dynamic link coloring.",
|
|
3461
|
+
type: "array",
|
|
3462
|
+
items: {
|
|
3463
|
+
type: ["string", "number"]
|
|
3464
|
+
},
|
|
3465
|
+
default: '> primary | seriesByType("number")'
|
|
3466
|
+
},
|
|
3467
|
+
showDirection: {
|
|
3468
|
+
default: "bidirection",
|
|
3469
|
+
description: "Specify the directionality of the links. Choose between bidirection, oneWay, none. z and s linkStyles look better with bidirection instead of oneWay.",
|
|
3470
|
+
type: "string",
|
|
3471
|
+
pattern: getPattern(["bidirection", "oneWay", "none"])
|
|
3472
|
+
},
|
|
3473
|
+
layout: {
|
|
3474
|
+
default: "grid",
|
|
3475
|
+
description: "Specify the layout used for the graph. Choose between preset, grid, hierarchical",
|
|
3476
|
+
type: "string",
|
|
3477
|
+
pattern: getPattern(["preset", "grid", "hierarchical", "force"])
|
|
3478
|
+
},
|
|
3479
|
+
nodeHorizontalPadding: {
|
|
3480
|
+
default: 0,
|
|
3481
|
+
description: "Specify the additional horizontal padding between nodes in pixels (0 - 500).",
|
|
3482
|
+
type: "number"
|
|
3483
|
+
},
|
|
3484
|
+
nodeVerticalPadding: {
|
|
3485
|
+
default: 0,
|
|
3486
|
+
description: "Specify the additional vertical padding between nodes in pixels (0 - 500).",
|
|
3487
|
+
type: "number"
|
|
3488
|
+
},
|
|
3489
|
+
gridColumns: {
|
|
3490
|
+
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',
|
|
3491
|
+
type: "number"
|
|
3492
|
+
},
|
|
3493
|
+
hierarchyDirection: {
|
|
3494
|
+
description: 'When layout is "hierarchical", specify the direction (topBottom, bottomTop, leftRight, rightLeft) of the hierarchy.',
|
|
3495
|
+
default: "leftRight",
|
|
3496
|
+
pattern: getPattern(["topBottom", "bottomTop", "leftRight", "rightLeft"])
|
|
3497
|
+
},
|
|
3498
|
+
chargeStrength: {
|
|
3499
|
+
default: -30,
|
|
3500
|
+
description: 'When layout is "force", specify the strength of the charge between nodes. Positive value is attraction and negative value is replusion.',
|
|
3501
|
+
type: "number"
|
|
3502
|
+
},
|
|
3503
|
+
chargeTheta: {
|
|
3504
|
+
default: 0.9,
|
|
3505
|
+
description: 'When layout is "force", specify the Barnes-Hut approximation parameter. Higher value means faster performance but less predictable node positioning.',
|
|
3506
|
+
type: "number"
|
|
3507
|
+
},
|
|
3508
|
+
chargeDistanceMax: {
|
|
3509
|
+
description: 'When layout is "force", specify the maximum distance over which to apply the charge force.',
|
|
3510
|
+
type: "number"
|
|
3511
|
+
},
|
|
3512
|
+
chargeDistanceMin: {
|
|
3513
|
+
default: 1,
|
|
3514
|
+
description: 'When layout is "force", specify the minimum distance over which to apply the charge force.',
|
|
3515
|
+
type: "number"
|
|
3516
|
+
},
|
|
3517
|
+
collidePadding: {
|
|
3518
|
+
default: 10,
|
|
3519
|
+
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.',
|
|
3520
|
+
type: "number"
|
|
3521
|
+
},
|
|
3522
|
+
collideStrength: {
|
|
3523
|
+
default: 1,
|
|
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 - 5 but there is no hard limit.',
|
|
3525
|
+
type: "number"
|
|
3526
|
+
},
|
|
3527
|
+
clusterStrength: {
|
|
3528
|
+
default: 0.05,
|
|
3529
|
+
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',
|
|
3530
|
+
type: "number"
|
|
3531
|
+
},
|
|
3532
|
+
linkDistance: {
|
|
3533
|
+
default: 30,
|
|
3534
|
+
description: 'When layout is "force", specify the ideal distance between linked nodes. A higher value results in more space between linked nodes.',
|
|
3535
|
+
type: "number"
|
|
3536
|
+
},
|
|
3537
|
+
linkStrength: {
|
|
3538
|
+
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.'
|
|
3539
|
+
},
|
|
3540
|
+
tooltipNodeFields: {
|
|
3541
|
+
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.",
|
|
3542
|
+
type: "array",
|
|
3543
|
+
items: {
|
|
3544
|
+
type: "string"
|
|
3545
|
+
}
|
|
3546
|
+
},
|
|
3547
|
+
tooltipHeaderField: {
|
|
3548
|
+
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.",
|
|
3549
|
+
type: "string"
|
|
3550
|
+
},
|
|
3551
|
+
xPositions: {
|
|
3552
|
+
description: 'When layout is "preset", specify the x position for each node.',
|
|
3553
|
+
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(0)',
|
|
3554
|
+
type: "array",
|
|
3555
|
+
items: {
|
|
3556
|
+
type: "number"
|
|
3557
|
+
}
|
|
3558
|
+
},
|
|
3559
|
+
yPositions: {
|
|
3560
|
+
description: 'When layout is "preset", specify the y position for each node.',
|
|
3561
|
+
default: '> primary | frameBySeriesTypes("number") | seriesByIndex(1)',
|
|
3562
|
+
type: "array",
|
|
3563
|
+
items: {
|
|
3564
|
+
type: "number"
|
|
3565
|
+
}
|
|
3566
|
+
},
|
|
3567
|
+
nodeDragPositions: {
|
|
3568
|
+
description: "Stores the positions for nodes by id when the user drags nodes to new positions using the UI.",
|
|
3569
|
+
type: "object"
|
|
3570
|
+
},
|
|
3571
|
+
preferPorts: {
|
|
3572
|
+
description: "Specify the preferred port alignment for s and z links (horizontal, vertical, none).",
|
|
3573
|
+
type: "string",
|
|
3574
|
+
pattern: getPattern(["horizontal", "vertical", "none"])
|
|
3575
|
+
},
|
|
3576
|
+
showZoomControls: {
|
|
3577
|
+
default: true,
|
|
3578
|
+
description: "Specify whether to show the zoom controls on the graph.",
|
|
3579
|
+
type: "boolean"
|
|
3580
|
+
},
|
|
3581
|
+
resultLimit: {
|
|
3582
|
+
default: 1e3,
|
|
3583
|
+
description: "Specify the maximum number of link data points rendered (hard limit 10,000).",
|
|
3584
|
+
type: "number"
|
|
3276
3585
|
}
|
|
3277
3586
|
});
|
|
3278
3587
|
|
|
@@ -3320,6 +3629,12 @@ var pieOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3320
3629
|
type: "string",
|
|
3321
3630
|
default: "other"
|
|
3322
3631
|
},
|
|
3632
|
+
legendDisplay: {
|
|
3633
|
+
default: "off",
|
|
3634
|
+
description: "Specify the location of the legend on the panel.",
|
|
3635
|
+
pattern: getPattern(["right", "left", "top", "bottom", "off"]),
|
|
3636
|
+
type: "string"
|
|
3637
|
+
},
|
|
3323
3638
|
collapseThreshold: {
|
|
3324
3639
|
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.",
|
|
3325
3640
|
type: "number",
|
|
@@ -3766,7 +4081,6 @@ var scatterOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
3766
4081
|
description: "Specify whether to round x-axis values to the nearest integer.",
|
|
3767
4082
|
type: "boolean"
|
|
3768
4083
|
},
|
|
3769
|
-
// TODO: figure out if we want to change splunk-charting behavior for Bubble/Scatter, which hardcodes XMajorGridlines to false
|
|
3770
4084
|
// showXMajorGridLines: {
|
|
3771
4085
|
// default: false,
|
|
3772
4086
|
// description: 'Specify whether major grid lines are visible on the x-axis.',
|
|
@@ -4047,9 +4361,15 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4047
4361
|
},
|
|
4048
4362
|
shouldSparklineAcceptNullData: {
|
|
4049
4363
|
default: true,
|
|
4050
|
-
description: "Specify whether to convert null and non-numeric values in the sparkline to 0.",
|
|
4364
|
+
description: "Deprecated: Use sparklineNullValueDisplay instead. Specify whether to convert null and non-numeric values in the sparkline to 0.",
|
|
4051
4365
|
type: "boolean"
|
|
4052
4366
|
},
|
|
4367
|
+
sparklineNullValueDisplay: {
|
|
4368
|
+
default: "gaps",
|
|
4369
|
+
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.',
|
|
4370
|
+
pattern: getPattern(["gaps", "zero", "connect"]),
|
|
4371
|
+
type: "string"
|
|
4372
|
+
},
|
|
4053
4373
|
shouldUseThousandSeparators: {
|
|
4054
4374
|
default: true,
|
|
4055
4375
|
description: "Specify whether numeric values use commas as thousandths separators.",
|
|
@@ -4124,7 +4444,6 @@ var singleValueOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4124
4444
|
},
|
|
4125
4445
|
trendValue: {
|
|
4126
4446
|
default: "> sparklineValues|delta(-2)",
|
|
4127
|
-
// todo: may need update delta method
|
|
4128
4447
|
description: "The trend value to display in the visualization.",
|
|
4129
4448
|
type: "number"
|
|
4130
4449
|
},
|
|
@@ -4294,7 +4613,6 @@ var singleValueIconOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4294
4613
|
},
|
|
4295
4614
|
trendValue: {
|
|
4296
4615
|
default: '> primary|seriesByPrioritizedTypes("number", "string", "time")|delta(-2)',
|
|
4297
|
-
// todo: may need update delta method
|
|
4298
4616
|
description: "The trend value to display in the visualization.",
|
|
4299
4617
|
type: "number"
|
|
4300
4618
|
},
|
|
@@ -4466,7 +4784,6 @@ var singleValueRadialOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4466
4784
|
},
|
|
4467
4785
|
trendValue: {
|
|
4468
4786
|
default: '> primary | seriesByPrioritizedTypes("number", "string", "time") | delta(-2)',
|
|
4469
|
-
// todo: may need update delta method
|
|
4470
4787
|
description: "Specify the dataSource applied to the trend value.",
|
|
4471
4788
|
type: "number"
|
|
4472
4789
|
},
|
|
@@ -4616,6 +4933,12 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4616
4933
|
enum: validSparklineTypes.concat()
|
|
4617
4934
|
}
|
|
4618
4935
|
},
|
|
4936
|
+
sparklineNullValueDisplay: {
|
|
4937
|
+
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.',
|
|
4938
|
+
type: "string",
|
|
4939
|
+
default: "gaps",
|
|
4940
|
+
pattern: getPattern(["gaps", "zero", "connect"])
|
|
4941
|
+
},
|
|
4619
4942
|
textOverflow: {
|
|
4620
4943
|
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
4944
|
type: "string",
|
|
@@ -4820,6 +5143,12 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
|
|
|
4820
5143
|
}
|
|
4821
5144
|
}
|
|
4822
5145
|
},
|
|
5146
|
+
sparklineNullValueDisplay: {
|
|
5147
|
+
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.',
|
|
5148
|
+
type: "string",
|
|
5149
|
+
default: "gaps",
|
|
5150
|
+
pattern: getPattern(["gaps", "zero", "connect"])
|
|
5151
|
+
},
|
|
4823
5152
|
textOverflow: {
|
|
4824
5153
|
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
5154
|
type: "string",
|
|
@@ -4948,6 +5277,7 @@ export {
|
|
|
4948
5277
|
mapOptionsSchema,
|
|
4949
5278
|
markdownOptionsSchema,
|
|
4950
5279
|
markerGaugeOptionsSchema,
|
|
5280
|
+
networkGraphOptionsSchema,
|
|
4951
5281
|
parallelCoordinatesOptionsSchema,
|
|
4952
5282
|
pieOptionsSchema,
|
|
4953
5283
|
punchcardOptionsSchema,
|