@splunk/visualization-schemas 28.7.0 → 28.9.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
@@ -106,6 +106,7 @@ __export(src_exports, {
106
106
  singleValueRadialOptionsSchema: () => singleValueRadialOptionsSchema,
107
107
  tableOptionsSchema: () => tableOptionsSchema,
108
108
  timelineOptionsSchema: () => timelineOptionsSchema,
109
+ treemapOptionsSchema: () => treemapOptionsSchema,
109
110
  validAlignments: () => validAlignments,
110
111
  validCellRenderers: () => validCellRenderers,
111
112
  validColumnAlignments: () => validColumnAlignments,
@@ -3674,6 +3675,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3674
3675
  hierarchyDirection: {
3675
3676
  description: 'When layout is "hierarchical", specify the direction (topBottom, bottomTop, leftRight, rightLeft) of the hierarchy.',
3676
3677
  default: "leftRight",
3678
+ type: "string",
3677
3679
  pattern: getPattern(["topBottom", "bottomTop", "leftRight", "rightLeft"])
3678
3680
  },
3679
3681
  chargeStrength: {
@@ -3720,6 +3722,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3720
3722
  linkStrength: {
3721
3723
  minimum: 0,
3722
3724
  maximum: 1,
3725
+ type: "number",
3723
3726
  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.'
3724
3727
  },
3725
3728
  tooltipNodeFields: {
@@ -3839,9 +3842,9 @@ var pieOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3839
3842
  type: "string"
3840
3843
  },
3841
3844
  labelDisplay: {
3842
- description: "Specify whether to display the labels and/or slice percentages.",
3845
+ description: "Specify whether to display the labels, slice percentages, and/or counts.",
3843
3846
  type: "string",
3844
- pattern: getPattern(["values", "valuesAndPercentage", "off"]),
3847
+ pattern: getPattern(["values", "valuesAndPercentage", "count", "valuesAndCount", "all", "off"]),
3845
3848
  default: "values"
3846
3849
  },
3847
3850
  percentagePrecision: {
@@ -3993,7 +3996,7 @@ var processTreeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3993
3996
  },
3994
3997
  nodeIcons: {
3995
3998
  default: [],
3996
- description: "Specify optional node icons aligned with nodeSource rows. Supported built-in values are fire, rectangleDashed, cube, servers, and container. Provide an array, or use a string DSL expression that resolves to an array.",
3999
+ description: "Specify optional node icons aligned with nodeSource rows. Supported built-in values are fire, rectangleDashed, cube, servers, container, geoTag, and layersDoubleTransparent. Provide an array, or use a string DSL expression that resolves to an array.",
3997
4000
  type: ["array", "string"],
3998
4001
  items: {
3999
4002
  type: "string"
@@ -4019,7 +4022,7 @@ var processTreeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4019
4022
  },
4020
4023
  highlightIcon: {
4021
4024
  default: "",
4022
- description: "Specify an optional built-in icon to render for the highlighted node. Supported values are fire, rectangleDashed, cube, servers, and container.",
4025
+ description: "Specify an optional built-in icon to render for the highlighted node. Supported values are fire, rectangleDashed, cube, servers, container, geoTag, and layersDoubleTransparent.",
4023
4026
  type: "string"
4024
4027
  },
4025
4028
  highlightIconColor: {
@@ -4049,6 +4052,12 @@ var processTreeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
4049
4052
  description: "Specify whether tree node labels render as field=value. When false, only the field value is shown.",
4050
4053
  type: "boolean"
4051
4054
  },
4055
+ processLimit: {
4056
+ default: 100,
4057
+ description: "Specify the maximum number of sibling processes to render under each parent. An ellipsis is shown when additional processes are omitted.",
4058
+ minimum: 1,
4059
+ type: "integer"
4060
+ },
4052
4061
  disableExpansionPerNode: {
4053
4062
  default: [],
4054
4063
  description: "Specify per-node expansion behavior aligned with nodeSource rows. Use 'disable' to prevent collapsing/expanding that node; 'enable' or null allows expansion. Provide an array, or use a string DSL expression that resolves to an array.",
@@ -4381,6 +4390,12 @@ var pureRichTextOptionsSchema = {
4381
4390
  description: "HTML content for the rich text editor. Inline styles should only include differences from default text styles.",
4382
4391
  type: "string",
4383
4392
  default: "<p></p>"
4393
+ },
4394
+ // Data display
4395
+ previewTokenValues: {
4396
+ description: "When true, resolved token values are shown in the editor while in edit mode. When false (default), $token$ patterns are displayed as-is in edit mode. Tokens always resolve in view mode regardless of this setting.",
4397
+ type: "boolean",
4398
+ default: false
4384
4399
  }
4385
4400
  };
4386
4401
  var richTextOptionsSchema = pureRichTextOptionsSchema;
@@ -5467,7 +5482,7 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
5467
5482
  }
5468
5483
  },
5469
5484
  footer: {
5470
- description: 'DSL expression to format footer values for this column. Example: "> footer | seriesByName(\\"FieldName\\") | formatByType(unitConfig)". The footer DataFrame contains a 1D series with [total, percentage] for each column.',
5485
+ description: String.raw`DSL expression to format footer values for this column. Example: "> footer | seriesByName(\"FieldName\") | formatByType(unitConfig)". The footer DataFrame contains a 1D series with [total, percentage] for each column.`,
5471
5486
  type: "string"
5472
5487
  },
5473
5488
  headerAlign: {
@@ -5541,6 +5556,11 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
5541
5556
  type: "number",
5542
5557
  default: 10
5543
5558
  },
5559
+ dynamicHeight: {
5560
+ default: false,
5561
+ description: "In view mode, allow the table to grow or shrink to fit the data. Ignored in edit mode.",
5562
+ type: "boolean"
5563
+ },
5544
5564
  font: {
5545
5565
  default: "proportional",
5546
5566
  description: "Specify the font style to use for table content.",
@@ -5846,4 +5866,112 @@ var timelineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
5846
5866
  type: "number"
5847
5867
  }
5848
5868
  });
