@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/esm/index.js CHANGED
@@ -3606,6 +3606,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3606
3606
  hierarchyDirection: {
3607
3607
  description: 'When layout is "hierarchical", specify the direction (topBottom, bottomTop, leftRight, rightLeft) of the hierarchy.',
3608
3608
  default: "leftRight",
3609
+ type: "string",
3609
3610
  pattern: getPattern(["topBottom", "bottomTop", "leftRight", "rightLeft"])
3610
3611
  },
3611
3612
  chargeStrength: {
@@ -3652,6 +3653,7 @@ var networkGraphOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3652
3653
  linkStrength: {
3653
3654
  minimum: 0,
3654
3655
  maximum: 1,
3656
+ type: "number",
3655
3657
  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.'
3656
3658
  },
3657
3659
  tooltipNodeFields: {
@@ -3771,9 +3773,9 @@ var pieOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3771
3773
  type: "string"
3772
3774
  },
3773
3775
  labelDisplay: {
3774
- description: "Specify whether to display the labels and/or slice percentages.",
3776
+ description: "Specify whether to display the labels, slice percentages, and/or counts.",
3775
3777
  type: "string",
3776
- pattern: getPattern(["values", "valuesAndPercentage", "off"]),
3778
+ pattern: getPattern(["values", "valuesAndPercentage", "count", "valuesAndCount", "all", "off"]),
3777
3779
  default: "values"
3778
3780
  },
3779
3781
  percentagePrecision: {
@@ -3925,7 +3927,7 @@ var processTreeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3925
3927
  },
3926
3928
  nodeIcons: {
3927
3929
  default: [],
3928
- 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.",
3930
+ 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.",
3929
3931
  type: ["array", "string"],
3930
3932
  items: {
3931
3933
  type: "string"
@@ -3951,7 +3953,7 @@ var processTreeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3951
3953
  },
3952
3954
  highlightIcon: {
3953
3955
  default: "",
3954
- description: "Specify an optional built-in icon to render for the highlighted node. Supported values are fire, rectangleDashed, cube, servers, and container.",
3956
+ description: "Specify an optional built-in icon to render for the highlighted node. Supported values are fire, rectangleDashed, cube, servers, container, geoTag, and layersDoubleTransparent.",
3955
3957
  type: "string"
3956
3958
  },
3957
3959
  highlightIconColor: {
@@ -3981,6 +3983,12 @@ var processTreeOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
3981
3983
  description: "Specify whether tree node labels render as field=value. When false, only the field value is shown.",
3982
3984
  type: "boolean"
3983
3985
  },
3986
+ processLimit: {
3987
+ default: 100,
3988
+ description: "Specify the maximum number of sibling processes to render under each parent. An ellipsis is shown when additional processes are omitted.",
3989
+ minimum: 1,
3990
+ type: "integer"
3991
+ },
3984
3992
  disableExpansionPerNode: {
3985
3993
  default: [],
3986
3994
  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.",
@@ -4313,6 +4321,12 @@ var pureRichTextOptionsSchema = {
4313
4321
  description: "HTML content for the rich text editor. Inline styles should only include differences from default text styles.",
4314
4322
  type: "string",
4315
4323
  default: "<p></p>"
4324
+ },
4325
+ // Data display
4326
+ previewTokenValues: {
4327
+ 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.",
4328
+ type: "boolean",
4329
+ default: false
4316
4330
  }
4317
4331
  };
4318
4332
  var richTextOptionsSchema = pureRichTextOptionsSchema;
@@ -5399,7 +5413,7 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
5399
5413
  }
5400
5414
  },