5869
+
5870
+ // src/optionsSchemas/treemap.ts
5871
+ var treemapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
5872
+ additionalTooltipFields: {
5873
+ default: [],
5874
+ description: "Specify additional fields to display in the tooltip for each node.",
5875
+ type: "array",
5876
+ items: {
5877
+ type: "string"
5878
+ }
5879
+ },
5880
+ backgroundColor: {
5881
+ default: "> themes.defaultBackgroundColor",
5882
+ 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".',
5883
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
5884
+ type: "string"
5885
+ },
5886
+ dataColors: {
5887
+ description: 'Specify the colors to use for treemap nodes. You can use an array of colors to be picked from, or you can use a data source to apply dynamic coloring. For example, "> primary | seriesByName("population") | rangeValue(colorRangeConfig)". By default, the dataColors option is not defined and seriesColors is used for categorical coloring.',
5888
+ type: ["string", "array"],
5889
+ items: {
5890
+ type: "string"
5891
+ }
5892
+ },
5893
+ dataColorValues: {
5894
+ default: `> primary | seriesByType('number')`,
5895
+ description: "Specify the array of values used for dynamic treemap coloring.",
5896
+ type: "array",
5897
+ items: {
5898
+ type: ["number", "string"]
5899
+ }
5900
+ },
5901
+ legendDisplay: {
5902
+ default: "off",
5903
+ description: "Specify the location of the legend on the panel.",
5904
+ pattern: getPattern(["bottom", "off"]),
5905
+ type: "string"
5906
+ },
5907
+ nodeIds: {
5908
+ default: '> primary | seriesByType("string")',
5909
+ description: "Specify the array of node IDs in the hierarchy.",
5910
+ type: "array",
5911
+ items: {
5912
+ type: "string"
5913
+ }
5914
+ },
5915
+ nodeLabels: {
5916
+ default: '> primary | seriesByType("string")',
5917
+ description: "Specify the array of display labels for treemap nodes.",
5918
+ type: "array",
5919
+ items: {
5920
+ type: "string"
5921
+ }
5922
+ },
5923
+ parent: {
5924
+ description: "Specify the array of parent node names in the hierarchy.",
5925
+ type: "array",
5926
+ items: {
5927
+ type: "string"
5928
+ }
5929
+ },
5930
+ resultLimit: {
5931
+ description: "Specify the maximum number of treemap data points rendered.",
5932
+ default: 1e4,
5933
+ type: "number"
5934
+ },
5935
+ seriesColors: {
5936
+ default: visualization_color_palettes_exports.VIZ_CATEGORICAL,
5937
+ description: 'Specify the colors used for root categories. For example, ["#FF0000", "#0000FF", "#008000"].',
5938
+ type: "array",
5939
+ items: {
5940
+ type: "string"
5941
+ }
5942
+ },
5943
+ showChildValues: {
5944
+ default: true,
5945
+ description: "Specify whether to display values for child and leaf nodes.",
5946
+ type: "boolean"
5947
+ },
5948
+ showParentValues: {
5949
+ default: true,
5950
+ description: "Specify whether to display the values of each parent node. This only applies when showSubdivisions is true.",
5951
+ type: "boolean"
5952
+ },
5953
+ showSubdivisions: {
5954
+ default: true,
5955
+ description: "Specify whether to display nested subdivisions inside parent nodes.",
5956
+ type: "boolean"
5957
+ },
5958
+ showTooltip: {
5959
+ default: false,
5960
+ description: "Specify whether to display the tooltip when hovering over nodes.",
5961
+ type: "boolean"
5962
+ },
5963
+ sumFromLeafNodes: {
5964
+ default: false,
5965
+ description: "Specify whether parent values are calculated from leaf children instead of using provided parent values.",
5966
+ type: "boolean"
5967
+ },
5968
+ value: {
5969
+ default: `> primary | seriesByType('number')`,
5970
+ description: "Specify the numeric field used to determine the size (area) of each treemap node.",
5971
+ type: "array",
5972
+ items: {
5973
+ type: "number"
5974
+ }
5975
+ }
5976
+ });
5849
5977
  //# sourceMappingURL=index.js.map