5401
5415
  footer: {
5402
- 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.',
5416
+ 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.`,
5403
5417
  type: "string"
5404
5418
  },
5405
5419
  headerAlign: {
@@ -5473,6 +5487,11 @@ var tableOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
5473
5487
  type: "number",
5474
5488
  default: 10
5475
5489
  },
5490
+ dynamicHeight: {
5491
+ default: false,
5492
+ description: "In view mode, allow the table to grow or shrink to fit the data. Ignored in edit mode.",
5493
+ type: "boolean"
5494
+ },
5476
5495
  font: {
5477
5496
  default: "proportional",
5478
5497
  description: "Specify the font style to use for table content.",
@@ -5778,6 +5797,114 @@ var timelineOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
5778
5797
  type: "number"
5779
5798
  }
5780
5799
  });
5800
+
5801
+ // src/optionsSchemas/treemap.ts
5802
+ var treemapOptionsSchema = enhanceOptionsSchemaWithDynamicOptions({
5803
+ additionalTooltipFields: {
5804
+ default: [],
5805
+ description: "Specify additional fields to display in the tooltip for each node.",
5806
+ type: "array",
5807
+ items: {
5808
+ type: "string"
5809
+ }
5810
+ },
5811
+ backgroundColor: {
5812
+ default: "> themes.defaultBackgroundColor",
5813
+ 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".',
5814
+ pattern: COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
5815
+ type: "string"
5816
+ },
5817
+ dataColors: {
5818
+ 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.',
5819
+ type: ["string", "array"],
5820
+ items: {
5821
+ type: "string"
5822
+ }
5823
+ },
5824
+ dataColorValues: {
5825
+ default: `> primary | seriesByType('number')`,
5826
+ description: "Specify the array of values used for dynamic treemap coloring.",
5827
+ type: "array",
5828
+ items: {
5829
+ type: ["number", "string"]
5830
+ }
5831
+ },
5832
+ legendDisplay: {
5833
+ default: "off",
5834
+ description: "Specify the location of the legend on the panel.",
5835
+ pattern: getPattern(["bottom", "off"]),
5836
+ type: "string"
5837
+ },
5838
+ nodeIds: {
5839
+ default: '> primary | seriesByType("string")',
5840
+ description: "Specify the array of node IDs in the hierarchy.",
5841
+ type: "array",
5842
+ items: {
5843
+ type: "string"
5844
+ }
5845
+ },
5846
+ nodeLabels: {
5847
+ default: '> primary | seriesByType("string")',
5848
+ description: "Specify the array of display labels for treemap nodes.",
5849
+ type: "array",
5850
+ items: {
5851
+ type: "string"
5852
+ }
5853
+ },
5854
+ parent: {
5855
+ description: "Specify the array of parent node names in the hierarchy.",
5856
+ type: "array",
5857
+ items: {
5858
+ type: "string"
5859
+ }
5860
+ },
5861
+ resultLimit: {
5862
+ description: "Specify the maximum number of treemap data points rendered.",
5863
+ default: 1e4,
5864
+ type: "number"
5865
+ },
5866
+ seriesColors: {
5867
+ default: visualization_color_palettes_exports.VIZ_CATEGORICAL,
5868
+ description: 'Specify the colors used for root categories. For example, ["#FF0000", "#0000FF", "#008000"].',
5869
+ type: "array",
5870
+ items: {
5871
+ type: "string"
5872
+ }
5873
+ },
5874
+ showChildValues: {
5875
+ default: true,
5876
+ description: "Specify whether to display values for child and leaf nodes.",
5877
+ type: "boolean"
5878
+ },
5879
+ showParentValues: {
5880
+ default: true,
5881
+ description: "Specify whether to display the values of each parent node. This only applies when showSubdivisions is true.",
5882
+ type: "boolean"
5883
+ },
5884
+ showSubdivisions: {
5885
+ default: true,
5886
+ description: "Specify whether to display nested subdivisions inside parent nodes.",
5887
+ type: "boolean"
5888
+ },
5889
+ showTooltip: {
5890
+ default: false,
5891
+ description: "Specify whether to display the tooltip when hovering over nodes.",
5892
+ type: "boolean"
5893
+ },
5894
+ sumFromLeafNodes: {
5895
+ default: false,
5896
+ description: "Specify whether parent values are calculated from leaf children instead of using provided parent values.",
5897
+ type: "boolean"
5898
+ },
5899
+ value: {
5900
+ default: `> primary | seriesByType('number')`,
5901
+ description: "Specify the numeric field used to determine the size (area) of each treemap node.",
5902
+ type: "array",
5903
+ items: {
5904
+ type: "number"
5905
+ }
5906
+ }
5907
+ });
5781
5908
  export {
5782
5909
  COLOR_OR_TOKEN_PATTERN,
5783
5910
  COLOR_OR_TOKEN_PATTERN_WITH_RGBA,
@@ -5823,6 +5950,7 @@ export {
5823
5950
  singleValueRadialOptionsSchema,
5824
5951
  tableOptionsSchema,
5825
5952
  timelineOptionsSchema,
5953
+ treemapOptionsSchema,
5826
5954
  validAlignments,
5827
5955
  validCellRenderers,
5828
5956
  validColumnAlignments,