@horietakehiro/aws-cdk-utul 0.33.0 → 0.33.2

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.
Files changed (158) hide show
  1. package/buildspec_schedule.yaml +42 -0
  2. package/lib/types/cfn-resource-types/aws-amazonmq-broker.d.ts +2 -1
  3. package/lib/types/cfn-resource-types/aws-amazonmq-broker.js +1 -1
  4. package/lib/types/cfn-resource-types/aws-appconfig-configurationprofile.d.ts +4 -0
  5. package/lib/types/cfn-resource-types/aws-appconfig-configurationprofile.js +1 -1
  6. package/lib/types/cfn-resource-types/aws-appconfig-deployment.d.ts +40 -4
  7. package/lib/types/cfn-resource-types/aws-appconfig-deployment.js +1 -1
  8. package/lib/types/cfn-resource-types/aws-appconfig-environment.d.ts +4 -0
  9. package/lib/types/cfn-resource-types/aws-appconfig-environment.js +1 -1
  10. package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.d.ts +17 -0
  11. package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.js +1 -1
  12. package/lib/types/cfn-resource-types/aws-bedrock-agent.d.ts +5 -0
  13. package/lib/types/cfn-resource-types/aws-bedrock-agent.js +1 -1
  14. package/lib/types/cfn-resource-types/aws-bedrock-datasource.d.ts +25 -16
  15. package/lib/types/cfn-resource-types/aws-bedrock-datasource.js +1 -1
  16. package/lib/types/cfn-resource-types/aws-bedrock-knowledgebase.d.ts +48 -3
  17. package/lib/types/cfn-resource-types/aws-bedrock-knowledgebase.js +1 -1
  18. package/lib/types/cfn-resource-types/aws-bedrock-prompt.d.ts +158 -3
  19. package/lib/types/cfn-resource-types/aws-bedrock-prompt.js +1 -1
  20. package/lib/types/cfn-resource-types/aws-cassandra-keyspace.d.ts +4 -0
  21. package/lib/types/cfn-resource-types/aws-cassandra-keyspace.js +1 -1
  22. package/lib/types/cfn-resource-types/aws-cassandra-type.d.ts +41 -0
  23. package/lib/types/cfn-resource-types/aws-cassandra-type.js +3 -0
  24. package/lib/types/cfn-resource-types/aws-cleanrooms-collaboration.d.ts +18 -0
  25. package/lib/types/cfn-resource-types/aws-cleanrooms-collaboration.js +1 -1
  26. package/lib/types/cfn-resource-types/aws-cleanrooms-membership.d.ts +11 -0
  27. package/lib/types/cfn-resource-types/aws-cleanrooms-membership.js +1 -1
  28. package/lib/types/cfn-resource-types/aws-cloudformation-guardhook.d.ts +1 -1
  29. package/lib/types/cfn-resource-types/aws-cloudformation-guardhook.js +1 -1
  30. package/lib/types/cfn-resource-types/aws-cloudformation-lambdahook.d.ts +1 -1
  31. package/lib/types/cfn-resource-types/aws-cloudformation-lambdahook.js +1 -1
  32. package/lib/types/cfn-resource-types/aws-cloudfront-anycastiplist.d.ts +27 -0
  33. package/lib/types/cfn-resource-types/aws-cloudfront-anycastiplist.js +3 -0
  34. package/lib/types/cfn-resource-types/aws-cloudfront-distribution.d.ts +24 -7
  35. package/lib/types/cfn-resource-types/aws-cloudfront-distribution.js +1 -1
  36. package/lib/types/cfn-resource-types/aws-connect-queue.d.ts +0 -1
  37. package/lib/types/cfn-resource-types/aws-connect-queue.js +1 -1
  38. package/lib/types/cfn-resource-types/aws-customerprofiles-eventtrigger.d.ts +162 -0
  39. package/lib/types/cfn-resource-types/aws-customerprofiles-eventtrigger.js +3 -0
  40. package/lib/types/cfn-resource-types/aws-databrew-dataset.d.ts +9 -0
  41. package/lib/types/cfn-resource-types/aws-databrew-dataset.js +1 -1
  42. package/lib/types/cfn-resource-types/aws-datazone-datasource.d.ts +23 -1
  43. package/lib/types/cfn-resource-types/aws-datazone-datasource.js +1 -1
  44. package/lib/types/cfn-resource-types/aws-datazone-projectmembership.d.ts +1 -1
  45. package/lib/types/cfn-resource-types/aws-datazone-projectmembership.js +1 -1
  46. package/lib/types/cfn-resource-types/aws-datazone-subscriptiontarget.d.ts +1 -1
  47. package/lib/types/cfn-resource-types/aws-datazone-subscriptiontarget.js +1 -1
  48. package/lib/types/cfn-resource-types/aws-dms-dataprovider.d.ts +1 -1
  49. package/lib/types/cfn-resource-types/aws-dms-dataprovider.js +1 -1
  50. package/lib/types/cfn-resource-types/aws-docdb-dbcluster.d.ts +3 -0
  51. package/lib/types/cfn-resource-types/aws-docdb-dbcluster.js +1 -1
  52. package/lib/types/cfn-resource-types/aws-dynamodb-globaltable.d.ts +5 -3
  53. package/lib/types/cfn-resource-types/aws-dynamodb-globaltable.js +1 -1
  54. package/lib/types/cfn-resource-types/aws-dynamodb-table.d.ts +1 -0
  55. package/lib/types/cfn-resource-types/aws-dynamodb-table.js +1 -1
  56. package/lib/types/cfn-resource-types/aws-ec2-ec2fleet.d.ts +10 -0
  57. package/lib/types/cfn-resource-types/aws-ec2-ec2fleet.js +1 -1
  58. package/lib/types/cfn-resource-types/aws-ec2-launchtemplate.d.ts +1022 -0
  59. package/lib/types/cfn-resource-types/aws-ec2-launchtemplate.js +3 -0
  60. package/lib/types/cfn-resource-types/aws-ec2-networkacl.d.ts +1 -0
  61. package/lib/types/cfn-resource-types/aws-ec2-networkacl.js +1 -1
  62. package/lib/types/cfn-resource-types/aws-ec2-spotfleet.d.ts +136 -126
  63. package/lib/types/cfn-resource-types/aws-ec2-spotfleet.js +1 -1
  64. package/lib/types/cfn-resource-types/aws-ec2-volume.d.ts +5 -5
  65. package/lib/types/cfn-resource-types/aws-ec2-volume.js +1 -1
  66. package/lib/types/cfn-resource-types/aws-ec2-vpccidrblock.d.ts +4 -0
  67. package/lib/types/cfn-resource-types/aws-ec2-vpccidrblock.js +1 -1
  68. package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.d.ts +27 -14
  69. package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.js +1 -1
  70. package/lib/types/cfn-resource-types/aws-ec2-vpcendpointservice.d.ts +8 -0
  71. package/lib/types/cfn-resource-types/aws-ec2-vpcendpointservice.js +1 -1
  72. package/lib/types/cfn-resource-types/aws-ecs-service.d.ts +6 -3
  73. package/lib/types/cfn-resource-types/aws-ecs-service.js +1 -1
  74. package/lib/types/cfn-resource-types/aws-ecs-taskdefinition.d.ts +5 -2
  75. package/lib/types/cfn-resource-types/aws-ecs-taskdefinition.js +1 -1
  76. package/lib/types/cfn-resource-types/aws-efs-filesystem.d.ts +10 -1
  77. package/lib/types/cfn-resource-types/aws-efs-filesystem.js +1 -1
  78. package/lib/types/cfn-resource-types/aws-fis-experimenttemplate.d.ts +1 -1
  79. package/lib/types/cfn-resource-types/aws-fis-experimenttemplate.js +1 -1
  80. package/lib/types/cfn-resource-types/aws-imagebuilder-image.d.ts +45 -45
  81. package/lib/types/cfn-resource-types/aws-imagebuilder-image.js +1 -1
  82. package/lib/types/cfn-resource-types/aws-lex-bot.d.ts +17 -0
  83. package/lib/types/cfn-resource-types/aws-lex-bot.js +1 -1
  84. package/lib/types/cfn-resource-types/aws-logs-loggroup.d.ts +11 -0
  85. package/lib/types/cfn-resource-types/aws-logs-loggroup.js +1 -1
  86. package/lib/types/cfn-resource-types/aws-logs-metricfilter.d.ts +4 -0
  87. package/lib/types/cfn-resource-types/aws-logs-metricfilter.js +1 -1
  88. package/lib/types/cfn-resource-types/aws-logs-subscriptionfilter.d.ts +4 -0
  89. package/lib/types/cfn-resource-types/aws-logs-subscriptionfilter.js +1 -1
  90. package/lib/types/cfn-resource-types/aws-mediaconnect-bridge.d.ts +10 -0
  91. package/lib/types/cfn-resource-types/aws-mediaconnect-bridge.js +1 -1
  92. package/lib/types/cfn-resource-types/aws-mediaconnect-bridgesource.d.ts +10 -0
  93. package/lib/types/cfn-resource-types/aws-mediaconnect-bridgesource.js +1 -1
  94. package/lib/types/cfn-resource-types/aws-mediaconvert-queue.d.ts +1 -0
  95. package/lib/types/cfn-resource-types/aws-mediaconvert-queue.js +1 -1
  96. package/lib/types/cfn-resource-types/aws-opensearchservice-domain.d.ts +10 -0
  97. package/lib/types/cfn-resource-types/aws-opensearchservice-domain.js +1 -1
  98. package/lib/types/cfn-resource-types/aws-pcs-cluster.d.ts +151 -0
  99. package/lib/types/cfn-resource-types/aws-pcs-cluster.js +3 -0
  100. package/lib/types/cfn-resource-types/aws-pcs-computenodegroup.d.ts +142 -0
  101. package/lib/types/cfn-resource-types/aws-pcs-computenodegroup.js +3 -0
  102. package/lib/types/cfn-resource-types/aws-pcs-queue.d.ts +65 -0
  103. package/lib/types/cfn-resource-types/aws-pcs-queue.js +3 -0
  104. package/lib/types/cfn-resource-types/aws-qbusiness-dataaccessor.d.ts +1 -1
  105. package/lib/types/cfn-resource-types/aws-qbusiness-dataaccessor.js +1 -1
  106. package/lib/types/cfn-resource-types/aws-quicksight-analysis.d.ts +4218 -0
  107. package/lib/types/cfn-resource-types/aws-quicksight-analysis.js +3 -0
  108. package/lib/types/cfn-resource-types/aws-quicksight-custompermissions.d.ts +48 -0
  109. package/lib/types/cfn-resource-types/aws-quicksight-custompermissions.js +3 -0
  110. package/lib/types/cfn-resource-types/aws-quicksight-dashboard.d.ts +4338 -0
  111. package/lib/types/cfn-resource-types/aws-quicksight-dashboard.js +3 -0
  112. package/lib/types/cfn-resource-types/aws-quicksight-dataset.d.ts +16 -22
  113. package/lib/types/cfn-resource-types/aws-quicksight-dataset.js +1 -1
  114. package/lib/types/cfn-resource-types/aws-quicksight-template.d.ts +4018 -0
  115. package/lib/types/cfn-resource-types/aws-quicksight-template.js +3 -0
  116. package/lib/types/cfn-resource-types/aws-rds-dbcluster.d.ts +24 -13
  117. package/lib/types/cfn-resource-types/aws-rds-dbcluster.js +1 -1
  118. package/lib/types/cfn-resource-types/aws-rds-dbinstance.d.ts +1 -0
  119. package/lib/types/cfn-resource-types/aws-rds-dbinstance.js +1 -1
  120. package/lib/types/cfn-resource-types/aws-redshift-integration.d.ts +3 -5
  121. package/lib/types/cfn-resource-types/aws-redshift-integration.js +1 -1
  122. package/lib/types/cfn-resource-types/aws-resiliencehub-app.d.ts +4 -0
  123. package/lib/types/cfn-resource-types/aws-resiliencehub-app.js +1 -1
  124. package/lib/types/cfn-resource-types/aws-sagemaker-cluster.d.ts +52 -52
  125. package/lib/types/cfn-resource-types/aws-sagemaker-cluster.js +1 -1
  126. package/lib/types/cfn-resource-types/aws-sagemaker-domain.d.ts +5 -0
  127. package/lib/types/cfn-resource-types/aws-sagemaker-domain.js +1 -1
  128. package/lib/types/cfn-resource-types/aws-sagemaker-endpointconfig.d.ts +0 -1
  129. package/lib/types/cfn-resource-types/aws-sagemaker-endpointconfig.js +1 -1
  130. package/lib/types/cfn-resource-types/aws-sagemaker-partnerapp.d.ts +89 -0
  131. package/lib/types/cfn-resource-types/aws-sagemaker-partnerapp.js +3 -0
  132. package/lib/types/cfn-resource-types/aws-sagemaker-space.d.ts +4 -0
  133. package/lib/types/cfn-resource-types/aws-sagemaker-space.js +1 -1
  134. package/lib/types/cfn-resource-types/aws-sagemaker-userprofile.d.ts +5 -0
  135. package/lib/types/cfn-resource-types/aws-sagemaker-userprofile.js +1 -1
  136. package/lib/types/cfn-resource-types/aws-securityhub-configurationpolicy.d.ts +1 -1
  137. package/lib/types/cfn-resource-types/aws-securityhub-configurationpolicy.js +1 -1
  138. package/lib/types/cfn-resource-types/aws-ses-configurationset.d.ts +4 -0
  139. package/lib/types/cfn-resource-types/aws-ses-configurationset.js +1 -1
  140. package/lib/types/cfn-resource-types/aws-ses-mailmanagerruleset.d.ts +10 -1
  141. package/lib/types/cfn-resource-types/aws-ses-mailmanagerruleset.js +1 -1
  142. package/lib/types/cfn-resource-types/aws-ssmquicksetup-configurationmanager.d.ts +1 -1
  143. package/lib/types/cfn-resource-types/aws-ssmquicksetup-configurationmanager.js +1 -1
  144. package/lib/types/cfn-resource-types/aws-synthetics-canary.d.ts +4 -0
  145. package/lib/types/cfn-resource-types/aws-synthetics-canary.js +1 -1
  146. package/lib/types/cfn-resource-types/aws-wisdom-aiagent.d.ts +1 -0
  147. package/lib/types/cfn-resource-types/aws-wisdom-aiagent.js +1 -1
  148. package/lib/types/cfn-resource-types/aws-wisdom-aiprompt.d.ts +1 -0
  149. package/lib/types/cfn-resource-types/aws-wisdom-aiprompt.js +1 -1
  150. package/lib/types/cfn-resource-types.d.ts +24 -6
  151. package/lib/types/cfn-resource-types.js +50 -32
  152. package/package.json +2 -2
  153. package/lib/types/cfn-resource-types/aws-iot1click-device.d.ts +0 -8
  154. package/lib/types/cfn-resource-types/aws-iot1click-device.js +0 -3
  155. package/lib/types/cfn-resource-types/aws-iot1click-placement.d.ts +0 -14
  156. package/lib/types/cfn-resource-types/aws-iot1click-placement.js +0 -3
  157. package/lib/types/cfn-resource-types/aws-iot1click-project.d.ts +0 -18
  158. package/lib/types/cfn-resource-types/aws-iot1click-project.js +0 -3
@@ -0,0 +1,4218 @@
1
+ export type ResourceStatus = ("CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "DELETED");
2
+ export type DayOfTheWeek = ("SUNDAY" | "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY");
3
+ export type WidgetStatus = ("ENABLED" | "DISABLED");
4
+ export type FilterNullOption = ("ALL_VALUES" | "NULLS_ONLY" | "NON_NULLS_ONLY");
5
+ export type CategoryFilterMatchOperator = ("EQUALS" | "DOES_NOT_EQUAL" | "CONTAINS" | "DOES_NOT_CONTAIN" | "STARTS_WITH" | "ENDS_WITH");
6
+ export type CategoryFilterSelectAllOptions = "FILTER_ALL_VALUES";
7
+ export type SheetControlSliderType = ("SINGLE_POINT" | "RANGE");
8
+ export type Visibility = ("HIDDEN" | "VISIBLE");
9
+ export type FontStyle = ("NORMAL" | "ITALIC");
10
+ export type RelativeFontSize = ("EXTRA_SMALL" | "SMALL" | "MEDIUM" | "LARGE" | "EXTRA_LARGE");
11
+ export type FontDecoration = ("UNDERLINE" | "NONE");
12
+ export type FontWeightName = ("NORMAL" | "BOLD");
13
+ export type CommitMode = ("AUTO" | "MANUAL");
14
+ export type SheetControlListType = ("MULTI_SELECT" | "SINGLE_SELECT");
15
+ export type SheetControlDateTimePickerType = ("SINGLE_VALUED" | "DATE_RANGE");
16
+ export type SimpleAttributeAggregationFunction = "UNIQUE_VALUE";
17
+ export type DateAggregationFunction = ("COUNT" | "DISTINCT_COUNT" | "MIN" | "MAX");
18
+ export type SimpleNumericalAggregationFunction = ("SUM" | "AVERAGE" | "MIN" | "MAX" | "COUNT" | "DISTINCT_COUNT" | "VAR" | "VARP" | "STDEV" | "STDEVP" | "MEDIAN");
19
+ export type CategoricalAggregationFunction = ("COUNT" | "DISTINCT_COUNT");
20
+ export type NumericEqualityMatchOperator = ("EQUALS" | "DOES_NOT_EQUAL");
21
+ export type NumericFilterSelectAllOptions = "FILTER_ALL_VALUES";
22
+ export type TimeGranularity = ("YEAR" | "QUARTER" | "MONTH" | "WEEK" | "DAY" | "HOUR" | "MINUTE" | "SECOND" | "MILLISECOND");
23
+ export type RelativeDateType = ("PREVIOUS" | "THIS" | "LAST" | "NOW" | "NEXT");
24
+ export type AnchorOption = "NOW";
25
+ export type SortDirection = ("ASC" | "DESC");
26
+ export type CrossDatasetTypes = ("ALL_DATASETS" | "SINGLE_DATASET");
27
+ export type FilterVisualScope = ("ALL_VISUALS" | "SELECTED_VISUALS");
28
+ export type QueryExecutionMode = ("AUTO" | "MANUAL");
29
+ export type ColumnRole = ("DIMENSION" | "MEASURE");
30
+ export type NegativeValueDisplayMode = ("POSITIVE" | "NEGATIVE");
31
+ export type NumberScale = ("NONE" | "AUTO" | "THOUSANDS" | "MILLIONS" | "BILLIONS" | "TRILLIONS");
32
+ export type NumericSeparatorSymbol = ("COMMA" | "DOT" | "SPACE");
33
+ export type SpecialValue = ("EMPTY" | "NULL" | "OTHER");
34
+ export type SheetContentType = ("PAGINATED" | "INTERACTIVE");
35
+ export type ResizeOption = ("FIXED" | "RESPONSIVE");
36
+ export type PaperSize = ("US_LETTER" | "US_LEGAL" | "US_TABLOID_LEDGER" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "JIS_B4" | "JIS_B5");
37
+ export type PaperOrientation = ("PORTRAIT" | "LANDSCAPE");
38
+ export type LayoutElementType = ("VISUAL" | "FILTER_CONTROL" | "PARAMETER_CONTROL" | "TEXT_BOX" | "IMAGE");
39
+ export type SectionPageBreakStatus = ("ENABLED" | "DISABLED");
40
+ export type ImageCustomActionTrigger = ("CLICK" | "MENU");
41
+ export type SelectAllValueOptions = "ALL_VALUES";
42
+ export type URLTargetConfiguration = ("NEW_TAB" | "NEW_WINDOW" | "SAME_TAB");
43
+ export type SheetImageScalingType = ("SCALE_TO_WIDTH" | "SCALE_TO_HEIGHT" | "SCALE_TO_CONTAINER" | "SCALE_NONE");
44
+ export type OtherCategories = ("INCLUDE" | "EXCLUDE");
45
+ export type DataLabelPosition = ("INSIDE" | "OUTSIDE" | "LEFT" | "TOP" | "BOTTOM" | "RIGHT");
46
+ export type FunnelChartMeasureDataLabelStyle = ("VALUE_ONLY" | "PERCENTAGE_BY_FIRST_STAGE" | "PERCENTAGE_BY_PREVIOUS_STAGE" | "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE" | "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE");
47
+ export type SelectedTooltipType = ("BASIC" | "DETAILED");
48
+ export type TooltipTarget = ("BOTH" | "BAR" | "LINE");
49
+ export type TooltipTitleType = ("NONE" | "PRIMARY_VALUE");
50
+ export type PivotTableDataPathType = ("HIERARCHY_ROWS_LAYOUT_COLUMN" | "MULTIPLE_ROW_METRICS_COLUMN" | "EMPTY_COLUMN_HEADER" | "COUNT_METRIC_COLUMN");
51
+ export type VisualCustomActionTrigger = ("DATA_POINT_CLICK" | "DATA_POINT_MENU");
52
+ export type SelectedFieldOptions = "ALL_FIELDS";
53
+ export type TargetVisualOptions = "ALL_VISUALS";
54
+ export type LegendPosition = ("AUTO" | "RIGHT" | "BOTTOM" | "TOP");
55
+ export type AxisBinding = ("PRIMARY_YAXIS" | "SECONDARY_YAXIS");
56
+ export type ReferenceLineSeriesType = ("BAR" | "LINE");
57
+ export type ReferenceLineLabelHorizontalPosition = ("LEFT" | "CENTER" | "RIGHT");
58
+ export type ReferenceLineValueLabelRelativePosition = ("BEFORE_CUSTOM_LABEL" | "AFTER_CUSTOM_LABEL");
59
+ export type ReferenceLineLabelVerticalPosition = ("ABOVE" | "BELOW");
60
+ export type ReferenceLinePatternType = ("SOLID" | "DASHED" | "DOTTED");
61
+ export type BoxPlotFillStyle = ("SOLID" | "TRANSPARENT");
62
+ export type GeospatialMapNavigation = ("ENABLED" | "DISABLED");
63
+ export type BaseMapStyleType = ("LIGHT_GRAY" | "DARK_GRAY" | "STREET" | "IMAGERY");
64
+ export type LayerCustomActionTrigger = ("DATA_POINT_CLICK" | "DATA_POINT_MENU");
65
+ export type GeospatialLayerType = ("POINT" | "LINE" | "POLYGON");
66
+ /**
67
+ * Defines view state of the color
68
+ */
69
+ export type GeospatialColorState = ("ENABLED" | "DISABLED");
70
+ export type MapZoomMode = ("AUTO" | "MANUAL");
71
+ export type GeospatialSelectedPointStyle = ("POINT" | "CLUSTER" | "HEATMAP");
72
+ export type DataLabelContent = ("VALUE" | "PERCENT" | "VALUE_AND_PERCENT");
73
+ export type DataLabelOverlap = ("DISABLE_OVERLAP" | "ENABLE_OVERLAP");
74
+ export type RadarChartShape = ("CIRCLE" | "POLYGON");
75
+ export type RadarChartAxesRangeScale = ("AUTO" | "INDEPENDENT" | "SHARED");
76
+ export type SingleYAxisOption = "PRIMARY_Y_AXIS";
77
+ export type BarsArrangement = ("CLUSTERED" | "STACKED" | "STACKED_PERCENT");
78
+ export type WordCloudWordOrientation = ("HORIZONTAL" | "HORIZONTAL_AND_VERTICAL");
79
+ export type WordCloudWordScaling = ("EMPHASIZE" | "NORMAL");
80
+ export type WordCloudCloudLayout = ("FLUID" | "NORMAL");
81
+ export type WordCloudWordCasing = ("LOWER_CASE" | "EXISTING_CASE");
82
+ export type WordCloudWordPadding = ("NONE" | "SMALL" | "MEDIUM" | "LARGE");
83
+ export type ConditionalFormattingIconDisplayOption = "ICON_ONLY";
84
+ export type Icon = ("CARET_UP" | "CARET_DOWN" | "PLUS" | "MINUS" | "ARROW_UP" | "ARROW_DOWN" | "ARROW_LEFT" | "ARROW_UP_LEFT" | "ARROW_DOWN_LEFT" | "ARROW_RIGHT" | "ARROW_UP_RIGHT" | "ARROW_DOWN_RIGHT" | "FACE_UP" | "FACE_DOWN" | "FACE_FLAT" | "ONE_BAR" | "TWO_BAR" | "THREE_BAR" | "CIRCLE" | "TRIANGLE" | "SQUARE" | "FLAG" | "THUMBS_UP" | "THUMBS_DOWN" | "CHECKMARK" | "X");
85
+ export type ConditionalFormattingIconSetType = ("PLUS_MINUS" | "CHECK_X" | "THREE_COLOR_ARROW" | "THREE_GRAY_ARROW" | "CARET_UP_MINUS_DOWN" | "THREE_SHAPE" | "THREE_CIRCLE" | "FLAGS" | "BARS" | "FOUR_COLOR_ARROW" | "FOUR_GRAY_ARROW");
86
+ export type ArcThicknessOptions = ("SMALL" | "MEDIUM" | "LARGE");
87
+ export type ComparisonMethod = ("DIFFERENCE" | "PERCENT_DIFFERENCE" | "PERCENT");
88
+ export type PrimaryValueDisplayType = ("HIDDEN" | "COMPARISON" | "ACTUAL");
89
+ export type CustomContentType = ("IMAGE" | "OTHER_EMBEDDED_CONTENT");
90
+ export type CustomContentImageScalingConfiguration = ("FIT_TO_HEIGHT" | "FIT_TO_WIDTH" | "DO_NOT_SCALE" | "SCALE_TO_VISUAL");
91
+ export type ArcThickness = ("SMALL" | "MEDIUM" | "LARGE" | "WHOLE");
92
+ export type PanelBorderStyle = ("SOLID" | "DASHED" | "DOTTED");
93
+ export type HorizontalTextAlignment = ("LEFT" | "CENTER" | "RIGHT" | "AUTO");
94
+ export type SmallMultiplesAxisPlacement = ("OUTSIDE" | "INSIDE");
95
+ export type SmallMultiplesAxisScale = ("SHARED" | "INDEPENDENT");
96
+ export type KPIVisualStandardLayoutType = ("CLASSIC" | "VERTICAL");
97
+ export type KPISparklineType = ("LINE" | "AREA");
98
+ export type HistogramBinType = ("BIN_COUNT" | "BIN_WIDTH");
99
+ export type PluginVisualAxisName = ("GROUP_BY" | "VALUE");
100
+ export type VerticalTextAlignment = ("TOP" | "MIDDLE" | "BOTTOM" | "AUTO");
101
+ export type TableBorderStyle = ("NONE" | "SOLID");
102
+ export type TextWrap = ("NONE" | "WRAP");
103
+ export type TableOrientation = ("VERTICAL" | "HORIZONTAL");
104
+ export type TableFieldIconSetType = "LINK";
105
+ export type TableCellImageScalingConfiguration = ("FIT_TO_CELL_HEIGHT" | "FIT_TO_CELL_WIDTH" | "DO_NOT_SCALE");
106
+ export type SimpleTotalAggregationFunction = ("DEFAULT" | "SUM" | "AVERAGE" | "MIN" | "MAX" | "NONE");
107
+ export type TableTotalsScrollStatus = ("PINNED" | "SCROLLED");
108
+ export type TableTotalsPlacement = ("START" | "END" | "AUTO");
109
+ export type PivotTableConditionalFormattingScopeRole = ("FIELD" | "FIELD_TOTAL" | "GRAND_TOTAL");
110
+ export type PivotTableRowsLayout = ("TABULAR" | "HIERARCHY");
111
+ export type PivotTableMetricPlacement = ("ROW" | "COLUMN");
112
+ export type PivotTableFieldCollapseState = ("COLLAPSED" | "EXPANDED");
113
+ export type PivotTableSubtotalLevel = ("ALL" | "CUSTOM" | "LAST");
114
+ export type StyledCellType = ("TOTAL" | "METRIC_HEADER" | "VALUE");
115
+ export type BarChartOrientation = ("HORIZONTAL" | "VERTICAL");
116
+ export type ColorFillType = ("DISCRETE" | "GRADIENT");
117
+ export type TopBottomComputationType = ("TOP" | "BOTTOM");
118
+ export type ForecastComputationSeasonality = ("AUTOMATIC" | "CUSTOM");
119
+ export type MaximumMinimumComputationType = ("MAXIMUM" | "MINIMUM");
120
+ export type TopBottomSortOrder = ("PERCENT_DIFFERENCE" | "ABSOLUTE_DIFFERENCE");
121
+ export type MissingDataTreatmentOption = ("INTERPOLATE" | "SHOW_AS_ZERO" | "SHOW_AS_BLANK");
122
+ export type LineInterpolation = ("LINEAR" | "SMOOTH" | "STEPPED");
123
+ export type LineChartLineStyle = ("SOLID" | "DOTTED" | "DASHED");
124
+ export type LineChartMarkerShape = ("CIRCLE" | "TRIANGLE" | "SQUARE" | "DIAMOND" | "ROUNDED_SQUARE");
125
+ export type LineChartType = ("LINE" | "AREA" | "STACKED_AREA");
126
+ export type ParameterValueType = ("MULTI_VALUED" | "SINGLE_VALUED");
127
+ export type ValueWhenUnsetOption = ("RECOMMENDED_VALUE" | "NULL");
128
+ export type ValidationStrategyMode = ("STRICT" | "LENIENT");
129
+ export type AnalysisErrorType = ("ACCESS_DENIED" | "SOURCE_NOT_FOUND" | "DATA_SET_NOT_FOUND" | "INTERNAL_FAILURE" | "PARAMETER_VALUE_INCOMPATIBLE" | "PARAMETER_TYPE_INVALID" | "PARAMETER_NOT_FOUND" | "COLUMN_TYPE_MISMATCH" | "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" | "COLUMN_REPLACEMENT_MISSING");
130
+ /**
131
+ * Definition of the AWS::QuickSight::Analysis Resource Type.
132
+ */
133
+ export interface _AWS_QUICKSIGHT_ANALYSIS {
134
+ Status?: ResourceStatus;
135
+ /**
136
+ * <p>The time that the analysis was created.</p>
137
+ */
138
+ CreatedTime?: string;
139
+ Parameters?: Parameters;
140
+ /**
141
+ * <p>The ARNs of the datasets of the analysis.</p>
142
+ *
143
+ * @minItems 0
144
+ * @maxItems 100
145
+ */
146
+ DataSetArns?: string[];
147
+ SourceEntity?: AnalysisSourceEntity;
148
+ /**
149
+ * <p>The ARN of the theme of the analysis.</p>
150
+ */
151
+ ThemeArn?: string;
152
+ Definition?: AnalysisDefinition;
153
+ /**
154
+ * <p>The time that the analysis was last updated.</p>
155
+ */
156
+ LastUpdatedTime?: string;
157
+ ValidationStrategy?: ValidationStrategy;
158
+ /**
159
+ * @minItems 0
160
+ * @maxItems 10
161
+ */
162
+ FolderArns?: string[];
163
+ /**
164
+ * <p>The descriptive name of the analysis.</p>
165
+ */
166
+ Name: string;
167
+ /**
168
+ * <p>Errors associated with the analysis.</p>
169
+ *
170
+ * @minItems 1
171
+ */
172
+ Errors?: AnalysisError[];
173
+ AnalysisId: string;
174
+ AwsAccountId: string;
175
+ /**
176
+ * @minItems 1
177
+ * @maxItems 64
178
+ */
179
+ Permissions?: ResourcePermission[];
180
+ /**
181
+ * <p>The Amazon Resource Name (ARN) of the analysis.</p>
182
+ */
183
+ Arn?: string;
184
+ /**
185
+ * @minItems 1
186
+ * @maxItems 200
187
+ */
188
+ Tags?: Tag[];
189
+ /**
190
+ * <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
191
+ *
192
+ * @minItems 0
193
+ * @maxItems 20
194
+ */
195
+ Sheets?: Sheet[];
196
+ }
197
+ /**
198
+ * <p>A list of Amazon QuickSight parameters and the list's override values.</p>
199
+ */
200
+ export interface Parameters {
201
+ /**
202
+ * <p>The parameters that have a data type of string.</p>
203
+ *
204
+ * @minItems 0
205
+ * @maxItems 100
206
+ */
207
+ StringParameters?: StringParameter[];
208
+ /**
209
+ * <p>The parameters that have a data type of decimal.</p>
210
+ *
211
+ * @minItems 0
212
+ * @maxItems 100
213
+ */
214
+ DecimalParameters?: DecimalParameter[];
215
+ /**
216
+ * <p>The parameters that have a data type of integer.</p>
217
+ *
218
+ * @minItems 0
219
+ * @maxItems 100
220
+ */
221
+ IntegerParameters?: IntegerParameter[];
222
+ /**
223
+ * <p>The parameters that have a data type of date-time.</p>
224
+ *
225
+ * @minItems 0
226
+ * @maxItems 100
227
+ */
228
+ DateTimeParameters?: DateTimeParameter[];
229
+ }
230
+ /**
231
+ * <p>A string parameter.</p>
232
+ */
233
+ export interface StringParameter {
234
+ /**
235
+ * <p>The values of a string parameter.</p>
236
+ */
237
+ Values: string[];
238
+ /**
239
+ * <p>A display name for a string parameter.</p>
240
+ */
241
+ Name: string;
242
+ }
243
+ /**
244
+ * <p>A decimal parameter.</p>
245
+ */
246
+ export interface DecimalParameter {
247
+ /**
248
+ * <p>The values for the decimal parameter.</p>
249
+ */
250
+ Values: number[];
251
+ /**
252
+ * <p>A display name for the decimal parameter.</p>
253
+ */
254
+ Name: string;
255
+ }
256
+ /**
257
+ * <p>An integer parameter.</p>
258
+ */
259
+ export interface IntegerParameter {
260
+ /**
261
+ * <p>The values for the integer parameter.</p>
262
+ */
263
+ Values: number[];
264
+ /**
265
+ * <p>The name of the integer parameter.</p>
266
+ */
267
+ Name: string;
268
+ }
269
+ /**
270
+ * <p>A date-time parameter.</p>
271
+ */
272
+ export interface DateTimeParameter {
273
+ /**
274
+ * <p>The values for the date-time parameter.</p>
275
+ */
276
+ Values: string[];
277
+ /**
278
+ * <p>A display name for the date-time parameter.</p>
279
+ */
280
+ Name: string;
281
+ }
282
+ /**
283
+ * <p>The source entity of an analysis.</p>
284
+ */
285
+ export interface AnalysisSourceEntity {
286
+ SourceTemplate?: AnalysisSourceTemplate;
287
+ }
288
+ /**
289
+ * <p>The source template of an analysis.</p>
290
+ */
291
+ export interface AnalysisSourceTemplate {
292
+ /**
293
+ * <p>The dataset references of the source template of an analysis.</p>
294
+ *
295
+ * @minItems 1
296
+ */
297
+ DataSetReferences: DataSetReference[];
298
+ /**
299
+ * <p>The Amazon Resource Name (ARN) of the source template of an analysis.</p>
300
+ */
301
+ Arn: string;
302
+ }
303
+ /**
304
+ * <p>Dataset reference.</p>
305
+ */
306
+ export interface DataSetReference {
307
+ /**
308
+ * <p>Dataset Amazon Resource Name (ARN).</p>
309
+ */
310
+ DataSetArn: string;
311
+ /**
312
+ * <p>Dataset placeholder.</p>
313
+ */
314
+ DataSetPlaceholder: string;
315
+ }
316
+ export interface AnalysisDefinition {
317
+ Options?: AssetOptions;
318
+ /**
319
+ * @minItems 0
320
+ * @maxItems 2000
321
+ */
322
+ FilterGroups?: FilterGroup[];
323
+ QueryExecutionOptions?: QueryExecutionOptions;
324
+ /**
325
+ * @minItems 0
326
+ * @maxItems 200
327
+ */
328
+ StaticFiles?: StaticFile[];
329
+ /**
330
+ * @minItems 0
331
+ * @maxItems 500
332
+ */
333
+ CalculatedFields?: CalculatedField[];
334
+ /**
335
+ * @minItems 1
336
+ * @maxItems 50
337
+ */
338
+ DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[];
339
+ /**
340
+ * @minItems 0
341
+ * @maxItems 2000
342
+ */
343
+ ColumnConfigurations?: ColumnConfiguration[];
344
+ AnalysisDefaults?: AnalysisDefaults;
345
+ /**
346
+ * @minItems 0
347
+ * @maxItems 20
348
+ */
349
+ Sheets?: SheetDefinition[];
350
+ /**
351
+ * @minItems 0
352
+ * @maxItems 200
353
+ */
354
+ ParameterDeclarations?: ParameterDeclaration[];
355
+ }
356
+ export interface AssetOptions {
357
+ Timezone?: string;
358
+ WeekStart?: DayOfTheWeek;
359
+ }
360
+ export interface FilterGroup {
361
+ Status?: WidgetStatus;
362
+ /**
363
+ * @minItems 0
364
+ * @maxItems 20
365
+ */
366
+ Filters: Filter[];
367
+ CrossDataset: CrossDatasetTypes;
368
+ ScopeConfiguration: FilterScopeConfiguration;
369
+ FilterGroupId: string;
370
+ }
371
+ export interface Filter {
372
+ NestedFilter?: NestedFilter;
373
+ NumericEqualityFilter?: NumericEqualityFilter;
374
+ NumericRangeFilter?: NumericRangeFilter;
375
+ TimeRangeFilter?: TimeRangeFilter;
376
+ RelativeDatesFilter?: RelativeDatesFilter;
377
+ TopBottomFilter?: TopBottomFilter;
378
+ TimeEqualityFilter?: TimeEqualityFilter;
379
+ CategoryFilter?: CategoryFilter;
380
+ }
381
+ export interface NestedFilter {
382
+ Column: ColumnIdentifier;
383
+ InnerFilter: InnerFilter;
384
+ IncludeInnerSet: boolean;
385
+ FilterId: string;
386
+ }
387
+ export interface ColumnIdentifier {
388
+ ColumnName: string;
389
+ DataSetIdentifier: string;
390
+ }
391
+ export interface InnerFilter {
392
+ CategoryInnerFilter?: CategoryInnerFilter;
393
+ }
394
+ export interface CategoryInnerFilter {
395
+ Configuration: CategoryFilterConfiguration;
396
+ Column: ColumnIdentifier;
397
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
398
+ }
399
+ export interface CategoryFilterConfiguration {
400
+ CustomFilterListConfiguration?: CustomFilterListConfiguration;
401
+ CustomFilterConfiguration?: CustomFilterConfiguration;
402
+ FilterListConfiguration?: FilterListConfiguration;
403
+ }
404
+ export interface CustomFilterListConfiguration {
405
+ /**
406
+ * @minItems 0
407
+ * @maxItems 100000
408
+ */
409
+ CategoryValues?: string[];
410
+ NullOption: FilterNullOption;
411
+ MatchOperator: CategoryFilterMatchOperator;
412
+ SelectAllOptions?: CategoryFilterSelectAllOptions;
413
+ }
414
+ export interface CustomFilterConfiguration {
415
+ CategoryValue?: string;
416
+ ParameterName?: string;
417
+ NullOption: FilterNullOption;
418
+ MatchOperator: CategoryFilterMatchOperator;
419
+ SelectAllOptions?: CategoryFilterSelectAllOptions;
420
+ }
421
+ export interface FilterListConfiguration {
422
+ /**
423
+ * @minItems 0
424
+ * @maxItems 100000
425
+ */
426
+ CategoryValues?: string[];
427
+ NullOption?: FilterNullOption;
428
+ MatchOperator: CategoryFilterMatchOperator;
429
+ SelectAllOptions?: CategoryFilterSelectAllOptions;
430
+ }
431
+ export interface DefaultFilterControlConfiguration {
432
+ ControlOptions: DefaultFilterControlOptions;
433
+ Title: string;
434
+ }
435
+ export interface DefaultFilterControlOptions {
436
+ DefaultSliderOptions?: DefaultSliderControlOptions;
437
+ DefaultRelativeDateTimeOptions?: DefaultRelativeDateTimeControlOptions;
438
+ DefaultTextFieldOptions?: DefaultTextFieldControlOptions;
439
+ DefaultTextAreaOptions?: DefaultTextAreaControlOptions;
440
+ DefaultDropdownOptions?: DefaultFilterDropDownControlOptions;
441
+ DefaultDateTimePickerOptions?: DefaultDateTimePickerControlOptions;
442
+ DefaultListOptions?: DefaultFilterListControlOptions;
443
+ }
444
+ export interface DefaultSliderControlOptions {
445
+ Type?: SheetControlSliderType;
446
+ StepSize: number;
447
+ DisplayOptions?: SliderControlDisplayOptions;
448
+ MaximumValue: number;
449
+ MinimumValue: number;
450
+ }
451
+ export interface SliderControlDisplayOptions {
452
+ TitleOptions?: LabelOptions;
453
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
454
+ }
455
+ export interface LabelOptions {
456
+ CustomLabel?: string;
457
+ Visibility?: Visibility;
458
+ FontConfiguration?: FontConfiguration;
459
+ }
460
+ export interface FontConfiguration {
461
+ FontStyle?: FontStyle;
462
+ FontSize?: FontSize;
463
+ FontDecoration?: FontDecoration;
464
+ FontColor?: string;
465
+ FontWeight?: FontWeight;
466
+ }
467
+ export interface FontSize {
468
+ Relative?: RelativeFontSize;
469
+ /**
470
+ * String based length that is composed of value and unit in px
471
+ */
472
+ Absolute?: string;
473
+ }
474
+ export interface FontWeight {
475
+ Name?: FontWeightName;
476
+ }
477
+ export interface SheetControlInfoIconLabelOptions {
478
+ Visibility?: Visibility;
479
+ InfoIconText?: string;
480
+ }
481
+ export interface DefaultRelativeDateTimeControlOptions {
482
+ DisplayOptions?: RelativeDateTimeControlDisplayOptions;
483
+ CommitMode?: CommitMode;
484
+ }
485
+ export interface RelativeDateTimeControlDisplayOptions {
486
+ TitleOptions?: LabelOptions;
487
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
488
+ DateTimeFormat?: string;
489
+ }
490
+ export interface DefaultTextFieldControlOptions {
491
+ DisplayOptions?: TextFieldControlDisplayOptions;
492
+ }
493
+ export interface TextFieldControlDisplayOptions {
494
+ TitleOptions?: LabelOptions;
495
+ PlaceholderOptions?: TextControlPlaceholderOptions;
496
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
497
+ }
498
+ export interface TextControlPlaceholderOptions {
499
+ Visibility?: Visibility;
500
+ }
501
+ export interface DefaultTextAreaControlOptions {
502
+ Delimiter?: string;
503
+ DisplayOptions?: TextAreaControlDisplayOptions;
504
+ }
505
+ export interface TextAreaControlDisplayOptions {
506
+ TitleOptions?: LabelOptions;
507
+ PlaceholderOptions?: TextControlPlaceholderOptions;
508
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
509
+ }
510
+ export interface DefaultFilterDropDownControlOptions {
511
+ Type?: SheetControlListType;
512
+ DisplayOptions?: DropDownControlDisplayOptions;
513
+ CommitMode?: CommitMode;
514
+ SelectableValues?: FilterSelectableValues;
515
+ }
516
+ export interface DropDownControlDisplayOptions {
517
+ TitleOptions?: LabelOptions;
518
+ SelectAllOptions?: ListControlSelectAllOptions;
519
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
520
+ }
521
+ export interface ListControlSelectAllOptions {
522
+ Visibility?: Visibility;
523
+ }
524
+ export interface FilterSelectableValues {
525
+ /**
526
+ * @minItems 0
527
+ * @maxItems 50000
528
+ */
529
+ Values?: string[];
530
+ }
531
+ export interface DefaultDateTimePickerControlOptions {
532
+ Type?: SheetControlDateTimePickerType;
533
+ DisplayOptions?: DateTimePickerControlDisplayOptions;
534
+ CommitMode?: CommitMode;
535
+ }
536
+ export interface DateTimePickerControlDisplayOptions {
537
+ TitleOptions?: LabelOptions;
538
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
539
+ DateTimeFormat?: string;
540
+ }
541
+ export interface DefaultFilterListControlOptions {
542
+ Type?: SheetControlListType;
543
+ DisplayOptions?: ListControlDisplayOptions;
544
+ SelectableValues?: FilterSelectableValues;
545
+ }
546
+ export interface ListControlDisplayOptions {
547
+ TitleOptions?: LabelOptions;
548
+ SearchOptions?: ListControlSearchOptions;
549
+ SelectAllOptions?: ListControlSelectAllOptions;
550
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
551
+ }
552
+ export interface ListControlSearchOptions {
553
+ Visibility?: Visibility;
554
+ }
555
+ export interface NumericEqualityFilter {
556
+ AggregationFunction?: AggregationFunction;
557
+ Column: ColumnIdentifier;
558
+ Value?: number;
559
+ ParameterName?: string;
560
+ NullOption: FilterNullOption;
561
+ MatchOperator: NumericEqualityMatchOperator;
562
+ SelectAllOptions?: NumericFilterSelectAllOptions;
563
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
564
+ FilterId: string;
565
+ }
566
+ export interface AggregationFunction {
567
+ AttributeAggregationFunction?: AttributeAggregationFunction;
568
+ DateAggregationFunction?: DateAggregationFunction;
569
+ NumericalAggregationFunction?: NumericalAggregationFunction;
570
+ CategoricalAggregationFunction?: CategoricalAggregationFunction;
571
+ }
572
+ export interface AttributeAggregationFunction {
573
+ SimpleAttributeAggregation?: SimpleAttributeAggregationFunction;
574
+ ValueForMultipleValues?: string;
575
+ }
576
+ export interface NumericalAggregationFunction {
577
+ PercentileAggregation?: PercentileAggregation;
578
+ SimpleNumericalAggregation?: SimpleNumericalAggregationFunction;
579
+ }
580
+ export interface PercentileAggregation {
581
+ PercentileValue?: number;
582
+ }
583
+ export interface NumericRangeFilter {
584
+ AggregationFunction?: AggregationFunction;
585
+ Column: ColumnIdentifier;
586
+ IncludeMaximum?: boolean;
587
+ RangeMinimum?: NumericRangeFilterValue;
588
+ NullOption: FilterNullOption;
589
+ SelectAllOptions?: NumericFilterSelectAllOptions;
590
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
591
+ FilterId: string;
592
+ RangeMaximum?: NumericRangeFilterValue;
593
+ IncludeMinimum?: boolean;
594
+ }
595
+ export interface NumericRangeFilterValue {
596
+ StaticValue?: number;
597
+ Parameter?: string;
598
+ }
599
+ export interface TimeRangeFilter {
600
+ RangeMinimumValue?: TimeRangeFilterValue;
601
+ Column: ColumnIdentifier;
602
+ RangeMaximumValue?: TimeRangeFilterValue;
603
+ IncludeMaximum?: boolean;
604
+ TimeGranularity?: TimeGranularity;
605
+ NullOption: FilterNullOption;
606
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
607
+ FilterId: string;
608
+ IncludeMinimum?: boolean;
609
+ ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
610
+ }
611
+ export interface TimeRangeFilterValue {
612
+ RollingDate?: RollingDateConfiguration;
613
+ StaticValue?: string;
614
+ Parameter?: string;
615
+ }
616
+ export interface RollingDateConfiguration {
617
+ Expression: string;
618
+ DataSetIdentifier?: string;
619
+ }
620
+ export interface ExcludePeriodConfiguration {
621
+ Status?: WidgetStatus;
622
+ Amount: number;
623
+ Granularity: TimeGranularity;
624
+ }
625
+ export interface RelativeDatesFilter {
626
+ RelativeDateValue?: number;
627
+ Column: ColumnIdentifier;
628
+ RelativeDateType: RelativeDateType;
629
+ TimeGranularity: TimeGranularity;
630
+ ParameterName?: string;
631
+ NullOption: FilterNullOption;
632
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
633
+ FilterId: string;
634
+ AnchorDateConfiguration: AnchorDateConfiguration;
635
+ MinimumGranularity?: TimeGranularity;
636
+ ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
637
+ }
638
+ export interface AnchorDateConfiguration {
639
+ AnchorOption?: AnchorOption;
640
+ ParameterName?: string;
641
+ }
642
+ export interface TopBottomFilter {
643
+ /**
644
+ * @minItems 0
645
+ * @maxItems 100
646
+ */
647
+ AggregationSortConfigurations: AggregationSortConfiguration[];
648
+ Column: ColumnIdentifier;
649
+ TimeGranularity?: TimeGranularity;
650
+ ParameterName?: string;
651
+ Limit?: number;
652
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
653
+ FilterId: string;
654
+ }
655
+ export interface AggregationSortConfiguration {
656
+ AggregationFunction?: AggregationFunction;
657
+ SortDirection: SortDirection;
658
+ Column: ColumnIdentifier;
659
+ }
660
+ export interface TimeEqualityFilter {
661
+ Column: ColumnIdentifier;
662
+ RollingDate?: RollingDateConfiguration;
663
+ Value?: string;
664
+ TimeGranularity?: TimeGranularity;
665
+ ParameterName?: string;
666
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
667
+ FilterId: string;
668
+ }
669
+ export interface CategoryFilter {
670
+ Configuration: CategoryFilterConfiguration;
671
+ Column: ColumnIdentifier;
672
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
673
+ FilterId: string;
674
+ }
675
+ export interface FilterScopeConfiguration {
676
+ AllSheets?: AllSheetsFilterScopeConfiguration;
677
+ SelectedSheets?: SelectedSheetsFilterScopeConfiguration;
678
+ }
679
+ export interface AllSheetsFilterScopeConfiguration {
680
+ }
681
+ export interface SelectedSheetsFilterScopeConfiguration {
682
+ /**
683
+ * @minItems 1
684
+ * @maxItems 50
685
+ */
686
+ SheetVisualScopingConfigurations?: SheetVisualScopingConfiguration[];
687
+ }
688
+ export interface SheetVisualScopingConfiguration {
689
+ Scope: FilterVisualScope;
690
+ SheetId: string;
691
+ /**
692
+ * @minItems 0
693
+ * @maxItems 50
694
+ */
695
+ VisualIds?: string[];
696
+ }
697
+ export interface QueryExecutionOptions {
698
+ QueryExecutionMode?: QueryExecutionMode;
699
+ }
700
+ export interface StaticFile {
701
+ ImageStaticFile?: ImageStaticFile;
702
+ SpatialStaticFile?: SpatialStaticFile;
703
+ }
704
+ export interface ImageStaticFile {
705
+ StaticFileId: string;
706
+ Source?: StaticFileSource;
707
+ }
708
+ export interface StaticFileSource {
709
+ UrlOptions?: StaticFileUrlSourceOptions;
710
+ S3Options?: StaticFileS3SourceOptions;
711
+ }
712
+ export interface StaticFileUrlSourceOptions {
713
+ Url: string;
714
+ }
715
+ export interface StaticFileS3SourceOptions {
716
+ BucketName: string;
717
+ ObjectKey: string;
718
+ Region: string;
719
+ }
720
+ export interface SpatialStaticFile {
721
+ StaticFileId: string;
722
+ Source?: StaticFileSource;
723
+ }
724
+ export interface CalculatedField {
725
+ Expression: string;
726
+ DataSetIdentifier: string;
727
+ Name: string;
728
+ }
729
+ export interface DataSetIdentifierDeclaration {
730
+ Identifier: string;
731
+ DataSetArn: string;
732
+ }
733
+ export interface ColumnConfiguration {
734
+ Role?: ColumnRole;
735
+ FormatConfiguration?: FormatConfiguration;
736
+ Column: ColumnIdentifier;
737
+ ColorsConfiguration?: ColorsConfiguration;
738
+ }
739
+ export interface FormatConfiguration {
740
+ NumberFormatConfiguration?: NumberFormatConfiguration;
741
+ DateTimeFormatConfiguration?: DateTimeFormatConfiguration;
742
+ StringFormatConfiguration?: StringFormatConfiguration;
743
+ }
744
+ export interface NumberFormatConfiguration {
745
+ FormatConfiguration?: NumericFormatConfiguration;
746
+ }
747
+ export interface NumericFormatConfiguration {
748
+ NumberDisplayFormatConfiguration?: NumberDisplayFormatConfiguration;
749
+ CurrencyDisplayFormatConfiguration?: CurrencyDisplayFormatConfiguration;
750
+ PercentageDisplayFormatConfiguration?: PercentageDisplayFormatConfiguration;
751
+ }
752
+ export interface NumberDisplayFormatConfiguration {
753
+ NegativeValueConfiguration?: NegativeValueConfiguration;
754
+ DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
755
+ NumberScale?: NumberScale;
756
+ NullValueFormatConfiguration?: NullValueFormatConfiguration;
757
+ Suffix?: string;
758
+ SeparatorConfiguration?: NumericSeparatorConfiguration;
759
+ Prefix?: string;
760
+ }
761
+ export interface NegativeValueConfiguration {
762
+ DisplayMode: NegativeValueDisplayMode;
763
+ }
764
+ export interface DecimalPlacesConfiguration {
765
+ DecimalPlaces: number;
766
+ }
767
+ export interface NullValueFormatConfiguration {
768
+ NullString: string;
769
+ }
770
+ export interface NumericSeparatorConfiguration {
771
+ DecimalSeparator?: NumericSeparatorSymbol;
772
+ ThousandsSeparator?: ThousandSeparatorOptions;
773
+ }
774
+ export interface ThousandSeparatorOptions {
775
+ Symbol?: NumericSeparatorSymbol;
776
+ Visibility?: Visibility;
777
+ }
778
+ export interface CurrencyDisplayFormatConfiguration {
779
+ NegativeValueConfiguration?: NegativeValueConfiguration;
780
+ DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
781
+ NumberScale?: NumberScale;
782
+ NullValueFormatConfiguration?: NullValueFormatConfiguration;
783
+ Suffix?: string;
784
+ SeparatorConfiguration?: NumericSeparatorConfiguration;
785
+ Symbol?: string;
786
+ Prefix?: string;
787
+ }
788
+ export interface PercentageDisplayFormatConfiguration {
789
+ NegativeValueConfiguration?: NegativeValueConfiguration;
790
+ DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
791
+ NullValueFormatConfiguration?: NullValueFormatConfiguration;
792
+ Suffix?: string;
793
+ SeparatorConfiguration?: NumericSeparatorConfiguration;
794
+ Prefix?: string;
795
+ }
796
+ export interface DateTimeFormatConfiguration {
797
+ NumericFormatConfiguration?: NumericFormatConfiguration;
798
+ NullValueFormatConfiguration?: NullValueFormatConfiguration;
799
+ DateTimeFormat?: string;
800
+ }
801
+ export interface StringFormatConfiguration {
802
+ NumericFormatConfiguration?: NumericFormatConfiguration;
803
+ NullValueFormatConfiguration?: NullValueFormatConfiguration;
804
+ }
805
+ export interface ColorsConfiguration {
806
+ /**
807
+ * @minItems 0
808
+ * @maxItems 50
809
+ */
810
+ CustomColors?: CustomColor[];
811
+ }
812
+ export interface CustomColor {
813
+ Color: string;
814
+ FieldValue?: string;
815
+ SpecialValue?: SpecialValue;
816
+ }
817
+ export interface AnalysisDefaults {
818
+ DefaultNewSheetConfiguration: DefaultNewSheetConfiguration;
819
+ }
820
+ export interface DefaultNewSheetConfiguration {
821
+ SheetContentType?: SheetContentType;
822
+ InteractiveLayoutConfiguration?: DefaultInteractiveLayoutConfiguration;
823
+ PaginatedLayoutConfiguration?: DefaultPaginatedLayoutConfiguration;
824
+ }
825
+ export interface DefaultInteractiveLayoutConfiguration {
826
+ FreeForm?: DefaultFreeFormLayoutConfiguration;
827
+ Grid?: DefaultGridLayoutConfiguration;
828
+ }
829
+ export interface DefaultFreeFormLayoutConfiguration {
830
+ CanvasSizeOptions: FreeFormLayoutCanvasSizeOptions;
831
+ }
832
+ export interface FreeFormLayoutCanvasSizeOptions {
833
+ ScreenCanvasSizeOptions?: FreeFormLayoutScreenCanvasSizeOptions;
834
+ }
835
+ export interface FreeFormLayoutScreenCanvasSizeOptions {
836
+ /**
837
+ * String based length that is composed of value and unit in px
838
+ */
839
+ OptimizedViewPortWidth: string;
840
+ }
841
+ export interface DefaultGridLayoutConfiguration {
842
+ CanvasSizeOptions: GridLayoutCanvasSizeOptions;
843
+ }
844
+ export interface GridLayoutCanvasSizeOptions {
845
+ ScreenCanvasSizeOptions?: GridLayoutScreenCanvasSizeOptions;
846
+ }
847
+ export interface GridLayoutScreenCanvasSizeOptions {
848
+ /**
849
+ * String based length that is composed of value and unit in px
850
+ */
851
+ OptimizedViewPortWidth?: string;
852
+ ResizeOption: ResizeOption;
853
+ }
854
+ export interface DefaultPaginatedLayoutConfiguration {
855
+ SectionBased?: DefaultSectionBasedLayoutConfiguration;
856
+ }
857
+ export interface DefaultSectionBasedLayoutConfiguration {
858
+ CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptions;
859
+ }
860
+ export interface SectionBasedLayoutCanvasSizeOptions {
861
+ PaperCanvasSizeOptions?: SectionBasedLayoutPaperCanvasSizeOptions;
862
+ }
863
+ export interface SectionBasedLayoutPaperCanvasSizeOptions {
864
+ PaperMargin?: Spacing;
865
+ PaperSize?: PaperSize;
866
+ PaperOrientation?: PaperOrientation;
867
+ }
868
+ export interface Spacing {
869
+ /**
870
+ * String based length that is composed of value and unit
871
+ */
872
+ Left?: string;
873
+ /**
874
+ * String based length that is composed of value and unit
875
+ */
876
+ Top?: string;
877
+ /**
878
+ * String based length that is composed of value and unit
879
+ */
880
+ Right?: string;
881
+ /**
882
+ * String based length that is composed of value and unit
883
+ */
884
+ Bottom?: string;
885
+ }
886
+ export interface SheetDefinition {
887
+ Description?: string;
888
+ /**
889
+ * @minItems 0
890
+ * @maxItems 200
891
+ */
892
+ ParameterControls?: ParameterControl[];
893
+ /**
894
+ * @minItems 0
895
+ * @maxItems 100
896
+ */
897
+ TextBoxes?: SheetTextBox[];
898
+ /**
899
+ * @minItems 1
900
+ * @maxItems 1
901
+ */
902
+ Layouts?: Layout[];
903
+ ContentType?: SheetContentType;
904
+ SheetId: string;
905
+ /**
906
+ * @minItems 0
907
+ * @maxItems 200
908
+ */
909
+ FilterControls?: FilterControl[];
910
+ /**
911
+ * @minItems 0
912
+ * @maxItems 10
913
+ */
914
+ Images?: SheetImage[];
915
+ /**
916
+ * @minItems 0
917
+ * @maxItems 1
918
+ */
919
+ SheetControlLayouts?: SheetControlLayout[];
920
+ Title?: string;
921
+ /**
922
+ * @minItems 0
923
+ * @maxItems 50
924
+ */
925
+ Visuals?: Visual[];
926
+ Name?: string;
927
+ }
928
+ export interface ParameterControl {
929
+ Slider?: ParameterSliderControl;
930
+ TextArea?: ParameterTextAreaControl;
931
+ Dropdown?: ParameterDropDownControl;
932
+ TextField?: ParameterTextFieldControl;
933
+ List?: ParameterListControl;
934
+ DateTimePicker?: ParameterDateTimePickerControl;
935
+ }
936
+ export interface ParameterSliderControl {
937
+ ParameterControlId: string;
938
+ StepSize: number;
939
+ DisplayOptions?: SliderControlDisplayOptions;
940
+ SourceParameterName: string;
941
+ Title: string;
942
+ MaximumValue: number;
943
+ MinimumValue: number;
944
+ }
945
+ export interface ParameterTextAreaControl {
946
+ ParameterControlId: string;
947
+ Delimiter?: string;
948
+ DisplayOptions?: TextAreaControlDisplayOptions;
949
+ SourceParameterName: string;
950
+ Title: string;
951
+ }
952
+ export interface ParameterDropDownControl {
953
+ ParameterControlId: string;
954
+ Type?: SheetControlListType;
955
+ DisplayOptions?: DropDownControlDisplayOptions;
956
+ SourceParameterName: string;
957
+ CascadingControlConfiguration?: CascadingControlConfiguration;
958
+ Title: string;
959
+ CommitMode?: CommitMode;
960
+ SelectableValues?: ParameterSelectableValues;
961
+ }
962
+ export interface CascadingControlConfiguration {
963
+ /**
964
+ * @minItems 0
965
+ * @maxItems 200
966
+ */
967
+ SourceControls?: CascadingControlSource[];
968
+ }
969
+ export interface CascadingControlSource {
970
+ SourceSheetControlId?: string;
971
+ ColumnToMatch?: ColumnIdentifier;
972
+ }
973
+ export interface ParameterSelectableValues {
974
+ LinkToDataSetColumn?: ColumnIdentifier;
975
+ /**
976
+ * @minItems 0
977
+ * @maxItems 50000
978
+ */
979
+ Values?: string[];
980
+ }
981
+ export interface ParameterTextFieldControl {
982
+ ParameterControlId: string;
983
+ DisplayOptions?: TextFieldControlDisplayOptions;
984
+ SourceParameterName: string;
985
+ Title: string;
986
+ }
987
+ export interface ParameterListControl {
988
+ ParameterControlId: string;
989
+ Type?: SheetControlListType;
990
+ DisplayOptions?: ListControlDisplayOptions;
991
+ SourceParameterName: string;
992
+ CascadingControlConfiguration?: CascadingControlConfiguration;
993
+ Title: string;
994
+ SelectableValues?: ParameterSelectableValues;
995
+ }
996
+ export interface ParameterDateTimePickerControl {
997
+ ParameterControlId: string;
998
+ DisplayOptions?: DateTimePickerControlDisplayOptions;
999
+ SourceParameterName: string;
1000
+ Title: string;
1001
+ }
1002
+ export interface SheetTextBox {
1003
+ SheetTextBoxId: string;
1004
+ Content?: string;
1005
+ }
1006
+ export interface Layout {
1007
+ Configuration: LayoutConfiguration;
1008
+ }
1009
+ export interface LayoutConfiguration {
1010
+ GridLayout?: GridLayoutConfiguration;
1011
+ FreeFormLayout?: FreeFormLayoutConfiguration;
1012
+ SectionBasedLayout?: SectionBasedLayoutConfiguration;
1013
+ }
1014
+ export interface GridLayoutConfiguration {
1015
+ CanvasSizeOptions?: GridLayoutCanvasSizeOptions;
1016
+ /**
1017
+ * @minItems 0
1018
+ * @maxItems 430
1019
+ */
1020
+ Elements: GridLayoutElement[];
1021
+ }
1022
+ export interface GridLayoutElement {
1023
+ ElementType: LayoutElementType;
1024
+ ColumnSpan: number;
1025
+ ColumnIndex?: number;
1026
+ RowIndex?: number;
1027
+ RowSpan: number;
1028
+ ElementId: string;
1029
+ }
1030
+ export interface FreeFormLayoutConfiguration {
1031
+ CanvasSizeOptions?: FreeFormLayoutCanvasSizeOptions;
1032
+ /**
1033
+ * @minItems 0
1034
+ * @maxItems 430
1035
+ */
1036
+ Elements: FreeFormLayoutElement[];
1037
+ }
1038
+ export interface FreeFormLayoutElement {
1039
+ ElementType: LayoutElementType;
1040
+ BorderStyle?: FreeFormLayoutElementBorderStyle;
1041
+ /**
1042
+ * String based length that is composed of value and unit in px
1043
+ */
1044
+ Height: string;
1045
+ Visibility?: Visibility;
1046
+ /**
1047
+ * @minItems 0
1048
+ * @maxItems 10000
1049
+ */
1050
+ RenderingRules?: SheetElementRenderingRule[];
1051
+ /**
1052
+ * String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value
1053
+ */
1054
+ YAxisLocation: string;
1055
+ LoadingAnimation?: LoadingAnimation;
1056
+ /**
1057
+ * String based length that is composed of value and unit in px
1058
+ */
1059
+ Width: string;
1060
+ BackgroundStyle?: FreeFormLayoutElementBackgroundStyle;
1061
+ ElementId: string;
1062
+ /**
1063
+ * String based length that is composed of value and unit in px
1064
+ */
1065
+ XAxisLocation: string;
1066
+ SelectedBorderStyle?: FreeFormLayoutElementBorderStyle;
1067
+ }
1068
+ export interface FreeFormLayoutElementBorderStyle {
1069
+ Color?: string;
1070
+ Visibility?: Visibility;
1071
+ }
1072
+ export interface SheetElementRenderingRule {
1073
+ Expression: string;
1074
+ ConfigurationOverrides: SheetElementConfigurationOverrides;
1075
+ }
1076
+ export interface SheetElementConfigurationOverrides {
1077
+ Visibility?: Visibility;
1078
+ }
1079
+ export interface LoadingAnimation {
1080
+ Visibility?: Visibility;
1081
+ }
1082
+ export interface FreeFormLayoutElementBackgroundStyle {
1083
+ Color?: string;
1084
+ Visibility?: Visibility;
1085
+ }
1086
+ export interface SectionBasedLayoutConfiguration {
1087
+ CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptions;
1088
+ /**
1089
+ * @minItems 0
1090
+ * @maxItems 1
1091
+ */
1092
+ FooterSections: HeaderFooterSectionConfiguration[];
1093
+ /**
1094
+ * @minItems 0
1095
+ * @maxItems 28
1096
+ */
1097
+ BodySections: BodySectionConfiguration[];
1098
+ /**
1099
+ * @minItems 0
1100
+ * @maxItems 1
1101
+ */
1102
+ HeaderSections: HeaderFooterSectionConfiguration[];
1103
+ }
1104
+ export interface HeaderFooterSectionConfiguration {
1105
+ Layout: SectionLayoutConfiguration;
1106
+ Style?: SectionStyle;
1107
+ SectionId: string;
1108
+ }
1109
+ export interface SectionLayoutConfiguration {
1110
+ FreeFormLayout: FreeFormSectionLayoutConfiguration;
1111
+ }
1112
+ export interface FreeFormSectionLayoutConfiguration {
1113
+ /**
1114
+ * @minItems 0
1115
+ * @maxItems 430
1116
+ */
1117
+ Elements: FreeFormLayoutElement[];
1118
+ }
1119
+ export interface SectionStyle {
1120
+ Padding?: Spacing;
1121
+ /**
1122
+ * String based length that is composed of value and unit in px
1123
+ */
1124
+ Height?: string;
1125
+ }
1126
+ export interface BodySectionConfiguration {
1127
+ Content: BodySectionContent;
1128
+ Style?: SectionStyle;
1129
+ PageBreakConfiguration?: SectionPageBreakConfiguration;
1130
+ SectionId: string;
1131
+ }
1132
+ export interface BodySectionContent {
1133
+ Layout?: SectionLayoutConfiguration;
1134
+ }
1135
+ export interface SectionPageBreakConfiguration {
1136
+ After?: SectionAfterPageBreak;
1137
+ }
1138
+ export interface SectionAfterPageBreak {
1139
+ Status?: SectionPageBreakStatus;
1140
+ }
1141
+ export interface FilterControl {
1142
+ Slider?: FilterSliderControl;
1143
+ TextArea?: FilterTextAreaControl;
1144
+ Dropdown?: FilterDropDownControl;
1145
+ TextField?: FilterTextFieldControl;
1146
+ List?: FilterListControl;
1147
+ DateTimePicker?: FilterDateTimePickerControl;
1148
+ RelativeDateTime?: FilterRelativeDateTimeControl;
1149
+ CrossSheet?: FilterCrossSheetControl;
1150
+ }
1151
+ export interface FilterSliderControl {
1152
+ FilterControlId: string;
1153
+ Type?: SheetControlSliderType;
1154
+ StepSize: number;
1155
+ DisplayOptions?: SliderControlDisplayOptions;
1156
+ Title: string;
1157
+ MaximumValue: number;
1158
+ SourceFilterId: string;
1159
+ MinimumValue: number;
1160
+ }
1161
+ export interface FilterTextAreaControl {
1162
+ FilterControlId: string;
1163
+ Delimiter?: string;
1164
+ DisplayOptions?: TextAreaControlDisplayOptions;
1165
+ Title: string;
1166
+ SourceFilterId: string;
1167
+ }
1168
+ export interface FilterDropDownControl {
1169
+ FilterControlId: string;
1170
+ Type?: SheetControlListType;
1171
+ DisplayOptions?: DropDownControlDisplayOptions;
1172
+ CascadingControlConfiguration?: CascadingControlConfiguration;
1173
+ Title: string;
1174
+ CommitMode?: CommitMode;
1175
+ SourceFilterId: string;
1176
+ SelectableValues?: FilterSelectableValues;
1177
+ }
1178
+ export interface FilterTextFieldControl {
1179
+ FilterControlId: string;
1180
+ DisplayOptions?: TextFieldControlDisplayOptions;
1181
+ Title: string;
1182
+ SourceFilterId: string;
1183
+ }
1184
+ export interface FilterListControl {
1185
+ FilterControlId: string;
1186
+ Type?: SheetControlListType;
1187
+ DisplayOptions?: ListControlDisplayOptions;
1188
+ CascadingControlConfiguration?: CascadingControlConfiguration;
1189
+ Title: string;
1190
+ SourceFilterId: string;
1191
+ SelectableValues?: FilterSelectableValues;
1192
+ }
1193
+ export interface FilterDateTimePickerControl {
1194
+ FilterControlId: string;
1195
+ Type?: SheetControlDateTimePickerType;
1196
+ DisplayOptions?: DateTimePickerControlDisplayOptions;
1197
+ Title: string;
1198
+ CommitMode?: CommitMode;
1199
+ SourceFilterId: string;
1200
+ }
1201
+ export interface FilterRelativeDateTimeControl {
1202
+ FilterControlId: string;
1203
+ DisplayOptions?: RelativeDateTimeControlDisplayOptions;
1204
+ Title: string;
1205
+ CommitMode?: CommitMode;
1206
+ SourceFilterId: string;
1207
+ }
1208
+ export interface FilterCrossSheetControl {
1209
+ FilterControlId: string;
1210
+ CascadingControlConfiguration?: CascadingControlConfiguration;
1211
+ SourceFilterId: string;
1212
+ }
1213
+ export interface SheetImage {
1214
+ /**
1215
+ * @minItems 0
1216
+ * @maxItems 10
1217
+ */
1218
+ Actions?: ImageCustomAction[];
1219
+ SheetImageId: string;
1220
+ Tooltip?: SheetImageTooltipConfiguration;
1221
+ Scaling?: SheetImageScalingConfiguration;
1222
+ Interactions?: ImageInteractionOptions;
1223
+ Source: SheetImageSource;
1224
+ ImageContentAltText?: string;
1225
+ }
1226
+ export interface ImageCustomAction {
1227
+ Status?: WidgetStatus;
1228
+ Trigger: ImageCustomActionTrigger;
1229
+ CustomActionId: string;
1230
+ Name: string;
1231
+ /**
1232
+ * @minItems 1
1233
+ * @maxItems 2
1234
+ */
1235
+ ActionOperations: ImageCustomActionOperation[];
1236
+ }
1237
+ export interface ImageCustomActionOperation {
1238
+ NavigationOperation?: CustomActionNavigationOperation;
1239
+ SetParametersOperation?: CustomActionSetParametersOperation;
1240
+ URLOperation?: CustomActionURLOperation;
1241
+ }
1242
+ export interface CustomActionNavigationOperation {
1243
+ LocalNavigationConfiguration?: LocalNavigationConfiguration;
1244
+ }
1245
+ export interface LocalNavigationConfiguration {
1246
+ TargetSheetId: string;
1247
+ }
1248
+ export interface CustomActionSetParametersOperation {
1249
+ /**
1250
+ * @minItems 1
1251
+ * @maxItems 200
1252
+ */
1253
+ ParameterValueConfigurations: SetParameterValueConfiguration[];
1254
+ }
1255
+ export interface SetParameterValueConfiguration {
1256
+ DestinationParameterName: string;
1257
+ Value: DestinationParameterValueConfiguration;
1258
+ }
1259
+ export interface DestinationParameterValueConfiguration {
1260
+ CustomValuesConfiguration?: CustomValuesConfiguration;
1261
+ SourceParameterName?: string;
1262
+ SelectAllValueOptions?: SelectAllValueOptions;
1263
+ SourceField?: string;
1264
+ SourceColumn?: ColumnIdentifier;
1265
+ }
1266
+ export interface CustomValuesConfiguration {
1267
+ IncludeNullValue?: boolean;
1268
+ CustomValues: CustomParameterValues;
1269
+ }
1270
+ export interface CustomParameterValues {
1271
+ /**
1272
+ * @minItems 0
1273
+ * @maxItems 50000
1274
+ */
1275
+ DecimalValues?: number[];
1276
+ /**
1277
+ * @minItems 0
1278
+ * @maxItems 50000
1279
+ */
1280
+ IntegerValues?: number[];
1281
+ /**
1282
+ * @minItems 0
1283
+ * @maxItems 50000
1284
+ */
1285
+ StringValues?: string[];
1286
+ /**
1287
+ * @minItems 0
1288
+ * @maxItems 50000
1289
+ */
1290
+ DateTimeValues?: string[];
1291
+ }
1292
+ export interface CustomActionURLOperation {
1293
+ URLTemplate: string;
1294
+ URLTarget: URLTargetConfiguration;
1295
+ }
1296
+ export interface SheetImageTooltipConfiguration {
1297
+ Visibility?: Visibility;
1298
+ TooltipText?: SheetImageTooltipText;
1299
+ }
1300
+ export interface SheetImageTooltipText {
1301
+ PlainText?: string;
1302
+ }
1303
+ export interface SheetImageScalingConfiguration {
1304
+ ScalingType?: SheetImageScalingType;
1305
+ }
1306
+ export interface ImageInteractionOptions {
1307
+ ImageMenuOption?: ImageMenuOption;
1308
+ }
1309
+ export interface ImageMenuOption {
1310
+ AvailabilityStatus?: unknown;
1311
+ }
1312
+ export interface SheetImageSource {
1313
+ SheetImageStaticFileSource?: SheetImageStaticFileSource;
1314
+ }
1315
+ export interface SheetImageStaticFileSource {
1316
+ StaticFileId: string;
1317
+ }
1318
+ export interface SheetControlLayout {
1319
+ Configuration: SheetControlLayoutConfiguration;
1320
+ }
1321
+ export interface SheetControlLayoutConfiguration {
1322
+ GridLayout?: GridLayoutConfiguration;
1323
+ }
1324
+ export interface Visual {
1325
+ FunnelChartVisual?: FunnelChartVisual;
1326
+ BoxPlotVisual?: BoxPlotVisual;
1327
+ LayerMapVisual?: LayerMapVisual;
1328
+ GeospatialMapVisual?: GeospatialMapVisual;
1329
+ ScatterPlotVisual?: ScatterPlotVisual;
1330
+ RadarChartVisual?: RadarChartVisual;
1331
+ ComboChartVisual?: ComboChartVisual;
1332
+ WordCloudVisual?: WordCloudVisual;
1333
+ SankeyDiagramVisual?: SankeyDiagramVisual;
1334
+ GaugeChartVisual?: GaugeChartVisual;
1335
+ FilledMapVisual?: FilledMapVisual;
1336
+ WaterfallVisual?: WaterfallVisual;
1337
+ CustomContentVisual?: CustomContentVisual;
1338
+ PieChartVisual?: PieChartVisual;
1339
+ KPIVisual?: KPIVisual;
1340
+ HistogramVisual?: HistogramVisual;
1341
+ PluginVisual?: PluginVisual;
1342
+ TableVisual?: TableVisual;
1343
+ PivotTableVisual?: PivotTableVisual;
1344
+ BarChartVisual?: BarChartVisual;
1345
+ HeatMapVisual?: HeatMapVisual;
1346
+ TreeMapVisual?: TreeMapVisual;
1347
+ InsightVisual?: InsightVisual;
1348
+ LineChartVisual?: LineChartVisual;
1349
+ EmptyVisual?: EmptyVisual;
1350
+ }
1351
+ export interface FunnelChartVisual {
1352
+ Subtitle?: VisualSubtitleLabelOptions;
1353
+ VisualId: string;
1354
+ ChartConfiguration?: FunnelChartConfiguration;
1355
+ /**
1356
+ * @minItems 0
1357
+ * @maxItems 10
1358
+ */
1359
+ Actions?: VisualCustomAction[];
1360
+ Title?: VisualTitleLabelOptions;
1361
+ VisualContentAltText?: string;
1362
+ /**
1363
+ * @minItems 0
1364
+ * @maxItems 2
1365
+ */
1366
+ ColumnHierarchies?: ColumnHierarchy[];
1367
+ }
1368
+ export interface VisualSubtitleLabelOptions {
1369
+ Visibility?: Visibility;
1370
+ FormatText?: LongFormatText;
1371
+ }
1372
+ export interface LongFormatText {
1373
+ RichText?: string;
1374
+ PlainText?: string;
1375
+ }
1376
+ export interface FunnelChartConfiguration {
1377
+ SortConfiguration?: FunnelChartSortConfiguration;
1378
+ DataLabelOptions?: FunnelChartDataLabelOptions;
1379
+ CategoryLabelOptions?: ChartAxisLabelOptions;
1380
+ FieldWells?: FunnelChartFieldWells;
1381
+ Tooltip?: TooltipOptions;
1382
+ ValueLabelOptions?: ChartAxisLabelOptions;
1383
+ VisualPalette?: VisualPalette;
1384
+ }
1385
+ export interface FunnelChartSortConfiguration {
1386
+ CategoryItemsLimit?: ItemsLimitConfiguration;
1387
+ /**
1388
+ * @minItems 0
1389
+ * @maxItems 100
1390
+ */
1391
+ CategorySort?: FieldSortOptions[];
1392
+ }
1393
+ export interface ItemsLimitConfiguration {
1394
+ ItemsLimit?: number;
1395
+ OtherCategories?: OtherCategories;
1396
+ }
1397
+ export interface FieldSortOptions {
1398
+ FieldSort?: FieldSort;
1399
+ ColumnSort?: ColumnSort;
1400
+ }
1401
+ export interface FieldSort {
1402
+ FieldId: string;
1403
+ Direction: SortDirection;
1404
+ }
1405
+ export interface ColumnSort {
1406
+ AggregationFunction?: AggregationFunction;
1407
+ SortBy: ColumnIdentifier;
1408
+ Direction: SortDirection;
1409
+ }
1410
+ export interface FunnelChartDataLabelOptions {
1411
+ MeasureLabelVisibility?: Visibility;
1412
+ Position?: DataLabelPosition;
1413
+ Visibility?: Visibility;
1414
+ CategoryLabelVisibility?: Visibility;
1415
+ LabelColor?: string;
1416
+ MeasureDataLabelStyle?: FunnelChartMeasureDataLabelStyle;
1417
+ LabelFontConfiguration?: FontConfiguration;
1418
+ }
1419
+ export interface ChartAxisLabelOptions {
1420
+ Visibility?: Visibility;
1421
+ SortIconVisibility?: Visibility;
1422
+ /**
1423
+ * @minItems 0
1424
+ * @maxItems 100
1425
+ */
1426
+ AxisLabelOptions?: AxisLabelOptions[];
1427
+ }
1428
+ export interface AxisLabelOptions {
1429
+ CustomLabel?: string;
1430
+ ApplyTo?: AxisLabelReferenceOptions;
1431
+ FontConfiguration?: FontConfiguration;
1432
+ }
1433
+ export interface AxisLabelReferenceOptions {
1434
+ Column: ColumnIdentifier;
1435
+ FieldId: string;
1436
+ }
1437
+ export interface FunnelChartFieldWells {
1438
+ FunnelChartAggregatedFieldWells?: FunnelChartAggregatedFieldWells;
1439
+ }
1440
+ export interface FunnelChartAggregatedFieldWells {
1441
+ /**
1442
+ * @minItems 0
1443
+ * @maxItems 1
1444
+ */
1445
+ Category?: DimensionField[];
1446
+ /**
1447
+ * @minItems 0
1448
+ * @maxItems 1
1449
+ */
1450
+ Values?: MeasureField[];
1451
+ }
1452
+ export interface DimensionField {
1453
+ DateDimensionField?: DateDimensionField;
1454
+ NumericalDimensionField?: NumericalDimensionField;
1455
+ CategoricalDimensionField?: CategoricalDimensionField;
1456
+ }
1457
+ export interface DateDimensionField {
1458
+ HierarchyId?: string;
1459
+ FormatConfiguration?: DateTimeFormatConfiguration;
1460
+ Column: ColumnIdentifier;
1461
+ FieldId: string;
1462
+ DateGranularity?: TimeGranularity;
1463
+ }
1464
+ export interface NumericalDimensionField {
1465
+ HierarchyId?: string;
1466
+ FormatConfiguration?: NumberFormatConfiguration;
1467
+ Column: ColumnIdentifier;
1468
+ FieldId: string;
1469
+ }
1470
+ export interface CategoricalDimensionField {
1471
+ HierarchyId?: string;
1472
+ FormatConfiguration?: StringFormatConfiguration;
1473
+ Column: ColumnIdentifier;
1474
+ FieldId: string;
1475
+ }
1476
+ export interface MeasureField {
1477
+ DateMeasureField?: DateMeasureField;
1478
+ NumericalMeasureField?: NumericalMeasureField;
1479
+ CategoricalMeasureField?: CategoricalMeasureField;
1480
+ CalculatedMeasureField?: CalculatedMeasureField;
1481
+ }
1482
+ export interface DateMeasureField {
1483
+ AggregationFunction?: DateAggregationFunction;
1484
+ FormatConfiguration?: DateTimeFormatConfiguration;
1485
+ Column: ColumnIdentifier;
1486
+ FieldId: string;
1487
+ }
1488
+ export interface NumericalMeasureField {
1489
+ AggregationFunction?: NumericalAggregationFunction;
1490
+ FormatConfiguration?: NumberFormatConfiguration;
1491
+ Column: ColumnIdentifier;
1492
+ FieldId: string;
1493
+ }
1494
+ export interface CategoricalMeasureField {
1495
+ AggregationFunction?: CategoricalAggregationFunction;
1496
+ FormatConfiguration?: StringFormatConfiguration;
1497
+ Column: ColumnIdentifier;
1498
+ FieldId: string;
1499
+ }
1500
+ export interface CalculatedMeasureField {
1501
+ Expression: string;
1502
+ FieldId: string;
1503
+ }
1504
+ export interface TooltipOptions {
1505
+ SelectedTooltipType?: SelectedTooltipType;
1506
+ TooltipVisibility?: Visibility;
1507
+ FieldBasedTooltip?: FieldBasedTooltip;
1508
+ }
1509
+ export interface FieldBasedTooltip {
1510
+ /**
1511
+ * @minItems 0
1512
+ * @maxItems 100
1513
+ */
1514
+ TooltipFields?: TooltipItem[];
1515
+ AggregationVisibility?: Visibility;
1516
+ TooltipTitleType?: TooltipTitleType;
1517
+ }
1518
+ export interface TooltipItem {
1519
+ FieldTooltipItem?: FieldTooltipItem;
1520
+ ColumnTooltipItem?: ColumnTooltipItem;
1521
+ }
1522
+ export interface FieldTooltipItem {
1523
+ TooltipTarget?: TooltipTarget;
1524
+ FieldId: string;
1525
+ Label?: string;
1526
+ Visibility?: Visibility;
1527
+ }
1528
+ export interface ColumnTooltipItem {
1529
+ Aggregation?: AggregationFunction;
1530
+ TooltipTarget?: TooltipTarget;
1531
+ Column: ColumnIdentifier;
1532
+ Label?: string;
1533
+ Visibility?: Visibility;
1534
+ }
1535
+ export interface VisualPalette {
1536
+ ChartColor?: string;
1537
+ /**
1538
+ * @minItems 0
1539
+ * @maxItems 5000
1540
+ */
1541
+ ColorMap?: DataPathColor[];
1542
+ }
1543
+ export interface DataPathColor {
1544
+ Element: DataPathValue;
1545
+ Color: string;
1546
+ TimeGranularity?: TimeGranularity;
1547
+ }
1548
+ export interface DataPathValue {
1549
+ DataPathType?: DataPathType;
1550
+ FieldId?: string;
1551
+ FieldValue?: string;
1552
+ }
1553
+ export interface DataPathType {
1554
+ PivotTableDataPathType?: PivotTableDataPathType;
1555
+ }
1556
+ export interface VisualCustomAction {
1557
+ Status?: WidgetStatus;
1558
+ Trigger: VisualCustomActionTrigger;
1559
+ CustomActionId: string;
1560
+ Name: string;
1561
+ /**
1562
+ * @minItems 1
1563
+ * @maxItems 2
1564
+ */
1565
+ ActionOperations: VisualCustomActionOperation[];
1566
+ }
1567
+ export interface VisualCustomActionOperation {
1568
+ NavigationOperation?: CustomActionNavigationOperation;
1569
+ SetParametersOperation?: CustomActionSetParametersOperation;
1570
+ FilterOperation?: CustomActionFilterOperation;
1571
+ URLOperation?: CustomActionURLOperation;
1572
+ }
1573
+ export interface CustomActionFilterOperation {
1574
+ SelectedFieldsConfiguration: FilterOperationSelectedFieldsConfiguration;
1575
+ TargetVisualsConfiguration: FilterOperationTargetVisualsConfiguration;
1576
+ }
1577
+ export interface FilterOperationSelectedFieldsConfiguration {
1578
+ /**
1579
+ * <p>The selected columns of a dataset.</p>
1580
+ *
1581
+ * @minItems 0
1582
+ * @maxItems 10
1583
+ */
1584
+ SelectedColumns?: ColumnIdentifier[];
1585
+ /**
1586
+ * @minItems 1
1587
+ * @maxItems 20
1588
+ */
1589
+ SelectedFields?: string[];
1590
+ SelectedFieldOptions?: SelectedFieldOptions;
1591
+ }
1592
+ export interface FilterOperationTargetVisualsConfiguration {
1593
+ SameSheetTargetVisualConfiguration?: SameSheetTargetVisualConfiguration;
1594
+ }
1595
+ export interface SameSheetTargetVisualConfiguration {
1596
+ TargetVisualOptions?: TargetVisualOptions;
1597
+ /**
1598
+ * @minItems 1
1599
+ * @maxItems 50
1600
+ */
1601
+ TargetVisuals?: string[];
1602
+ }
1603
+ export interface VisualTitleLabelOptions {
1604
+ Visibility?: Visibility;
1605
+ FormatText?: ShortFormatText;
1606
+ }
1607
+ export interface ShortFormatText {
1608
+ RichText?: string;
1609
+ PlainText?: string;
1610
+ }
1611
+ export interface ColumnHierarchy {
1612
+ DateTimeHierarchy?: DateTimeHierarchy;
1613
+ ExplicitHierarchy?: ExplicitHierarchy;
1614
+ PredefinedHierarchy?: PredefinedHierarchy;
1615
+ }
1616
+ export interface DateTimeHierarchy {
1617
+ HierarchyId: string;
1618
+ /**
1619
+ * @minItems 0
1620
+ * @maxItems 10
1621
+ */
1622
+ DrillDownFilters?: DrillDownFilter[];
1623
+ }
1624
+ export interface DrillDownFilter {
1625
+ NumericEqualityFilter?: NumericEqualityDrillDownFilter;
1626
+ TimeRangeFilter?: TimeRangeDrillDownFilter;
1627
+ CategoryFilter?: CategoryDrillDownFilter;
1628
+ }
1629
+ export interface NumericEqualityDrillDownFilter {
1630
+ Column: ColumnIdentifier;
1631
+ Value: number;
1632
+ }
1633
+ export interface TimeRangeDrillDownFilter {
1634
+ Column: ColumnIdentifier;
1635
+ RangeMinimum: string;
1636
+ TimeGranularity: TimeGranularity;
1637
+ RangeMaximum: string;
1638
+ }
1639
+ export interface CategoryDrillDownFilter {
1640
+ Column: ColumnIdentifier;
1641
+ /**
1642
+ * @minItems 0
1643
+ * @maxItems 100000
1644
+ */
1645
+ CategoryValues: string[];
1646
+ }
1647
+ export interface ExplicitHierarchy {
1648
+ HierarchyId: string;
1649
+ /**
1650
+ * @minItems 0
1651
+ * @maxItems 10
1652
+ */
1653
+ DrillDownFilters?: DrillDownFilter[];
1654
+ /**
1655
+ * @minItems 2
1656
+ * @maxItems 10
1657
+ */
1658
+ Columns: ColumnIdentifier[];
1659
+ }
1660
+ export interface PredefinedHierarchy {
1661
+ HierarchyId: string;
1662
+ /**
1663
+ * @minItems 0
1664
+ * @maxItems 10
1665
+ */
1666
+ DrillDownFilters?: DrillDownFilter[];
1667
+ /**
1668
+ * @minItems 1
1669
+ * @maxItems 10
1670
+ */
1671
+ Columns: ColumnIdentifier[];
1672
+ }
1673
+ export interface BoxPlotVisual {
1674
+ Subtitle?: VisualSubtitleLabelOptions;
1675
+ VisualId: string;
1676
+ ChartConfiguration?: BoxPlotChartConfiguration;
1677
+ /**
1678
+ * @minItems 0
1679
+ * @maxItems 10
1680
+ */
1681
+ Actions?: VisualCustomAction[];
1682
+ Title?: VisualTitleLabelOptions;
1683
+ VisualContentAltText?: string;
1684
+ /**
1685
+ * @minItems 0
1686
+ * @maxItems 2
1687
+ */
1688
+ ColumnHierarchies?: ColumnHierarchy[];
1689
+ }
1690
+ export interface BoxPlotChartConfiguration {
1691
+ SortConfiguration?: BoxPlotSortConfiguration;
1692
+ Legend?: LegendOptions;
1693
+ /**
1694
+ * @minItems 0
1695
+ * @maxItems 20
1696
+ */
1697
+ ReferenceLines?: ReferenceLine[];
1698
+ CategoryAxis?: AxisDisplayOptions;
1699
+ PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
1700
+ CategoryLabelOptions?: ChartAxisLabelOptions;
1701
+ FieldWells?: BoxPlotFieldWells;
1702
+ Tooltip?: TooltipOptions;
1703
+ BoxPlotOptions?: BoxPlotOptions;
1704
+ PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
1705
+ VisualPalette?: VisualPalette;
1706
+ }
1707
+ export interface BoxPlotSortConfiguration {
1708
+ /**
1709
+ * @minItems 0
1710
+ * @maxItems 100
1711
+ */
1712
+ CategorySort?: FieldSortOptions[];
1713
+ PaginationConfiguration?: PaginationConfiguration;
1714
+ }
1715
+ export interface PaginationConfiguration {
1716
+ PageSize: number;
1717
+ PageNumber: number;
1718
+ }
1719
+ export interface LegendOptions {
1720
+ Position?: LegendPosition;
1721
+ ValueFontConfiguration?: FontConfiguration;
1722
+ Title?: LabelOptions;
1723
+ Visibility?: Visibility;
1724
+ /**
1725
+ * String based length that is composed of value and unit in px
1726
+ */
1727
+ Height?: string;
1728
+ /**
1729
+ * String based length that is composed of value and unit in px
1730
+ */
1731
+ Width?: string;
1732
+ }
1733
+ export interface ReferenceLine {
1734
+ Status?: WidgetStatus;
1735
+ DataConfiguration: ReferenceLineDataConfiguration;
1736
+ LabelConfiguration?: ReferenceLineLabelConfiguration;
1737
+ StyleConfiguration?: ReferenceLineStyleConfiguration;
1738
+ }
1739
+ export interface ReferenceLineDataConfiguration {
1740
+ DynamicConfiguration?: ReferenceLineDynamicDataConfiguration;
1741
+ AxisBinding?: AxisBinding;
1742
+ SeriesType?: ReferenceLineSeriesType;
1743
+ StaticConfiguration?: ReferenceLineStaticDataConfiguration;
1744
+ }
1745
+ export interface ReferenceLineDynamicDataConfiguration {
1746
+ Column: ColumnIdentifier;
1747
+ MeasureAggregationFunction?: AggregationFunction;
1748
+ Calculation: NumericalAggregationFunction;
1749
+ }
1750
+ export interface ReferenceLineStaticDataConfiguration {
1751
+ Value: number;
1752
+ }
1753
+ export interface ReferenceLineLabelConfiguration {
1754
+ HorizontalPosition?: ReferenceLineLabelHorizontalPosition;
1755
+ ValueLabelConfiguration?: ReferenceLineValueLabelConfiguration;
1756
+ CustomLabelConfiguration?: ReferenceLineCustomLabelConfiguration;
1757
+ FontColor?: string;
1758
+ FontConfiguration?: FontConfiguration;
1759
+ VerticalPosition?: ReferenceLineLabelVerticalPosition;
1760
+ }
1761
+ export interface ReferenceLineValueLabelConfiguration {
1762
+ FormatConfiguration?: NumericFormatConfiguration;
1763
+ RelativePosition?: ReferenceLineValueLabelRelativePosition;
1764
+ }
1765
+ export interface ReferenceLineCustomLabelConfiguration {
1766
+ CustomLabel: string;
1767
+ }
1768
+ export interface ReferenceLineStyleConfiguration {
1769
+ Pattern?: ReferenceLinePatternType;
1770
+ Color?: string;
1771
+ }
1772
+ export interface AxisDisplayOptions {
1773
+ DataOptions?: AxisDataOptions;
1774
+ TickLabelOptions?: AxisTickLabelOptions;
1775
+ /**
1776
+ * String based length that is composed of value and unit in px
1777
+ */
1778
+ AxisOffset?: string;
1779
+ AxisLineVisibility?: Visibility;
1780
+ GridLineVisibility?: Visibility;
1781
+ ScrollbarOptions?: ScrollBarOptions;
1782
+ }
1783
+ export interface AxisDataOptions {
1784
+ DateAxisOptions?: DateAxisOptions;
1785
+ NumericAxisOptions?: NumericAxisOptions;
1786
+ }
1787
+ export interface DateAxisOptions {
1788
+ MissingDateVisibility?: Visibility;
1789
+ }
1790
+ export interface NumericAxisOptions {
1791
+ Scale?: AxisScale;
1792
+ Range?: AxisDisplayRange;
1793
+ }
1794
+ export interface AxisScale {
1795
+ Logarithmic?: AxisLogarithmicScale;
1796
+ Linear?: AxisLinearScale;
1797
+ }
1798
+ export interface AxisLogarithmicScale {
1799
+ Base?: number;
1800
+ }
1801
+ export interface AxisLinearScale {
1802
+ StepSize?: number;
1803
+ StepCount?: number;
1804
+ }
1805
+ export interface AxisDisplayRange {
1806
+ DataDriven?: AxisDisplayDataDrivenRange;
1807
+ MinMax?: AxisDisplayMinMaxRange;
1808
+ }
1809
+ export interface AxisDisplayDataDrivenRange {
1810
+ }
1811
+ export interface AxisDisplayMinMaxRange {
1812
+ Minimum?: number;
1813
+ Maximum?: number;
1814
+ }
1815
+ export interface AxisTickLabelOptions {
1816
+ RotationAngle?: number;
1817
+ LabelOptions?: LabelOptions;
1818
+ }
1819
+ export interface ScrollBarOptions {
1820
+ VisibleRange?: VisibleRangeOptions;
1821
+ Visibility?: Visibility;
1822
+ }
1823
+ export interface VisibleRangeOptions {
1824
+ PercentRange?: PercentVisibleRange;
1825
+ }
1826
+ export interface PercentVisibleRange {
1827
+ From?: number;
1828
+ To?: number;
1829
+ }
1830
+ export interface BoxPlotFieldWells {
1831
+ BoxPlotAggregatedFieldWells?: BoxPlotAggregatedFieldWells;
1832
+ }
1833
+ export interface BoxPlotAggregatedFieldWells {
1834
+ /**
1835
+ * @minItems 0
1836
+ * @maxItems 1
1837
+ */
1838
+ GroupBy?: DimensionField[];
1839
+ /**
1840
+ * @minItems 0
1841
+ * @maxItems 5
1842
+ */
1843
+ Values?: MeasureField[];
1844
+ }
1845
+ export interface BoxPlotOptions {
1846
+ StyleOptions?: BoxPlotStyleOptions;
1847
+ OutlierVisibility?: Visibility;
1848
+ AllDataPointsVisibility?: Visibility;
1849
+ }
1850
+ export interface BoxPlotStyleOptions {
1851
+ FillStyle?: BoxPlotFillStyle;
1852
+ }
1853
+ export interface LayerMapVisual {
1854
+ Subtitle?: VisualSubtitleLabelOptions;
1855
+ VisualId: string;
1856
+ ChartConfiguration?: GeospatialLayerMapConfiguration;
1857
+ DataSetIdentifier: string;
1858
+ Title?: VisualTitleLabelOptions;
1859
+ VisualContentAltText?: string;
1860
+ }
1861
+ export interface GeospatialLayerMapConfiguration {
1862
+ Legend?: LegendOptions;
1863
+ MapState?: GeospatialMapState;
1864
+ MapStyle?: GeospatialMapStyle;
1865
+ Interactions?: unknown;
1866
+ MapLayers?: GeospatialLayerItem[];
1867
+ }
1868
+ export interface GeospatialMapState {
1869
+ Bounds?: GeospatialCoordinateBounds;
1870
+ MapNavigation?: GeospatialMapNavigation;
1871
+ }
1872
+ export interface GeospatialCoordinateBounds {
1873
+ West: number;
1874
+ South: number;
1875
+ North: number;
1876
+ East: number;
1877
+ }
1878
+ export interface GeospatialMapStyle {
1879
+ BaseMapStyle?: BaseMapStyleType;
1880
+ BaseMapVisibility?: Visibility;
1881
+ BackgroundColor?: string;
1882
+ }
1883
+ export interface GeospatialLayerItem {
1884
+ LayerId: string;
1885
+ JoinDefinition?: GeospatialLayerJoinDefinition;
1886
+ /**
1887
+ * @minItems 0
1888
+ * @maxItems 10
1889
+ */
1890
+ Actions?: LayerCustomAction[];
1891
+ LayerType?: GeospatialLayerType;
1892
+ LayerDefinition?: GeospatialLayerDefinition;
1893
+ Tooltip?: TooltipOptions;
1894
+ Label?: string;
1895
+ Visibility?: Visibility;
1896
+ DataSource?: GeospatialDataSourceItem;
1897
+ }
1898
+ export interface GeospatialLayerJoinDefinition {
1899
+ ColorField?: GeospatialLayerColorField;
1900
+ ShapeKeyField?: string;
1901
+ DatasetKeyField?: UnaggregatedField;
1902
+ }
1903
+ export interface GeospatialLayerColorField {
1904
+ /**
1905
+ * @minItems 0
1906
+ * @maxItems 1
1907
+ */
1908
+ ColorValuesFields?: MeasureField[];
1909
+ /**
1910
+ * @minItems 0
1911
+ * @maxItems 1
1912
+ */
1913
+ ColorDimensionsFields?: DimensionField[];
1914
+ }
1915
+ export interface UnaggregatedField {
1916
+ FormatConfiguration?: FormatConfiguration;
1917
+ Column: ColumnIdentifier;
1918
+ FieldId: string;
1919
+ }
1920
+ export interface LayerCustomAction {
1921
+ Status?: WidgetStatus;
1922
+ Trigger: LayerCustomActionTrigger;
1923
+ CustomActionId: string;
1924
+ Name: string;
1925
+ /**
1926
+ * @minItems 1
1927
+ * @maxItems 2
1928
+ */
1929
+ ActionOperations: LayerCustomActionOperation[];
1930
+ }
1931
+ export interface LayerCustomActionOperation {
1932
+ NavigationOperation?: CustomActionNavigationOperation;
1933
+ SetParametersOperation?: CustomActionSetParametersOperation;
1934
+ FilterOperation?: CustomActionFilterOperation;
1935
+ URLOperation?: CustomActionURLOperation;
1936
+ }
1937
+ export interface GeospatialLayerDefinition {
1938
+ PointLayer?: GeospatialPointLayer;
1939
+ PolygonLayer?: GeospatialPolygonLayer;
1940
+ LineLayer?: GeospatialLineLayer;
1941
+ }
1942
+ export interface GeospatialPointLayer {
1943
+ Style: GeospatialPointStyle;
1944
+ }
1945
+ export interface GeospatialPointStyle {
1946
+ CircleSymbolStyle?: GeospatialCircleSymbolStyle;
1947
+ }
1948
+ export interface GeospatialCircleSymbolStyle {
1949
+ FillColor?: GeospatialColor;
1950
+ StrokeWidth?: GeospatialLineWidth;
1951
+ StrokeColor?: GeospatialColor;
1952
+ CircleRadius?: GeospatialCircleRadius;
1953
+ }
1954
+ export interface GeospatialColor {
1955
+ Gradient?: GeospatialGradientColor;
1956
+ Categorical?: GeospatialCategoricalColor;
1957
+ Solid?: GeospatialSolidColor;
1958
+ }
1959
+ export interface GeospatialGradientColor {
1960
+ DefaultOpacity?: number;
1961
+ /**
1962
+ * @minItems 2
1963
+ * @maxItems 3
1964
+ */
1965
+ StepColors: GeospatialGradientStepColor[];
1966
+ NullDataVisibility?: Visibility;
1967
+ NullDataSettings?: GeospatialNullDataSettings;
1968
+ }
1969
+ export interface GeospatialGradientStepColor {
1970
+ DataValue: number;
1971
+ Color: string;
1972
+ }
1973
+ export interface GeospatialNullDataSettings {
1974
+ SymbolStyle: GeospatialNullSymbolStyle;
1975
+ }
1976
+ export interface GeospatialNullSymbolStyle {
1977
+ FillColor?: string;
1978
+ StrokeWidth?: number;
1979
+ StrokeColor?: string;
1980
+ }
1981
+ export interface GeospatialCategoricalColor {
1982
+ CategoryDataColors: GeospatialCategoricalDataColor[];
1983
+ DefaultOpacity?: number;
1984
+ NullDataVisibility?: Visibility;
1985
+ NullDataSettings?: GeospatialNullDataSettings;
1986
+ }
1987
+ export interface GeospatialCategoricalDataColor {
1988
+ DataValue: string;
1989
+ Color: string;
1990
+ }
1991
+ /**
1992
+ * Describes the properties for a solid color
1993
+ */
1994
+ export interface GeospatialSolidColor {
1995
+ State?: GeospatialColorState;
1996
+ Color: string;
1997
+ }
1998
+ export interface GeospatialLineWidth {
1999
+ LineWidth?: number;
2000
+ }
2001
+ export interface GeospatialCircleRadius {
2002
+ Radius?: number;
2003
+ }
2004
+ export interface GeospatialPolygonLayer {
2005
+ Style: GeospatialPolygonStyle;
2006
+ }
2007
+ export interface GeospatialPolygonStyle {
2008
+ PolygonSymbolStyle?: GeospatialPolygonSymbolStyle;
2009
+ }
2010
+ export interface GeospatialPolygonSymbolStyle {
2011
+ FillColor?: GeospatialColor;
2012
+ StrokeWidth?: GeospatialLineWidth;
2013
+ StrokeColor?: GeospatialColor;
2014
+ }
2015
+ export interface GeospatialLineLayer {
2016
+ Style: GeospatialLineStyle;
2017
+ }
2018
+ export interface GeospatialLineStyle {
2019
+ LineSymbolStyle?: GeospatialLineSymbolStyle;
2020
+ }
2021
+ export interface GeospatialLineSymbolStyle {
2022
+ FillColor?: GeospatialColor;
2023
+ LineWidth?: GeospatialLineWidth;
2024
+ }
2025
+ export interface GeospatialDataSourceItem {
2026
+ StaticFileDataSource?: GeospatialStaticFileSource;
2027
+ }
2028
+ export interface GeospatialStaticFileSource {
2029
+ StaticFileId: string;
2030
+ }
2031
+ export interface GeospatialMapVisual {
2032
+ Subtitle?: VisualSubtitleLabelOptions;
2033
+ VisualId: string;
2034
+ ChartConfiguration?: GeospatialMapConfiguration;
2035
+ /**
2036
+ * @minItems 0
2037
+ * @maxItems 10
2038
+ */
2039
+ Actions?: VisualCustomAction[];
2040
+ Title?: VisualTitleLabelOptions;
2041
+ VisualContentAltText?: string;
2042
+ /**
2043
+ * @minItems 0
2044
+ * @maxItems 2
2045
+ */
2046
+ ColumnHierarchies?: ColumnHierarchy[];
2047
+ }
2048
+ export interface GeospatialMapConfiguration {
2049
+ Legend?: LegendOptions;
2050
+ MapStyleOptions?: GeospatialMapStyleOptions;
2051
+ FieldWells?: GeospatialMapFieldWells;
2052
+ Tooltip?: TooltipOptions;
2053
+ Interactions?: unknown;
2054
+ WindowOptions?: GeospatialWindowOptions;
2055
+ PointStyleOptions?: GeospatialPointStyleOptions;
2056
+ VisualPalette?: VisualPalette;
2057
+ }
2058
+ export interface GeospatialMapStyleOptions {
2059
+ BaseMapStyle?: BaseMapStyleType;
2060
+ }
2061
+ export interface GeospatialMapFieldWells {
2062
+ GeospatialMapAggregatedFieldWells?: GeospatialMapAggregatedFieldWells;
2063
+ }
2064
+ export interface GeospatialMapAggregatedFieldWells {
2065
+ /**
2066
+ * @minItems 0
2067
+ * @maxItems 200
2068
+ */
2069
+ Colors?: DimensionField[];
2070
+ /**
2071
+ * @minItems 0
2072
+ * @maxItems 200
2073
+ */
2074
+ Values?: MeasureField[];
2075
+ /**
2076
+ * @minItems 0
2077
+ * @maxItems 200
2078
+ */
2079
+ Geospatial?: DimensionField[];
2080
+ }
2081
+ export interface GeospatialWindowOptions {
2082
+ Bounds?: GeospatialCoordinateBounds;
2083
+ MapZoomMode?: MapZoomMode;
2084
+ }
2085
+ export interface GeospatialPointStyleOptions {
2086
+ SelectedPointStyle?: GeospatialSelectedPointStyle;
2087
+ ClusterMarkerConfiguration?: ClusterMarkerConfiguration;
2088
+ HeatmapConfiguration?: GeospatialHeatmapConfiguration;
2089
+ }
2090
+ export interface ClusterMarkerConfiguration {
2091
+ ClusterMarker?: ClusterMarker;
2092
+ }
2093
+ export interface ClusterMarker {
2094
+ SimpleClusterMarker?: SimpleClusterMarker;
2095
+ }
2096
+ export interface SimpleClusterMarker {
2097
+ Color?: string;
2098
+ }
2099
+ export interface GeospatialHeatmapConfiguration {
2100
+ HeatmapColor?: GeospatialHeatmapColorScale;
2101
+ }
2102
+ export interface GeospatialHeatmapColorScale {
2103
+ /**
2104
+ * @minItems 2
2105
+ * @maxItems 2
2106
+ */
2107
+ Colors?: GeospatialHeatmapDataColor[];
2108
+ }
2109
+ export interface GeospatialHeatmapDataColor {
2110
+ Color: string;
2111
+ }
2112
+ export interface ScatterPlotVisual {
2113
+ Subtitle?: VisualSubtitleLabelOptions;
2114
+ VisualId: string;
2115
+ ChartConfiguration?: ScatterPlotConfiguration;
2116
+ /**
2117
+ * @minItems 0
2118
+ * @maxItems 10
2119
+ */
2120
+ Actions?: VisualCustomAction[];
2121
+ Title?: VisualTitleLabelOptions;
2122
+ VisualContentAltText?: string;
2123
+ /**
2124
+ * @minItems 0
2125
+ * @maxItems 2
2126
+ */
2127
+ ColumnHierarchies?: ColumnHierarchy[];
2128
+ }
2129
+ export interface ScatterPlotConfiguration {
2130
+ YAxisLabelOptions?: ChartAxisLabelOptions;
2131
+ Legend?: LegendOptions;
2132
+ YAxisDisplayOptions?: AxisDisplayOptions;
2133
+ DataLabels?: DataLabelOptions;
2134
+ FieldWells?: ScatterPlotFieldWells;
2135
+ Tooltip?: TooltipOptions;
2136
+ XAxisLabelOptions?: ChartAxisLabelOptions;
2137
+ VisualPalette?: VisualPalette;
2138
+ XAxisDisplayOptions?: AxisDisplayOptions;
2139
+ }
2140
+ export interface DataLabelOptions {
2141
+ /**
2142
+ * @minItems 0
2143
+ * @maxItems 100
2144
+ */
2145
+ DataLabelTypes?: DataLabelType[];
2146
+ MeasureLabelVisibility?: Visibility;
2147
+ Position?: DataLabelPosition;
2148
+ LabelContent?: DataLabelContent;
2149
+ Visibility?: Visibility;
2150
+ TotalsVisibility?: Visibility;
2151
+ Overlap?: DataLabelOverlap;
2152
+ CategoryLabelVisibility?: Visibility;
2153
+ LabelColor?: string;
2154
+ LabelFontConfiguration?: FontConfiguration;
2155
+ }
2156
+ export interface DataLabelType {
2157
+ MaximumLabelType?: MaximumLabelType;
2158
+ DataPathLabelType?: DataPathLabelType;
2159
+ RangeEndsLabelType?: RangeEndsLabelType;
2160
+ FieldLabelType?: FieldLabelType;
2161
+ MinimumLabelType?: MinimumLabelType;
2162
+ }
2163
+ export interface MaximumLabelType {
2164
+ Visibility?: Visibility;
2165
+ }
2166
+ export interface DataPathLabelType {
2167
+ FieldId?: string;
2168
+ Visibility?: Visibility;
2169
+ FieldValue?: string;
2170
+ }
2171
+ export interface RangeEndsLabelType {
2172
+ Visibility?: Visibility;
2173
+ }
2174
+ export interface FieldLabelType {
2175
+ FieldId?: string;
2176
+ Visibility?: Visibility;
2177
+ }
2178
+ export interface MinimumLabelType {
2179
+ Visibility?: Visibility;
2180
+ }
2181
+ export interface ScatterPlotFieldWells {
2182
+ ScatterPlotUnaggregatedFieldWells?: ScatterPlotUnaggregatedFieldWells;
2183
+ ScatterPlotCategoricallyAggregatedFieldWells?: ScatterPlotCategoricallyAggregatedFieldWells;
2184
+ }
2185
+ export interface ScatterPlotUnaggregatedFieldWells {
2186
+ /**
2187
+ * @minItems 0
2188
+ * @maxItems 200
2189
+ */
2190
+ Category?: DimensionField[];
2191
+ /**
2192
+ * @minItems 0
2193
+ * @maxItems 200
2194
+ */
2195
+ Size?: MeasureField[];
2196
+ /**
2197
+ * @minItems 0
2198
+ * @maxItems 200
2199
+ */
2200
+ Label?: DimensionField[];
2201
+ /**
2202
+ * @minItems 0
2203
+ * @maxItems 200
2204
+ */
2205
+ XAxis?: DimensionField[];
2206
+ /**
2207
+ * @minItems 0
2208
+ * @maxItems 200
2209
+ */
2210
+ YAxis?: DimensionField[];
2211
+ }
2212
+ export interface ScatterPlotCategoricallyAggregatedFieldWells {
2213
+ /**
2214
+ * @minItems 0
2215
+ * @maxItems 200
2216
+ */
2217
+ Category?: DimensionField[];
2218
+ /**
2219
+ * @minItems 0
2220
+ * @maxItems 200
2221
+ */
2222
+ Size?: MeasureField[];
2223
+ /**
2224
+ * @minItems 0
2225
+ * @maxItems 200
2226
+ */
2227
+ Label?: DimensionField[];
2228
+ /**
2229
+ * @minItems 0
2230
+ * @maxItems 200
2231
+ */
2232
+ XAxis?: MeasureField[];
2233
+ /**
2234
+ * @minItems 0
2235
+ * @maxItems 200
2236
+ */
2237
+ YAxis?: MeasureField[];
2238
+ }
2239
+ export interface RadarChartVisual {
2240
+ Subtitle?: VisualSubtitleLabelOptions;
2241
+ VisualId: string;
2242
+ ChartConfiguration?: RadarChartConfiguration;
2243
+ /**
2244
+ * @minItems 0
2245
+ * @maxItems 10
2246
+ */
2247
+ Actions?: VisualCustomAction[];
2248
+ Title?: VisualTitleLabelOptions;
2249
+ VisualContentAltText?: string;
2250
+ /**
2251
+ * @minItems 0
2252
+ * @maxItems 2
2253
+ */
2254
+ ColumnHierarchies?: ColumnHierarchy[];
2255
+ }
2256
+ export interface RadarChartConfiguration {
2257
+ SortConfiguration?: RadarChartSortConfiguration;
2258
+ Legend?: LegendOptions;
2259
+ Shape?: RadarChartShape;
2260
+ BaseSeriesSettings?: RadarChartSeriesSettings;
2261
+ ColorLabelOptions?: ChartAxisLabelOptions;
2262
+ CategoryLabelOptions?: ChartAxisLabelOptions;
2263
+ AxesRangeScale?: RadarChartAxesRangeScale;
2264
+ VisualPalette?: VisualPalette;
2265
+ AlternateBandColorsVisibility?: Visibility;
2266
+ StartAngle?: number;
2267
+ CategoryAxis?: AxisDisplayOptions;
2268
+ FieldWells?: RadarChartFieldWells;
2269
+ ColorAxis?: AxisDisplayOptions;
2270
+ AlternateBandOddColor?: string;
2271
+ AlternateBandEvenColor?: string;
2272
+ }
2273
+ export interface RadarChartSortConfiguration {
2274
+ /**
2275
+ * @minItems 0
2276
+ * @maxItems 100
2277
+ */
2278
+ ColorSort?: FieldSortOptions[];
2279
+ ColorItemsLimit?: ItemsLimitConfiguration;
2280
+ CategoryItemsLimit?: ItemsLimitConfiguration;
2281
+ /**
2282
+ * @minItems 0
2283
+ * @maxItems 100
2284
+ */
2285
+ CategorySort?: FieldSortOptions[];
2286
+ }
2287
+ export interface RadarChartSeriesSettings {
2288
+ AreaStyleSettings?: RadarChartAreaStyleSettings;
2289
+ }
2290
+ export interface RadarChartAreaStyleSettings {
2291
+ Visibility?: Visibility;
2292
+ }
2293
+ export interface RadarChartFieldWells {
2294
+ RadarChartAggregatedFieldWells?: RadarChartAggregatedFieldWells;
2295
+ }
2296
+ export interface RadarChartAggregatedFieldWells {
2297
+ /**
2298
+ * @minItems 0
2299
+ * @maxItems 1
2300
+ */
2301
+ Category?: DimensionField[];
2302
+ /**
2303
+ * @minItems 0
2304
+ * @maxItems 1
2305
+ */
2306
+ Color?: DimensionField[];
2307
+ /**
2308
+ * @minItems 0
2309
+ * @maxItems 20
2310
+ */
2311
+ Values?: MeasureField[];
2312
+ }
2313
+ export interface ComboChartVisual {
2314
+ Subtitle?: VisualSubtitleLabelOptions;
2315
+ VisualId: string;
2316
+ ChartConfiguration?: ComboChartConfiguration;
2317
+ /**
2318
+ * @minItems 0
2319
+ * @maxItems 10
2320
+ */
2321
+ Actions?: VisualCustomAction[];
2322
+ Title?: VisualTitleLabelOptions;
2323
+ VisualContentAltText?: string;
2324
+ /**
2325
+ * @minItems 0
2326
+ * @maxItems 2
2327
+ */
2328
+ ColumnHierarchies?: ColumnHierarchy[];
2329
+ }
2330
+ export interface ComboChartConfiguration {
2331
+ SortConfiguration?: ComboChartSortConfiguration;
2332
+ Legend?: LegendOptions;
2333
+ /**
2334
+ * @minItems 0
2335
+ * @maxItems 20
2336
+ */
2337
+ ReferenceLines?: ReferenceLine[];
2338
+ ColorLabelOptions?: ChartAxisLabelOptions;
2339
+ BarDataLabels?: DataLabelOptions;
2340
+ CategoryLabelOptions?: ChartAxisLabelOptions;
2341
+ Tooltip?: TooltipOptions;
2342
+ SingleAxisOptions?: SingleAxisOptions;
2343
+ PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
2344
+ VisualPalette?: VisualPalette;
2345
+ BarsArrangement?: BarsArrangement;
2346
+ SecondaryYAxisLabelOptions?: ChartAxisLabelOptions;
2347
+ LineDataLabels?: DataLabelOptions;
2348
+ CategoryAxis?: AxisDisplayOptions;
2349
+ PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
2350
+ FieldWells?: ComboChartFieldWells;
2351
+ SecondaryYAxisDisplayOptions?: AxisDisplayOptions;
2352
+ }
2353
+ export interface ComboChartSortConfiguration {
2354
+ /**
2355
+ * @minItems 0
2356
+ * @maxItems 100
2357
+ */
2358
+ ColorSort?: FieldSortOptions[];
2359
+ ColorItemsLimit?: ItemsLimitConfiguration;
2360
+ CategoryItemsLimit?: ItemsLimitConfiguration;
2361
+ /**
2362
+ * @minItems 0
2363
+ * @maxItems 100
2364
+ */
2365
+ CategorySort?: FieldSortOptions[];
2366
+ }
2367
+ export interface SingleAxisOptions {
2368
+ YAxisOptions?: YAxisOptions;
2369
+ }
2370
+ export interface YAxisOptions {
2371
+ YAxis: SingleYAxisOption;
2372
+ }
2373
+ export interface ComboChartFieldWells {
2374
+ ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells;
2375
+ }
2376
+ export interface ComboChartAggregatedFieldWells {
2377
+ /**
2378
+ * @minItems 0
2379
+ * @maxItems 200
2380
+ */
2381
+ BarValues?: MeasureField[];
2382
+ /**
2383
+ * @minItems 0
2384
+ * @maxItems 200
2385
+ */
2386
+ Category?: DimensionField[];
2387
+ /**
2388
+ * @minItems 0
2389
+ * @maxItems 200
2390
+ */
2391
+ Colors?: DimensionField[];
2392
+ /**
2393
+ * @minItems 0
2394
+ * @maxItems 200
2395
+ */
2396
+ LineValues?: MeasureField[];
2397
+ }
2398
+ export interface WordCloudVisual {
2399
+ Subtitle?: VisualSubtitleLabelOptions;
2400
+ VisualId: string;
2401
+ ChartConfiguration?: WordCloudChartConfiguration;
2402
+ /**
2403
+ * @minItems 0
2404
+ * @maxItems 10
2405
+ */
2406
+ Actions?: VisualCustomAction[];
2407
+ Title?: VisualTitleLabelOptions;
2408
+ VisualContentAltText?: string;
2409
+ /**
2410
+ * @minItems 0
2411
+ * @maxItems 2
2412
+ */
2413
+ ColumnHierarchies?: ColumnHierarchy[];
2414
+ }
2415
+ export interface WordCloudChartConfiguration {
2416
+ SortConfiguration?: WordCloudSortConfiguration;
2417
+ CategoryLabelOptions?: ChartAxisLabelOptions;
2418
+ FieldWells?: WordCloudFieldWells;
2419
+ WordCloudOptions?: WordCloudOptions;
2420
+ }
2421
+ export interface WordCloudSortConfiguration {
2422
+ CategoryItemsLimit?: ItemsLimitConfiguration;
2423
+ /**
2424
+ * @minItems 0
2425
+ * @maxItems 100
2426
+ */
2427
+ CategorySort?: FieldSortOptions[];
2428
+ }
2429
+ export interface WordCloudFieldWells {
2430
+ WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells;
2431
+ }
2432
+ export interface WordCloudAggregatedFieldWells {
2433
+ /**
2434
+ * @minItems 0
2435
+ * @maxItems 10
2436
+ */
2437
+ GroupBy?: DimensionField[];
2438
+ /**
2439
+ * @minItems 0
2440
+ * @maxItems 1
2441
+ */
2442
+ Size?: MeasureField[];
2443
+ }
2444
+ export interface WordCloudOptions {
2445
+ WordOrientation?: WordCloudWordOrientation;
2446
+ WordScaling?: WordCloudWordScaling;
2447
+ CloudLayout?: WordCloudCloudLayout;
2448
+ MaximumStringLength?: number;
2449
+ WordCasing?: WordCloudWordCasing;
2450
+ WordPadding?: WordCloudWordPadding;
2451
+ }
2452
+ export interface SankeyDiagramVisual {
2453
+ Subtitle?: VisualSubtitleLabelOptions;
2454
+ VisualId: string;
2455
+ ChartConfiguration?: SankeyDiagramChartConfiguration;
2456
+ /**
2457
+ * @minItems 0
2458
+ * @maxItems 10
2459
+ */
2460
+ Actions?: VisualCustomAction[];
2461
+ Title?: VisualTitleLabelOptions;
2462
+ VisualContentAltText?: string;
2463
+ }
2464
+ export interface SankeyDiagramChartConfiguration {
2465
+ SortConfiguration?: SankeyDiagramSortConfiguration;
2466
+ DataLabels?: DataLabelOptions;
2467
+ FieldWells?: SankeyDiagramFieldWells;
2468
+ }
2469
+ export interface SankeyDiagramSortConfiguration {
2470
+ /**
2471
+ * @minItems 0
2472
+ * @maxItems 100
2473
+ */
2474
+ WeightSort?: FieldSortOptions[];
2475
+ SourceItemsLimit?: ItemsLimitConfiguration;
2476
+ DestinationItemsLimit?: ItemsLimitConfiguration;
2477
+ }
2478
+ export interface SankeyDiagramFieldWells {
2479
+ SankeyDiagramAggregatedFieldWells?: SankeyDiagramAggregatedFieldWells;
2480
+ }
2481
+ export interface SankeyDiagramAggregatedFieldWells {
2482
+ /**
2483
+ * @minItems 0
2484
+ * @maxItems 200
2485
+ */
2486
+ Destination?: DimensionField[];
2487
+ /**
2488
+ * @minItems 0
2489
+ * @maxItems 200
2490
+ */
2491
+ Source?: DimensionField[];
2492
+ /**
2493
+ * @minItems 0
2494
+ * @maxItems 200
2495
+ */
2496
+ Weight?: MeasureField[];
2497
+ }
2498
+ export interface GaugeChartVisual {
2499
+ Subtitle?: VisualSubtitleLabelOptions;
2500
+ ConditionalFormatting?: GaugeChartConditionalFormatting;
2501
+ VisualId: string;
2502
+ ChartConfiguration?: GaugeChartConfiguration;
2503
+ /**
2504
+ * @minItems 0
2505
+ * @maxItems 10
2506
+ */
2507
+ Actions?: VisualCustomAction[];
2508
+ Title?: VisualTitleLabelOptions;
2509
+ VisualContentAltText?: string;
2510
+ }
2511
+ export interface GaugeChartConditionalFormatting {
2512
+ /**
2513
+ * @minItems 0
2514
+ * @maxItems 100
2515
+ */
2516
+ ConditionalFormattingOptions?: GaugeChartConditionalFormattingOption[];
2517
+ }
2518
+ export interface GaugeChartConditionalFormattingOption {
2519
+ Arc?: GaugeChartArcConditionalFormatting;
2520
+ PrimaryValue?: GaugeChartPrimaryValueConditionalFormatting;
2521
+ }
2522
+ export interface GaugeChartArcConditionalFormatting {
2523
+ ForegroundColor?: ConditionalFormattingColor;
2524
+ }
2525
+ export interface ConditionalFormattingColor {
2526
+ Gradient?: ConditionalFormattingGradientColor;
2527
+ Solid?: ConditionalFormattingSolidColor;
2528
+ }
2529
+ export interface ConditionalFormattingGradientColor {
2530
+ Expression: string;
2531
+ Color: GradientColor;
2532
+ }
2533
+ export interface GradientColor {
2534
+ /**
2535
+ * @minItems 0
2536
+ * @maxItems 100
2537
+ */
2538
+ Stops?: GradientStop[];
2539
+ }
2540
+ export interface GradientStop {
2541
+ GradientOffset: number;
2542
+ DataValue?: number;
2543
+ Color?: string;
2544
+ }
2545
+ export interface ConditionalFormattingSolidColor {
2546
+ Expression: string;
2547
+ Color?: string;
2548
+ }
2549
+ export interface GaugeChartPrimaryValueConditionalFormatting {
2550
+ TextColor?: ConditionalFormattingColor;
2551
+ Icon?: ConditionalFormattingIcon;
2552
+ }
2553
+ export interface ConditionalFormattingIcon {
2554
+ CustomCondition?: ConditionalFormattingCustomIconCondition;
2555
+ IconSet?: ConditionalFormattingIconSet;
2556
+ }
2557
+ export interface ConditionalFormattingCustomIconCondition {
2558
+ Expression: string;
2559
+ Color?: string;
2560
+ DisplayConfiguration?: ConditionalFormattingIconDisplayConfiguration;
2561
+ IconOptions: ConditionalFormattingCustomIconOptions;
2562
+ }
2563
+ export interface ConditionalFormattingIconDisplayConfiguration {
2564
+ IconDisplayOption?: ConditionalFormattingIconDisplayOption;
2565
+ }
2566
+ export interface ConditionalFormattingCustomIconOptions {
2567
+ UnicodeIcon?: string;
2568
+ Icon?: Icon;
2569
+ }
2570
+ export interface ConditionalFormattingIconSet {
2571
+ Expression: string;
2572
+ IconSetType?: ConditionalFormattingIconSetType;
2573
+ }
2574
+ export interface GaugeChartConfiguration {
2575
+ DataLabels?: DataLabelOptions;
2576
+ FieldWells?: GaugeChartFieldWells;
2577
+ TooltipOptions?: TooltipOptions;
2578
+ GaugeChartOptions?: GaugeChartOptions;
2579
+ VisualPalette?: VisualPalette;
2580
+ }
2581
+ export interface GaugeChartFieldWells {
2582
+ /**
2583
+ * @minItems 0
2584
+ * @maxItems 200
2585
+ */
2586
+ TargetValues?: MeasureField[];
2587
+ /**
2588
+ * @minItems 0
2589
+ * @maxItems 200
2590
+ */
2591
+ Values?: MeasureField[];
2592
+ }
2593
+ export interface GaugeChartOptions {
2594
+ Arc?: ArcConfiguration;
2595
+ Comparison?: ComparisonConfiguration;
2596
+ PrimaryValueDisplayType?: PrimaryValueDisplayType;
2597
+ ArcAxis?: ArcAxisConfiguration;
2598
+ PrimaryValueFontConfiguration?: FontConfiguration;
2599
+ }
2600
+ export interface ArcConfiguration {
2601
+ ArcAngle?: number;
2602
+ ArcThickness?: ArcThicknessOptions;
2603
+ }
2604
+ export interface ComparisonConfiguration {
2605
+ ComparisonMethod?: ComparisonMethod;
2606
+ ComparisonFormat?: ComparisonFormatConfiguration;
2607
+ }
2608
+ export interface ComparisonFormatConfiguration {
2609
+ NumberDisplayFormatConfiguration?: NumberDisplayFormatConfiguration;
2610
+ PercentageDisplayFormatConfiguration?: PercentageDisplayFormatConfiguration;
2611
+ }
2612
+ export interface ArcAxisConfiguration {
2613
+ Range?: ArcAxisDisplayRange;
2614
+ ReserveRange?: number;
2615
+ }
2616
+ export interface ArcAxisDisplayRange {
2617
+ Min?: number;
2618
+ Max?: number;
2619
+ }
2620
+ export interface FilledMapVisual {
2621
+ Subtitle?: VisualSubtitleLabelOptions;
2622
+ ConditionalFormatting?: FilledMapConditionalFormatting;
2623
+ VisualId: string;
2624
+ ChartConfiguration?: FilledMapConfiguration;
2625
+ /**
2626
+ * @minItems 0
2627
+ * @maxItems 10
2628
+ */
2629
+ Actions?: VisualCustomAction[];
2630
+ Title?: VisualTitleLabelOptions;
2631
+ VisualContentAltText?: string;
2632
+ /**
2633
+ * @minItems 0
2634
+ * @maxItems 2
2635
+ */
2636
+ ColumnHierarchies?: ColumnHierarchy[];
2637
+ }
2638
+ export interface FilledMapConditionalFormatting {
2639
+ /**
2640
+ * @minItems 0
2641
+ * @maxItems 200
2642
+ */
2643
+ ConditionalFormattingOptions: FilledMapConditionalFormattingOption[];
2644
+ }
2645
+ export interface FilledMapConditionalFormattingOption {
2646
+ Shape: FilledMapShapeConditionalFormatting;
2647
+ }
2648
+ export interface FilledMapShapeConditionalFormatting {
2649
+ Format?: ShapeConditionalFormat;
2650
+ FieldId: string;
2651
+ }
2652
+ export interface ShapeConditionalFormat {
2653
+ BackgroundColor: ConditionalFormattingColor;
2654
+ }
2655
+ export interface FilledMapConfiguration {
2656
+ SortConfiguration?: FilledMapSortConfiguration;
2657
+ Legend?: LegendOptions;
2658
+ MapStyleOptions?: GeospatialMapStyleOptions;
2659
+ FieldWells?: FilledMapFieldWells;
2660
+ Tooltip?: TooltipOptions;
2661
+ WindowOptions?: GeospatialWindowOptions;
2662
+ }
2663
+ export interface FilledMapSortConfiguration {
2664
+ /**
2665
+ * @minItems 0
2666
+ * @maxItems 100
2667
+ */
2668
+ CategorySort?: FieldSortOptions[];
2669
+ }
2670
+ export interface FilledMapFieldWells {
2671
+ FilledMapAggregatedFieldWells?: FilledMapAggregatedFieldWells;
2672
+ }
2673
+ export interface FilledMapAggregatedFieldWells {
2674
+ /**
2675
+ * @minItems 0
2676
+ * @maxItems 1
2677
+ */
2678
+ Values?: MeasureField[];
2679
+ /**
2680
+ * @minItems 0
2681
+ * @maxItems 1
2682
+ */
2683
+ Geospatial?: DimensionField[];
2684
+ }
2685
+ export interface WaterfallVisual {
2686
+ Subtitle?: VisualSubtitleLabelOptions;
2687
+ VisualId: string;
2688
+ ChartConfiguration?: WaterfallChartConfiguration;
2689
+ /**
2690
+ * @minItems 0
2691
+ * @maxItems 10
2692
+ */
2693
+ Actions?: VisualCustomAction[];
2694
+ Title?: VisualTitleLabelOptions;
2695
+ VisualContentAltText?: string;
2696
+ /**
2697
+ * @minItems 0
2698
+ * @maxItems 2
2699
+ */
2700
+ ColumnHierarchies?: ColumnHierarchy[];
2701
+ }
2702
+ export interface WaterfallChartConfiguration {
2703
+ CategoryAxisLabelOptions?: ChartAxisLabelOptions;
2704
+ SortConfiguration?: WaterfallChartSortConfiguration;
2705
+ Legend?: LegendOptions;
2706
+ DataLabels?: DataLabelOptions;
2707
+ PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
2708
+ FieldWells?: WaterfallChartFieldWells;
2709
+ WaterfallChartOptions?: WaterfallChartOptions;
2710
+ ColorConfiguration?: WaterfallChartColorConfiguration;
2711
+ CategoryAxisDisplayOptions?: AxisDisplayOptions;
2712
+ PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
2713
+ VisualPalette?: VisualPalette;
2714
+ }
2715
+ export interface WaterfallChartSortConfiguration {
2716
+ BreakdownItemsLimit?: ItemsLimitConfiguration;
2717
+ /**
2718
+ * @minItems 0
2719
+ * @maxItems 100
2720
+ */
2721
+ CategorySort?: FieldSortOptions[];
2722
+ }
2723
+ export interface WaterfallChartFieldWells {
2724
+ WaterfallChartAggregatedFieldWells?: WaterfallChartAggregatedFieldWells;
2725
+ }
2726
+ export interface WaterfallChartAggregatedFieldWells {
2727
+ /**
2728
+ * @minItems 0
2729
+ * @maxItems 200
2730
+ */
2731
+ Categories?: DimensionField[];
2732
+ /**
2733
+ * @minItems 0
2734
+ * @maxItems 200
2735
+ */
2736
+ Breakdowns?: DimensionField[];
2737
+ /**
2738
+ * @minItems 0
2739
+ * @maxItems 200
2740
+ */
2741
+ Values?: MeasureField[];
2742
+ }
2743
+ export interface WaterfallChartOptions {
2744
+ TotalBarLabel?: string;
2745
+ }
2746
+ export interface WaterfallChartColorConfiguration {
2747
+ GroupColorConfiguration?: WaterfallChartGroupColorConfiguration;
2748
+ }
2749
+ export interface WaterfallChartGroupColorConfiguration {
2750
+ NegativeBarColor?: string;
2751
+ TotalBarColor?: string;
2752
+ PositiveBarColor?: string;
2753
+ }
2754
+ export interface CustomContentVisual {
2755
+ Subtitle?: VisualSubtitleLabelOptions;
2756
+ VisualId: string;
2757
+ ChartConfiguration?: CustomContentConfiguration;
2758
+ /**
2759
+ * @minItems 0
2760
+ * @maxItems 10
2761
+ */
2762
+ Actions?: VisualCustomAction[];
2763
+ DataSetIdentifier: string;
2764
+ Title?: VisualTitleLabelOptions;
2765
+ VisualContentAltText?: string;
2766
+ }
2767
+ export interface CustomContentConfiguration {
2768
+ ContentUrl?: string;
2769
+ ContentType?: CustomContentType;
2770
+ ImageScaling?: CustomContentImageScalingConfiguration;
2771
+ }
2772
+ export interface PieChartVisual {
2773
+ Subtitle?: VisualSubtitleLabelOptions;
2774
+ VisualId: string;
2775
+ ChartConfiguration?: PieChartConfiguration;
2776
+ /**
2777
+ * @minItems 0
2778
+ * @maxItems 10
2779
+ */
2780
+ Actions?: VisualCustomAction[];
2781
+ Title?: VisualTitleLabelOptions;
2782
+ VisualContentAltText?: string;
2783
+ /**
2784
+ * @minItems 0
2785
+ * @maxItems 2
2786
+ */
2787
+ ColumnHierarchies?: ColumnHierarchy[];
2788
+ }
2789
+ export interface PieChartConfiguration {
2790
+ SortConfiguration?: PieChartSortConfiguration;
2791
+ Legend?: LegendOptions;
2792
+ DataLabels?: DataLabelOptions;
2793
+ /**
2794
+ * @minItems 1
2795
+ * @maxItems 200
2796
+ */
2797
+ ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
2798
+ CategoryLabelOptions?: ChartAxisLabelOptions;
2799
+ FieldWells?: PieChartFieldWells;
2800
+ Tooltip?: TooltipOptions;
2801
+ DonutOptions?: DonutOptions;
2802
+ SmallMultiplesOptions?: SmallMultiplesOptions;
2803
+ ValueLabelOptions?: ChartAxisLabelOptions;
2804
+ VisualPalette?: VisualPalette;
2805
+ }
2806
+ export interface PieChartSortConfiguration {
2807
+ /**
2808
+ * @minItems 0
2809
+ * @maxItems 100
2810
+ */
2811
+ SmallMultiplesSort?: FieldSortOptions[];
2812
+ CategoryItemsLimit?: ItemsLimitConfiguration;
2813
+ /**
2814
+ * @minItems 0
2815
+ * @maxItems 100
2816
+ */
2817
+ CategorySort?: FieldSortOptions[];
2818
+ SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
2819
+ }
2820
+ export interface ContributionAnalysisDefault {
2821
+ MeasureFieldId: string;
2822
+ /**
2823
+ * @minItems 1
2824
+ * @maxItems 4
2825
+ */
2826
+ ContributorDimensions: ColumnIdentifier[];
2827
+ }
2828
+ export interface PieChartFieldWells {
2829
+ PieChartAggregatedFieldWells?: PieChartAggregatedFieldWells;
2830
+ }
2831
+ export interface PieChartAggregatedFieldWells {
2832
+ /**
2833
+ * @minItems 0
2834
+ * @maxItems 200
2835
+ */
2836
+ Category?: DimensionField[];
2837
+ /**
2838
+ * @minItems 0
2839
+ * @maxItems 200
2840
+ */
2841
+ Values?: MeasureField[];
2842
+ /**
2843
+ * @minItems 0
2844
+ * @maxItems 1
2845
+ */
2846
+ SmallMultiples?: DimensionField[];
2847
+ }
2848
+ export interface DonutOptions {
2849
+ DonutCenterOptions?: DonutCenterOptions;
2850
+ ArcOptions?: ArcOptions;
2851
+ }
2852
+ export interface DonutCenterOptions {
2853
+ LabelVisibility?: Visibility;
2854
+ }
2855
+ export interface ArcOptions {
2856
+ ArcThickness?: ArcThickness;
2857
+ }
2858
+ export interface SmallMultiplesOptions {
2859
+ MaxVisibleRows?: number;
2860
+ PanelConfiguration?: PanelConfiguration;
2861
+ MaxVisibleColumns?: number;
2862
+ XAxis?: SmallMultiplesAxisProperties;
2863
+ YAxis?: SmallMultiplesAxisProperties;
2864
+ }
2865
+ export interface PanelConfiguration {
2866
+ /**
2867
+ * String based length that is composed of value and unit in px
2868
+ */
2869
+ BorderThickness?: string;
2870
+ BorderStyle?: PanelBorderStyle;
2871
+ /**
2872
+ * String based length that is composed of value and unit in px
2873
+ */
2874
+ GutterSpacing?: string;
2875
+ BackgroundVisibility?: Visibility;
2876
+ BorderVisibility?: Visibility;
2877
+ BorderColor?: string;
2878
+ Title?: PanelTitleOptions;
2879
+ GutterVisibility?: Visibility;
2880
+ BackgroundColor?: string;
2881
+ }
2882
+ export interface PanelTitleOptions {
2883
+ Visibility?: Visibility;
2884
+ FontConfiguration?: FontConfiguration;
2885
+ HorizontalTextAlignment?: HorizontalTextAlignment;
2886
+ }
2887
+ export interface SmallMultiplesAxisProperties {
2888
+ Placement?: SmallMultiplesAxisPlacement;
2889
+ Scale?: SmallMultiplesAxisScale;
2890
+ }
2891
+ export interface KPIVisual {
2892
+ Subtitle?: VisualSubtitleLabelOptions;
2893
+ ConditionalFormatting?: KPIConditionalFormatting;
2894
+ VisualId: string;
2895
+ ChartConfiguration?: KPIConfiguration;
2896
+ /**
2897
+ * @minItems 0
2898
+ * @maxItems 10
2899
+ */
2900
+ Actions?: VisualCustomAction[];
2901
+ Title?: VisualTitleLabelOptions;
2902
+ VisualContentAltText?: string;
2903
+ /**
2904
+ * @minItems 0
2905
+ * @maxItems 2
2906
+ */
2907
+ ColumnHierarchies?: ColumnHierarchy[];
2908
+ }
2909
+ export interface KPIConditionalFormatting {
2910
+ /**
2911
+ * @minItems 0
2912
+ * @maxItems 100
2913
+ */
2914
+ ConditionalFormattingOptions?: KPIConditionalFormattingOption[];
2915
+ }
2916
+ export interface KPIConditionalFormattingOption {
2917
+ PrimaryValue?: KPIPrimaryValueConditionalFormatting;
2918
+ ActualValue?: KPIActualValueConditionalFormatting;
2919
+ ComparisonValue?: KPIComparisonValueConditionalFormatting;
2920
+ ProgressBar?: KPIProgressBarConditionalFormatting;
2921
+ }
2922
+ export interface KPIPrimaryValueConditionalFormatting {
2923
+ TextColor?: ConditionalFormattingColor;
2924
+ Icon?: ConditionalFormattingIcon;
2925
+ }
2926
+ export interface KPIActualValueConditionalFormatting {
2927
+ TextColor?: ConditionalFormattingColor;
2928
+ Icon?: ConditionalFormattingIcon;
2929
+ }
2930
+ export interface KPIComparisonValueConditionalFormatting {
2931
+ TextColor?: ConditionalFormattingColor;
2932
+ Icon?: ConditionalFormattingIcon;
2933
+ }
2934
+ export interface KPIProgressBarConditionalFormatting {
2935
+ ForegroundColor?: ConditionalFormattingColor;
2936
+ }
2937
+ export interface KPIConfiguration {
2938
+ SortConfiguration?: KPISortConfiguration;
2939
+ KPIOptions?: KPIOptions;
2940
+ FieldWells?: KPIFieldWells;
2941
+ }
2942
+ export interface KPISortConfiguration {
2943
+ /**
2944
+ * @minItems 0
2945
+ * @maxItems 100
2946
+ */
2947
+ TrendGroupSort?: FieldSortOptions[];
2948
+ }
2949
+ export interface KPIOptions {
2950
+ SecondaryValueFontConfiguration?: FontConfiguration;
2951
+ VisualLayoutOptions?: KPIVisualLayoutOptions;
2952
+ TrendArrows?: TrendArrowOptions;
2953
+ SecondaryValue?: SecondaryValueOptions;
2954
+ Comparison?: ComparisonConfiguration;
2955
+ PrimaryValueDisplayType?: PrimaryValueDisplayType;
2956
+ ProgressBar?: ProgressBarOptions;
2957
+ PrimaryValueFontConfiguration?: FontConfiguration;
2958
+ Sparkline?: KPISparklineOptions;
2959
+ }
2960
+ export interface KPIVisualLayoutOptions {
2961
+ StandardLayout?: KPIVisualStandardLayout;
2962
+ }
2963
+ export interface KPIVisualStandardLayout {
2964
+ Type: KPIVisualStandardLayoutType;
2965
+ }
2966
+ export interface TrendArrowOptions {
2967
+ Visibility?: Visibility;
2968
+ }
2969
+ export interface SecondaryValueOptions {
2970
+ Visibility?: Visibility;
2971
+ }
2972
+ export interface ProgressBarOptions {
2973
+ Visibility?: Visibility;
2974
+ }
2975
+ export interface KPISparklineOptions {
2976
+ Type: KPISparklineType;
2977
+ Color?: string;
2978
+ TooltipVisibility?: Visibility;
2979
+ Visibility?: Visibility;
2980
+ }
2981
+ export interface KPIFieldWells {
2982
+ /**
2983
+ * @minItems 0
2984
+ * @maxItems 200
2985
+ */
2986
+ TargetValues?: MeasureField[];
2987
+ /**
2988
+ * @minItems 0
2989
+ * @maxItems 200
2990
+ */
2991
+ TrendGroups?: DimensionField[];
2992
+ /**
2993
+ * @minItems 0
2994
+ * @maxItems 200
2995
+ */
2996
+ Values?: MeasureField[];
2997
+ }
2998
+ export interface HistogramVisual {
2999
+ Subtitle?: VisualSubtitleLabelOptions;
3000
+ VisualId: string;
3001
+ ChartConfiguration?: HistogramConfiguration;
3002
+ /**
3003
+ * @minItems 0
3004
+ * @maxItems 10
3005
+ */
3006
+ Actions?: VisualCustomAction[];
3007
+ Title?: VisualTitleLabelOptions;
3008
+ VisualContentAltText?: string;
3009
+ }
3010
+ export interface HistogramConfiguration {
3011
+ YAxisDisplayOptions?: AxisDisplayOptions;
3012
+ DataLabels?: DataLabelOptions;
3013
+ BinOptions?: HistogramBinOptions;
3014
+ FieldWells?: HistogramFieldWells;
3015
+ Tooltip?: TooltipOptions;
3016
+ XAxisLabelOptions?: ChartAxisLabelOptions;
3017
+ VisualPalette?: VisualPalette;
3018
+ XAxisDisplayOptions?: AxisDisplayOptions;
3019
+ }
3020
+ export interface HistogramBinOptions {
3021
+ BinWidth?: BinWidthOptions;
3022
+ StartValue?: number;
3023
+ SelectedBinType?: HistogramBinType;
3024
+ BinCount?: BinCountOptions;
3025
+ }
3026
+ export interface BinWidthOptions {
3027
+ BinCountLimit?: number;
3028
+ Value?: number;
3029
+ }
3030
+ export interface BinCountOptions {
3031
+ Value?: number;
3032
+ }
3033
+ export interface HistogramFieldWells {
3034
+ HistogramAggregatedFieldWells?: HistogramAggregatedFieldWells;
3035
+ }
3036
+ export interface HistogramAggregatedFieldWells {
3037
+ /**
3038
+ * @minItems 0
3039
+ * @maxItems 1
3040
+ */
3041
+ Values?: MeasureField[];
3042
+ }
3043
+ export interface PluginVisual {
3044
+ Subtitle?: VisualSubtitleLabelOptions;
3045
+ PluginArn: string;
3046
+ VisualId: string;
3047
+ ChartConfiguration?: PluginVisualConfiguration;
3048
+ Title?: VisualTitleLabelOptions;
3049
+ VisualContentAltText?: string;
3050
+ }
3051
+ export interface PluginVisualConfiguration {
3052
+ SortConfiguration?: PluginVisualSortConfiguration;
3053
+ VisualOptions?: PluginVisualOptions;
3054
+ /**
3055
+ * @minItems 0
3056
+ * @maxItems 10
3057
+ */
3058
+ FieldWells?: PluginVisualFieldWell[];
3059
+ }
3060
+ export interface PluginVisualSortConfiguration {
3061
+ PluginVisualTableQuerySort?: PluginVisualTableQuerySort;
3062
+ }
3063
+ export interface PluginVisualTableQuerySort {
3064
+ ItemsLimitConfiguration?: PluginVisualItemsLimitConfiguration;
3065
+ /**
3066
+ * @minItems 0
3067
+ * @maxItems 100
3068
+ */
3069
+ RowSort?: FieldSortOptions[];
3070
+ }
3071
+ export interface PluginVisualItemsLimitConfiguration {
3072
+ ItemsLimit?: number;
3073
+ }
3074
+ export interface PluginVisualOptions {
3075
+ VisualProperties?: PluginVisualProperty[];
3076
+ }
3077
+ export interface PluginVisualProperty {
3078
+ Value?: string;
3079
+ Name?: string;
3080
+ }
3081
+ export interface PluginVisualFieldWell {
3082
+ /**
3083
+ * @minItems 0
3084
+ * @maxItems 200
3085
+ */
3086
+ Unaggregated?: UnaggregatedField[];
3087
+ AxisName?: PluginVisualAxisName;
3088
+ /**
3089
+ * @minItems 0
3090
+ * @maxItems 200
3091
+ */
3092
+ Measures?: MeasureField[];
3093
+ /**
3094
+ * @minItems 0
3095
+ * @maxItems 200
3096
+ */
3097
+ Dimensions?: DimensionField[];
3098
+ }
3099
+ export interface TableVisual {
3100
+ Subtitle?: VisualSubtitleLabelOptions;
3101
+ ConditionalFormatting?: TableConditionalFormatting;
3102
+ VisualId: string;
3103
+ ChartConfiguration?: TableConfiguration;
3104
+ /**
3105
+ * @minItems 0
3106
+ * @maxItems 10
3107
+ */
3108
+ Actions?: VisualCustomAction[];
3109
+ Title?: VisualTitleLabelOptions;
3110
+ VisualContentAltText?: string;
3111
+ }
3112
+ export interface TableConditionalFormatting {
3113
+ /**
3114
+ * @minItems 0
3115
+ * @maxItems 500
3116
+ */
3117
+ ConditionalFormattingOptions?: TableConditionalFormattingOption[];
3118
+ }
3119
+ export interface TableConditionalFormattingOption {
3120
+ Row?: TableRowConditionalFormatting;
3121
+ Cell?: TableCellConditionalFormatting;
3122
+ }
3123
+ export interface TableRowConditionalFormatting {
3124
+ TextColor?: ConditionalFormattingColor;
3125
+ BackgroundColor?: ConditionalFormattingColor;
3126
+ }
3127
+ export interface TableCellConditionalFormatting {
3128
+ FieldId: string;
3129
+ TextFormat?: TextConditionalFormat;
3130
+ }
3131
+ export interface TextConditionalFormat {
3132
+ TextColor?: ConditionalFormattingColor;
3133
+ Icon?: ConditionalFormattingIcon;
3134
+ BackgroundColor?: ConditionalFormattingColor;
3135
+ }
3136
+ export interface TableConfiguration {
3137
+ SortConfiguration?: TableSortConfiguration;
3138
+ PaginatedReportOptions?: TablePaginatedReportOptions;
3139
+ TableOptions?: TableOptions;
3140
+ /**
3141
+ * @minItems 0
3142
+ * @maxItems 200
3143
+ */
3144
+ TableInlineVisualizations?: TableInlineVisualization[];
3145
+ FieldWells?: TableFieldWells;
3146
+ FieldOptions?: TableFieldOptions;
3147
+ TotalOptions?: TotalOptions;
3148
+ }
3149
+ export interface TableSortConfiguration {
3150
+ /**
3151
+ * @minItems 0
3152
+ * @maxItems 100
3153
+ */
3154
+ RowSort?: FieldSortOptions[];
3155
+ PaginationConfiguration?: PaginationConfiguration;
3156
+ }
3157
+ export interface TablePaginatedReportOptions {
3158
+ OverflowColumnHeaderVisibility?: Visibility;
3159
+ VerticalOverflowVisibility?: Visibility;
3160
+ }
3161
+ export interface TableOptions {
3162
+ HeaderStyle?: TableCellStyle;
3163
+ CellStyle?: TableCellStyle;
3164
+ Orientation?: TableOrientation;
3165
+ RowAlternateColorOptions?: RowAlternateColorOptions;
3166
+ }
3167
+ export interface TableCellStyle {
3168
+ VerticalTextAlignment?: VerticalTextAlignment;
3169
+ Visibility?: Visibility;
3170
+ Height?: number;
3171
+ FontConfiguration?: FontConfiguration;
3172
+ Border?: GlobalTableBorderOptions;
3173
+ TextWrap?: TextWrap;
3174
+ HorizontalTextAlignment?: HorizontalTextAlignment;
3175
+ BackgroundColor?: string;
3176
+ }
3177
+ export interface GlobalTableBorderOptions {
3178
+ UniformBorder?: TableBorderOptions;
3179
+ SideSpecificBorder?: TableSideBorderOptions;
3180
+ }
3181
+ export interface TableBorderOptions {
3182
+ Thickness?: number;
3183
+ Color?: string;
3184
+ Style?: TableBorderStyle;
3185
+ }
3186
+ export interface TableSideBorderOptions {
3187
+ Left?: TableBorderOptions;
3188
+ Top?: TableBorderOptions;
3189
+ InnerHorizontal?: TableBorderOptions;
3190
+ Right?: TableBorderOptions;
3191
+ Bottom?: TableBorderOptions;
3192
+ InnerVertical?: TableBorderOptions;
3193
+ }
3194
+ export interface RowAlternateColorOptions {
3195
+ Status?: WidgetStatus;
3196
+ UsePrimaryBackgroundColor?: WidgetStatus;
3197
+ /**
3198
+ * @minItems 0
3199
+ * @maxItems 1
3200
+ */
3201
+ RowAlternateColors?: string[];
3202
+ }
3203
+ export interface TableInlineVisualization {
3204
+ DataBars?: DataBarsOptions;
3205
+ }
3206
+ export interface DataBarsOptions {
3207
+ PositiveColor?: string;
3208
+ FieldId: string;
3209
+ NegativeColor?: string;
3210
+ }
3211
+ export interface TableFieldWells {
3212
+ TableUnaggregatedFieldWells?: TableUnaggregatedFieldWells;
3213
+ TableAggregatedFieldWells?: TableAggregatedFieldWells;
3214
+ }
3215
+ export interface TableUnaggregatedFieldWells {
3216
+ /**
3217
+ * @minItems 0
3218
+ * @maxItems 200
3219
+ */
3220
+ Values?: UnaggregatedField[];
3221
+ }
3222
+ export interface TableAggregatedFieldWells {
3223
+ /**
3224
+ * @minItems 0
3225
+ * @maxItems 200
3226
+ */
3227
+ GroupBy?: DimensionField[];
3228
+ /**
3229
+ * @minItems 0
3230
+ * @maxItems 200
3231
+ */
3232
+ Values?: MeasureField[];
3233
+ }
3234
+ export interface TableFieldOptions {
3235
+ /**
3236
+ * @minItems 0
3237
+ * @maxItems 200
3238
+ */
3239
+ Order?: string[];
3240
+ PinnedFieldOptions?: TablePinnedFieldOptions;
3241
+ /**
3242
+ * @minItems 0
3243
+ * @maxItems 100
3244
+ */
3245
+ SelectedFieldOptions?: TableFieldOption[];
3246
+ }
3247
+ export interface TablePinnedFieldOptions {
3248
+ /**
3249
+ * @minItems 0
3250
+ * @maxItems 201
3251
+ */
3252
+ PinnedLeftFields?: string[];
3253
+ }
3254
+ export interface TableFieldOption {
3255
+ CustomLabel?: string;
3256
+ URLStyling?: TableFieldURLConfiguration;
3257
+ FieldId: string;
3258
+ Visibility?: Visibility;
3259
+ /**
3260
+ * String based length that is composed of value and unit in px
3261
+ */
3262
+ Width?: string;
3263
+ }
3264
+ export interface TableFieldURLConfiguration {
3265
+ LinkConfiguration?: TableFieldLinkConfiguration;
3266
+ ImageConfiguration?: TableFieldImageConfiguration;
3267
+ }
3268
+ export interface TableFieldLinkConfiguration {
3269
+ Target: URLTargetConfiguration;
3270
+ Content: TableFieldLinkContentConfiguration;
3271
+ }
3272
+ export interface TableFieldLinkContentConfiguration {
3273
+ CustomIconContent?: TableFieldCustomIconContent;
3274
+ CustomTextContent?: TableFieldCustomTextContent;
3275
+ }
3276
+ export interface TableFieldCustomIconContent {
3277
+ Icon?: TableFieldIconSetType;
3278
+ }
3279
+ export interface TableFieldCustomTextContent {
3280
+ Value?: string;
3281
+ FontConfiguration: FontConfiguration;
3282
+ }
3283
+ export interface TableFieldImageConfiguration {
3284
+ SizingOptions?: TableCellImageSizingConfiguration;
3285
+ }
3286
+ export interface TableCellImageSizingConfiguration {
3287
+ TableCellImageScalingConfiguration?: TableCellImageScalingConfiguration;
3288
+ }
3289
+ export interface TotalOptions {
3290
+ /**
3291
+ * @minItems 0
3292
+ * @maxItems 200
3293
+ */
3294
+ TotalAggregationOptions?: TotalAggregationOption[];
3295
+ CustomLabel?: string;
3296
+ ScrollStatus?: TableTotalsScrollStatus;
3297
+ Placement?: TableTotalsPlacement;
3298
+ TotalCellStyle?: TableCellStyle;
3299
+ TotalsVisibility?: Visibility;
3300
+ }
3301
+ export interface TotalAggregationOption {
3302
+ TotalAggregationFunction: TotalAggregationFunction;
3303
+ FieldId: string;
3304
+ }
3305
+ export interface TotalAggregationFunction {
3306
+ SimpleTotalAggregationFunction?: SimpleTotalAggregationFunction;
3307
+ }
3308
+ export interface PivotTableVisual {
3309
+ Subtitle?: VisualSubtitleLabelOptions;
3310
+ ConditionalFormatting?: PivotTableConditionalFormatting;
3311
+ VisualId: string;
3312
+ ChartConfiguration?: PivotTableConfiguration;
3313
+ /**
3314
+ * @minItems 0
3315
+ * @maxItems 10
3316
+ */
3317
+ Actions?: VisualCustomAction[];
3318
+ Title?: VisualTitleLabelOptions;
3319
+ VisualContentAltText?: string;
3320
+ }
3321
+ export interface PivotTableConditionalFormatting {
3322
+ /**
3323
+ * @minItems 0
3324
+ * @maxItems 500
3325
+ */
3326
+ ConditionalFormattingOptions?: PivotTableConditionalFormattingOption[];
3327
+ }
3328
+ export interface PivotTableConditionalFormattingOption {
3329
+ Cell?: PivotTableCellConditionalFormatting;
3330
+ }
3331
+ export interface PivotTableCellConditionalFormatting {
3332
+ Scope?: PivotTableConditionalFormattingScope;
3333
+ /**
3334
+ * @minItems 0
3335
+ * @maxItems 3
3336
+ */
3337
+ Scopes?: PivotTableConditionalFormattingScope[];
3338
+ FieldId: string;
3339
+ TextFormat?: TextConditionalFormat;
3340
+ }
3341
+ export interface PivotTableConditionalFormattingScope {
3342
+ Role?: PivotTableConditionalFormattingScopeRole;
3343
+ }
3344
+ export interface PivotTableConfiguration {
3345
+ SortConfiguration?: PivotTableSortConfiguration;
3346
+ PaginatedReportOptions?: PivotTablePaginatedReportOptions;
3347
+ TableOptions?: PivotTableOptions;
3348
+ FieldWells?: PivotTableFieldWells;
3349
+ FieldOptions?: PivotTableFieldOptions;
3350
+ TotalOptions?: PivotTableTotalOptions;
3351
+ }
3352
+ export interface PivotTableSortConfiguration {
3353
+ /**
3354
+ * @minItems 0
3355
+ * @maxItems 200
3356
+ */
3357
+ FieldSortOptions?: PivotFieldSortOptions[];
3358
+ }
3359
+ export interface PivotFieldSortOptions {
3360
+ SortBy: PivotTableSortBy;
3361
+ FieldId: string;
3362
+ }
3363
+ export interface PivotTableSortBy {
3364
+ Field?: FieldSort;
3365
+ DataPath?: DataPathSort;
3366
+ Column?: ColumnSort;
3367
+ }
3368
+ export interface DataPathSort {
3369
+ /**
3370
+ * @minItems 0
3371
+ * @maxItems 20
3372
+ */
3373
+ SortPaths: DataPathValue[];
3374
+ Direction: SortDirection;
3375
+ }
3376
+ export interface PivotTablePaginatedReportOptions {
3377
+ OverflowColumnHeaderVisibility?: Visibility;
3378
+ VerticalOverflowVisibility?: Visibility;
3379
+ }
3380
+ export interface PivotTableOptions {
3381
+ RowFieldNamesStyle?: TableCellStyle;
3382
+ RowHeaderStyle?: TableCellStyle;
3383
+ CollapsedRowDimensionsVisibility?: Visibility;
3384
+ RowsLayout?: PivotTableRowsLayout;
3385
+ MetricPlacement?: PivotTableMetricPlacement;
3386
+ /**
3387
+ * String based length that is composed of value and unit in px
3388
+ */
3389
+ DefaultCellWidth?: string;
3390
+ ColumnNamesVisibility?: Visibility;
3391
+ RowsLabelOptions?: PivotTableRowsLabelOptions;
3392
+ SingleMetricVisibility?: Visibility;
3393
+ ColumnHeaderStyle?: TableCellStyle;
3394
+ ToggleButtonsVisibility?: Visibility;
3395
+ CellStyle?: TableCellStyle;
3396
+ RowAlternateColorOptions?: RowAlternateColorOptions;
3397
+ }
3398
+ export interface PivotTableRowsLabelOptions {
3399
+ CustomLabel?: string;
3400
+ Visibility?: Visibility;
3401
+ }
3402
+ export interface PivotTableFieldWells {
3403
+ PivotTableAggregatedFieldWells?: PivotTableAggregatedFieldWells;
3404
+ }
3405
+ export interface PivotTableAggregatedFieldWells {
3406
+ /**
3407
+ * @minItems 0
3408
+ * @maxItems 40
3409
+ */
3410
+ Values?: MeasureField[];
3411
+ /**
3412
+ * @minItems 0
3413
+ * @maxItems 40
3414
+ */
3415
+ Columns?: DimensionField[];
3416
+ /**
3417
+ * @minItems 0
3418
+ * @maxItems 40
3419
+ */
3420
+ Rows?: DimensionField[];
3421
+ }
3422
+ export interface PivotTableFieldOptions {
3423
+ CollapseStateOptions?: PivotTableFieldCollapseStateOption[];
3424
+ /**
3425
+ * @minItems 0
3426
+ * @maxItems 100
3427
+ */
3428
+ DataPathOptions?: PivotTableDataPathOption[];
3429
+ /**
3430
+ * @minItems 0
3431
+ * @maxItems 100
3432
+ */
3433
+ SelectedFieldOptions?: PivotTableFieldOption[];
3434
+ }
3435
+ export interface PivotTableFieldCollapseStateOption {
3436
+ Target: PivotTableFieldCollapseStateTarget;
3437
+ State?: PivotTableFieldCollapseState;
3438
+ }
3439
+ export interface PivotTableFieldCollapseStateTarget {
3440
+ FieldId?: string;
3441
+ /**
3442
+ * @minItems 0
3443
+ * @maxItems 20
3444
+ */
3445
+ FieldDataPathValues?: DataPathValue[];
3446
+ }
3447
+ export interface PivotTableDataPathOption {
3448
+ /**
3449
+ * @minItems 0
3450
+ * @maxItems 20
3451
+ */
3452
+ DataPathList: DataPathValue[];
3453
+ /**
3454
+ * String based length that is composed of value and unit in px
3455
+ */
3456
+ Width?: string;
3457
+ }
3458
+ export interface PivotTableFieldOption {
3459
+ CustomLabel?: string;
3460
+ FieldId: string;
3461
+ Visibility?: Visibility;
3462
+ }
3463
+ export interface PivotTableTotalOptions {
3464
+ ColumnSubtotalOptions?: SubtotalOptions;
3465
+ RowSubtotalOptions?: SubtotalOptions;
3466
+ RowTotalOptions?: PivotTotalOptions;
3467
+ ColumnTotalOptions?: PivotTotalOptions;
3468
+ }
3469
+ export interface SubtotalOptions {
3470
+ CustomLabel?: string;
3471
+ /**
3472
+ * @minItems 0
3473
+ * @maxItems 100
3474
+ */
3475
+ FieldLevelOptions?: PivotTableFieldSubtotalOptions[];
3476
+ ValueCellStyle?: TableCellStyle;
3477
+ TotalCellStyle?: TableCellStyle;
3478
+ TotalsVisibility?: Visibility;
3479
+ FieldLevel?: PivotTableSubtotalLevel;
3480
+ MetricHeaderCellStyle?: TableCellStyle;
3481
+ /**
3482
+ * @minItems 0
3483
+ * @maxItems 3
3484
+ */
3485
+ StyleTargets?: TableStyleTarget[];
3486
+ }
3487
+ export interface PivotTableFieldSubtotalOptions {
3488
+ FieldId?: string;
3489
+ }
3490
+ export interface TableStyleTarget {
3491
+ CellType: StyledCellType;
3492
+ }
3493
+ export interface PivotTotalOptions {
3494
+ /**
3495
+ * @minItems 0
3496
+ * @maxItems 200
3497
+ */
3498
+ TotalAggregationOptions?: TotalAggregationOption[];
3499
+ CustomLabel?: string;
3500
+ ValueCellStyle?: TableCellStyle;
3501
+ ScrollStatus?: TableTotalsScrollStatus;
3502
+ Placement?: TableTotalsPlacement;
3503
+ TotalCellStyle?: TableCellStyle;
3504
+ TotalsVisibility?: Visibility;
3505
+ MetricHeaderCellStyle?: TableCellStyle;
3506
+ }
3507
+ export interface BarChartVisual {
3508
+ Subtitle?: VisualSubtitleLabelOptions;
3509
+ VisualId: string;
3510
+ ChartConfiguration?: BarChartConfiguration;
3511
+ /**
3512
+ * @minItems 0
3513
+ * @maxItems 10
3514
+ */
3515
+ Actions?: VisualCustomAction[];
3516
+ Title?: VisualTitleLabelOptions;
3517
+ VisualContentAltText?: string;
3518
+ /**
3519
+ * @minItems 0
3520
+ * @maxItems 2
3521
+ */
3522
+ ColumnHierarchies?: ColumnHierarchy[];
3523
+ }
3524
+ export interface BarChartConfiguration {
3525
+ SortConfiguration?: BarChartSortConfiguration;
3526
+ Legend?: LegendOptions;
3527
+ /**
3528
+ * @minItems 0
3529
+ * @maxItems 20
3530
+ */
3531
+ ReferenceLines?: ReferenceLine[];
3532
+ DataLabels?: DataLabelOptions;
3533
+ ColorLabelOptions?: ChartAxisLabelOptions;
3534
+ CategoryLabelOptions?: ChartAxisLabelOptions;
3535
+ Tooltip?: TooltipOptions;
3536
+ SmallMultiplesOptions?: SmallMultiplesOptions;
3537
+ Orientation?: BarChartOrientation;
3538
+ VisualPalette?: VisualPalette;
3539
+ ValueLabelOptions?: ChartAxisLabelOptions;
3540
+ BarsArrangement?: BarsArrangement;
3541
+ CategoryAxis?: AxisDisplayOptions;
3542
+ /**
3543
+ * @minItems 1
3544
+ * @maxItems 200
3545
+ */
3546
+ ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
3547
+ FieldWells?: BarChartFieldWells;
3548
+ ValueAxis?: AxisDisplayOptions;
3549
+ }
3550
+ export interface BarChartSortConfiguration {
3551
+ /**
3552
+ * @minItems 0
3553
+ * @maxItems 100
3554
+ */
3555
+ SmallMultiplesSort?: FieldSortOptions[];
3556
+ /**
3557
+ * @minItems 0
3558
+ * @maxItems 100
3559
+ */
3560
+ ColorSort?: FieldSortOptions[];
3561
+ ColorItemsLimit?: ItemsLimitConfiguration;
3562
+ CategoryItemsLimit?: ItemsLimitConfiguration;
3563
+ /**
3564
+ * @minItems 0
3565
+ * @maxItems 100
3566
+ */
3567
+ CategorySort?: FieldSortOptions[];
3568
+ SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
3569
+ }
3570
+ export interface BarChartFieldWells {
3571
+ BarChartAggregatedFieldWells?: BarChartAggregatedFieldWells;
3572
+ }
3573
+ export interface BarChartAggregatedFieldWells {
3574
+ /**
3575
+ * @minItems 0
3576
+ * @maxItems 200
3577
+ */
3578
+ Category?: DimensionField[];
3579
+ /**
3580
+ * @minItems 0
3581
+ * @maxItems 200
3582
+ */
3583
+ Colors?: DimensionField[];
3584
+ /**
3585
+ * @minItems 0
3586
+ * @maxItems 200
3587
+ */
3588
+ Values?: MeasureField[];
3589
+ /**
3590
+ * @minItems 0
3591
+ * @maxItems 1
3592
+ */
3593
+ SmallMultiples?: DimensionField[];
3594
+ }
3595
+ export interface HeatMapVisual {
3596
+ Subtitle?: VisualSubtitleLabelOptions;
3597
+ VisualId: string;
3598
+ ChartConfiguration?: HeatMapConfiguration;
3599
+ /**
3600
+ * @minItems 0
3601
+ * @maxItems 10
3602
+ */
3603
+ Actions?: VisualCustomAction[];
3604
+ Title?: VisualTitleLabelOptions;
3605
+ VisualContentAltText?: string;
3606
+ /**
3607
+ * @minItems 0
3608
+ * @maxItems 2
3609
+ */
3610
+ ColumnHierarchies?: ColumnHierarchy[];
3611
+ }
3612
+ export interface HeatMapConfiguration {
3613
+ SortConfiguration?: HeatMapSortConfiguration;
3614
+ ColumnLabelOptions?: ChartAxisLabelOptions;
3615
+ Legend?: LegendOptions;
3616
+ DataLabels?: DataLabelOptions;
3617
+ FieldWells?: HeatMapFieldWells;
3618
+ Tooltip?: TooltipOptions;
3619
+ ColorScale?: ColorScale;
3620
+ RowLabelOptions?: ChartAxisLabelOptions;
3621
+ }
3622
+ export interface HeatMapSortConfiguration {
3623
+ /**
3624
+ * @minItems 0
3625
+ * @maxItems 100
3626
+ */
3627
+ HeatMapRowSort?: FieldSortOptions[];
3628
+ HeatMapRowItemsLimitConfiguration?: ItemsLimitConfiguration;
3629
+ HeatMapColumnItemsLimitConfiguration?: ItemsLimitConfiguration;
3630
+ /**
3631
+ * @minItems 0
3632
+ * @maxItems 100
3633
+ */
3634
+ HeatMapColumnSort?: FieldSortOptions[];
3635
+ }
3636
+ export interface HeatMapFieldWells {
3637
+ HeatMapAggregatedFieldWells?: HeatMapAggregatedFieldWells;
3638
+ }
3639
+ export interface HeatMapAggregatedFieldWells {
3640
+ /**
3641
+ * @minItems 0
3642
+ * @maxItems 1
3643
+ */
3644
+ Values?: MeasureField[];
3645
+ /**
3646
+ * @minItems 0
3647
+ * @maxItems 1
3648
+ */
3649
+ Columns?: DimensionField[];
3650
+ /**
3651
+ * @minItems 0
3652
+ * @maxItems 1
3653
+ */
3654
+ Rows?: DimensionField[];
3655
+ }
3656
+ export interface ColorScale {
3657
+ /**
3658
+ * @minItems 2
3659
+ * @maxItems 3
3660
+ */
3661
+ Colors: DataColor[];
3662
+ ColorFillType: ColorFillType;
3663
+ NullValueColor?: DataColor;
3664
+ }
3665
+ export interface DataColor {
3666
+ DataValue?: number;
3667
+ Color?: string;
3668
+ }
3669
+ export interface TreeMapVisual {
3670
+ Subtitle?: VisualSubtitleLabelOptions;
3671
+ VisualId: string;
3672
+ ChartConfiguration?: TreeMapConfiguration;
3673
+ /**
3674
+ * @minItems 0
3675
+ * @maxItems 10
3676
+ */
3677
+ Actions?: VisualCustomAction[];
3678
+ Title?: VisualTitleLabelOptions;
3679
+ VisualContentAltText?: string;
3680
+ /**
3681
+ * @minItems 0
3682
+ * @maxItems 2
3683
+ */
3684
+ ColumnHierarchies?: ColumnHierarchy[];
3685
+ }
3686
+ export interface TreeMapConfiguration {
3687
+ SortConfiguration?: TreeMapSortConfiguration;
3688
+ Legend?: LegendOptions;
3689
+ DataLabels?: DataLabelOptions;
3690
+ ColorLabelOptions?: ChartAxisLabelOptions;
3691
+ SizeLabelOptions?: ChartAxisLabelOptions;
3692
+ FieldWells?: TreeMapFieldWells;
3693
+ Tooltip?: TooltipOptions;
3694
+ ColorScale?: ColorScale;
3695
+ GroupLabelOptions?: ChartAxisLabelOptions;
3696
+ }
3697
+ export interface TreeMapSortConfiguration {
3698
+ /**
3699
+ * @minItems 0
3700
+ * @maxItems 100
3701
+ */
3702
+ TreeMapSort?: FieldSortOptions[];
3703
+ TreeMapGroupItemsLimitConfiguration?: ItemsLimitConfiguration;
3704
+ }
3705
+ export interface TreeMapFieldWells {
3706
+ TreeMapAggregatedFieldWells?: TreeMapAggregatedFieldWells;
3707
+ }
3708
+ export interface TreeMapAggregatedFieldWells {
3709
+ /**
3710
+ * @minItems 0
3711
+ * @maxItems 1
3712
+ */
3713
+ Sizes?: MeasureField[];
3714
+ /**
3715
+ * @minItems 0
3716
+ * @maxItems 1
3717
+ */
3718
+ Colors?: MeasureField[];
3719
+ /**
3720
+ * @minItems 0
3721
+ * @maxItems 1
3722
+ */
3723
+ Groups?: DimensionField[];
3724
+ }
3725
+ export interface InsightVisual {
3726
+ Subtitle?: VisualSubtitleLabelOptions;
3727
+ VisualId: string;
3728
+ /**
3729
+ * @minItems 0
3730
+ * @maxItems 10
3731
+ */
3732
+ Actions?: VisualCustomAction[];
3733
+ DataSetIdentifier: string;
3734
+ InsightConfiguration?: InsightConfiguration;
3735
+ Title?: VisualTitleLabelOptions;
3736
+ VisualContentAltText?: string;
3737
+ }
3738
+ export interface InsightConfiguration {
3739
+ /**
3740
+ * @minItems 0
3741
+ * @maxItems 100
3742
+ */
3743
+ Computations?: Computation[];
3744
+ CustomNarrative?: CustomNarrativeOptions;
3745
+ }
3746
+ export interface Computation {
3747
+ PeriodToDate?: PeriodToDateComputation;
3748
+ GrowthRate?: GrowthRateComputation;
3749
+ TopBottomRanked?: TopBottomRankedComputation;
3750
+ TotalAggregation?: TotalAggregationComputation;
3751
+ Forecast?: ForecastComputation;
3752
+ MaximumMinimum?: MaximumMinimumComputation;
3753
+ PeriodOverPeriod?: PeriodOverPeriodComputation;
3754
+ MetricComparison?: MetricComparisonComputation;
3755
+ TopBottomMovers?: TopBottomMoversComputation;
3756
+ UniqueValues?: UniqueValuesComputation;
3757
+ }
3758
+ export interface PeriodToDateComputation {
3759
+ PeriodTimeGranularity?: TimeGranularity;
3760
+ Value?: MeasureField;
3761
+ Time?: DimensionField;
3762
+ ComputationId: string;
3763
+ Name?: string;
3764
+ }
3765
+ export interface GrowthRateComputation {
3766
+ Value?: MeasureField;
3767
+ Time?: DimensionField;
3768
+ PeriodSize?: number;
3769
+ ComputationId: string;
3770
+ Name?: string;
3771
+ }
3772
+ export interface TopBottomRankedComputation {
3773
+ Type: TopBottomComputationType;
3774
+ Category?: DimensionField;
3775
+ ResultSize?: number;
3776
+ Value?: MeasureField;
3777
+ ComputationId: string;
3778
+ Name?: string;
3779
+ }
3780
+ export interface TotalAggregationComputation {
3781
+ Value?: MeasureField;
3782
+ ComputationId: string;
3783
+ Name?: string;
3784
+ }
3785
+ export interface ForecastComputation {
3786
+ PeriodsBackward?: number;
3787
+ PeriodsForward?: number;
3788
+ PredictionInterval?: number;
3789
+ Seasonality?: ForecastComputationSeasonality;
3790
+ CustomSeasonalityValue?: number;
3791
+ Value?: MeasureField;
3792
+ Time?: DimensionField;
3793
+ UpperBoundary?: number;
3794
+ ComputationId: string;
3795
+ Name?: string;
3796
+ LowerBoundary?: number;
3797
+ }
3798
+ export interface MaximumMinimumComputation {
3799
+ Type: MaximumMinimumComputationType;
3800
+ Value?: MeasureField;
3801
+ Time?: DimensionField;
3802
+ ComputationId: string;
3803
+ Name?: string;
3804
+ }
3805
+ export interface PeriodOverPeriodComputation {
3806
+ Value?: MeasureField;
3807
+ Time?: DimensionField;
3808
+ ComputationId: string;
3809
+ Name?: string;
3810
+ }
3811
+ export interface MetricComparisonComputation {
3812
+ TargetValue?: MeasureField;
3813
+ Time?: DimensionField;
3814
+ ComputationId: string;
3815
+ FromValue?: MeasureField;
3816
+ Name?: string;
3817
+ }
3818
+ export interface TopBottomMoversComputation {
3819
+ Type: TopBottomComputationType;
3820
+ Category?: DimensionField;
3821
+ Value?: MeasureField;
3822
+ SortOrder?: TopBottomSortOrder;
3823
+ Time?: DimensionField;
3824
+ MoverSize?: number;
3825
+ ComputationId: string;
3826
+ Name?: string;
3827
+ }
3828
+ export interface UniqueValuesComputation {
3829
+ Category?: DimensionField;
3830
+ ComputationId: string;
3831
+ Name?: string;
3832
+ }
3833
+ export interface CustomNarrativeOptions {
3834
+ Narrative: string;
3835
+ }
3836
+ export interface LineChartVisual {
3837
+ Subtitle?: VisualSubtitleLabelOptions;
3838
+ VisualId: string;
3839
+ ChartConfiguration?: LineChartConfiguration;
3840
+ /**
3841
+ * @minItems 0
3842
+ * @maxItems 10
3843
+ */
3844
+ Actions?: VisualCustomAction[];
3845
+ Title?: VisualTitleLabelOptions;
3846
+ VisualContentAltText?: string;
3847
+ /**
3848
+ * @minItems 0
3849
+ * @maxItems 2
3850
+ */
3851
+ ColumnHierarchies?: ColumnHierarchy[];
3852
+ }
3853
+ export interface LineChartConfiguration {
3854
+ SortConfiguration?: LineChartSortConfiguration;
3855
+ Legend?: LegendOptions;
3856
+ /**
3857
+ * @minItems 0
3858
+ * @maxItems 20
3859
+ */
3860
+ ReferenceLines?: ReferenceLine[];
3861
+ DataLabels?: DataLabelOptions;
3862
+ Tooltip?: TooltipOptions;
3863
+ SingleAxisOptions?: SingleAxisOptions;
3864
+ SmallMultiplesOptions?: SmallMultiplesOptions;
3865
+ PrimaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions;
3866
+ VisualPalette?: VisualPalette;
3867
+ XAxisDisplayOptions?: AxisDisplayOptions;
3868
+ DefaultSeriesSettings?: LineChartDefaultSeriesSettings;
3869
+ SecondaryYAxisLabelOptions?: ChartAxisLabelOptions;
3870
+ /**
3871
+ * @minItems 0
3872
+ * @maxItems 10
3873
+ */
3874
+ ForecastConfigurations?: ForecastConfiguration[];
3875
+ /**
3876
+ * @minItems 0
3877
+ * @maxItems 2000
3878
+ */
3879
+ Series?: SeriesItem[];
3880
+ Type?: LineChartType;
3881
+ PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
3882
+ /**
3883
+ * @minItems 1
3884
+ * @maxItems 200
3885
+ */
3886
+ ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
3887
+ FieldWells?: LineChartFieldWells;
3888
+ SecondaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions;
3889
+ XAxisLabelOptions?: ChartAxisLabelOptions;
3890
+ }
3891
+ export interface LineChartSortConfiguration {
3892
+ CategoryItemsLimitConfiguration?: ItemsLimitConfiguration;
3893
+ ColorItemsLimitConfiguration?: ItemsLimitConfiguration;
3894
+ /**
3895
+ * @minItems 0
3896
+ * @maxItems 100
3897
+ */
3898
+ SmallMultiplesSort?: FieldSortOptions[];
3899
+ /**
3900
+ * @minItems 0
3901
+ * @maxItems 100
3902
+ */
3903
+ CategorySort?: FieldSortOptions[];
3904
+ SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
3905
+ }
3906
+ export interface LineSeriesAxisDisplayOptions {
3907
+ /**
3908
+ * @minItems 0
3909
+ * @maxItems 100
3910
+ */
3911
+ MissingDataConfigurations?: MissingDataConfiguration[];
3912
+ AxisOptions?: AxisDisplayOptions;
3913
+ }
3914
+ export interface MissingDataConfiguration {
3915
+ TreatmentOption?: MissingDataTreatmentOption;
3916
+ }
3917
+ export interface LineChartDefaultSeriesSettings {
3918
+ LineStyleSettings?: LineChartLineStyleSettings;
3919
+ AxisBinding?: AxisBinding;
3920
+ MarkerStyleSettings?: LineChartMarkerStyleSettings;
3921
+ }
3922
+ export interface LineChartLineStyleSettings {
3923
+ LineInterpolation?: LineInterpolation;
3924
+ LineStyle?: LineChartLineStyle;
3925
+ LineVisibility?: Visibility;
3926
+ /**
3927
+ * String based length that is composed of value and unit in px
3928
+ */
3929
+ LineWidth?: string;
3930
+ }
3931
+ export interface LineChartMarkerStyleSettings {
3932
+ MarkerShape?: LineChartMarkerShape;
3933
+ /**
3934
+ * String based length that is composed of value and unit in px
3935
+ */
3936
+ MarkerSize?: string;
3937
+ MarkerVisibility?: Visibility;
3938
+ MarkerColor?: string;
3939
+ }
3940
+ export interface ForecastConfiguration {
3941
+ ForecastProperties?: TimeBasedForecastProperties;
3942
+ Scenario?: ForecastScenario;
3943
+ }
3944
+ export interface TimeBasedForecastProperties {
3945
+ PeriodsBackward?: number;
3946
+ PeriodsForward?: number;
3947
+ PredictionInterval?: number;
3948
+ Seasonality?: number;
3949
+ UpperBoundary?: number;
3950
+ LowerBoundary?: number;
3951
+ }
3952
+ export interface ForecastScenario {
3953
+ WhatIfRangeScenario?: WhatIfRangeScenario;
3954
+ WhatIfPointScenario?: WhatIfPointScenario;
3955
+ }
3956
+ export interface WhatIfRangeScenario {
3957
+ StartDate: string;
3958
+ Value: number;
3959
+ EndDate: string;
3960
+ }
3961
+ export interface WhatIfPointScenario {
3962
+ Value: number;
3963
+ Date: string;
3964
+ }
3965
+ export interface SeriesItem {
3966
+ FieldSeriesItem?: FieldSeriesItem;
3967
+ DataFieldSeriesItem?: DataFieldSeriesItem;
3968
+ }
3969
+ export interface FieldSeriesItem {
3970
+ FieldId: string;
3971
+ AxisBinding: AxisBinding;
3972
+ Settings?: LineChartSeriesSettings;
3973
+ }
3974
+ export interface LineChartSeriesSettings {
3975
+ LineStyleSettings?: LineChartLineStyleSettings;
3976
+ MarkerStyleSettings?: LineChartMarkerStyleSettings;
3977
+ }
3978
+ export interface DataFieldSeriesItem {
3979
+ FieldId: string;
3980
+ AxisBinding: AxisBinding;
3981
+ FieldValue?: string;
3982
+ Settings?: LineChartSeriesSettings;
3983
+ }
3984
+ export interface LineChartFieldWells {
3985
+ LineChartAggregatedFieldWells?: LineChartAggregatedFieldWells;
3986
+ }
3987
+ export interface LineChartAggregatedFieldWells {
3988
+ /**
3989
+ * @minItems 0
3990
+ * @maxItems 200
3991
+ */
3992
+ Category?: DimensionField[];
3993
+ /**
3994
+ * @minItems 0
3995
+ * @maxItems 200
3996
+ */
3997
+ Colors?: DimensionField[];
3998
+ /**
3999
+ * @minItems 0
4000
+ * @maxItems 200
4001
+ */
4002
+ Values?: MeasureField[];
4003
+ /**
4004
+ * @minItems 0
4005
+ * @maxItems 1
4006
+ */
4007
+ SmallMultiples?: DimensionField[];
4008
+ }
4009
+ export interface EmptyVisual {
4010
+ VisualId: string;
4011
+ /**
4012
+ * @minItems 0
4013
+ * @maxItems 10
4014
+ */
4015
+ Actions?: VisualCustomAction[];
4016
+ DataSetIdentifier: string;
4017
+ }
4018
+ export interface ParameterDeclaration {
4019
+ StringParameterDeclaration?: StringParameterDeclaration;
4020
+ DateTimeParameterDeclaration?: DateTimeParameterDeclaration;
4021
+ DecimalParameterDeclaration?: DecimalParameterDeclaration;
4022
+ IntegerParameterDeclaration?: IntegerParameterDeclaration;
4023
+ }
4024
+ export interface StringParameterDeclaration {
4025
+ /**
4026
+ * @minItems 0
4027
+ * @maxItems 150
4028
+ */
4029
+ MappedDataSetParameters?: MappedDataSetParameter[];
4030
+ DefaultValues?: StringDefaultValues;
4031
+ ParameterValueType: ParameterValueType;
4032
+ ValueWhenUnset?: StringValueWhenUnsetConfiguration;
4033
+ Name: string;
4034
+ }
4035
+ export interface MappedDataSetParameter {
4036
+ DataSetParameterName: string;
4037
+ DataSetIdentifier: string;
4038
+ }
4039
+ export interface StringDefaultValues {
4040
+ DynamicValue?: DynamicDefaultValue;
4041
+ /**
4042
+ * @minItems 0
4043
+ * @maxItems 50000
4044
+ */
4045
+ StaticValues?: string[];
4046
+ }
4047
+ export interface DynamicDefaultValue {
4048
+ GroupNameColumn?: ColumnIdentifier;
4049
+ DefaultValueColumn: ColumnIdentifier;
4050
+ UserNameColumn?: ColumnIdentifier;
4051
+ }
4052
+ export interface StringValueWhenUnsetConfiguration {
4053
+ ValueWhenUnsetOption?: ValueWhenUnsetOption;
4054
+ CustomValue?: string;
4055
+ }
4056
+ export interface DateTimeParameterDeclaration {
4057
+ /**
4058
+ * @minItems 0
4059
+ * @maxItems 150
4060
+ */
4061
+ MappedDataSetParameters?: MappedDataSetParameter[];
4062
+ DefaultValues?: DateTimeDefaultValues;
4063
+ TimeGranularity?: TimeGranularity;
4064
+ ValueWhenUnset?: DateTimeValueWhenUnsetConfiguration;
4065
+ Name: string;
4066
+ }
4067
+ export interface DateTimeDefaultValues {
4068
+ RollingDate?: RollingDateConfiguration;
4069
+ DynamicValue?: DynamicDefaultValue;
4070
+ /**
4071
+ * @minItems 0
4072
+ * @maxItems 50000
4073
+ */
4074
+ StaticValues?: string[];
4075
+ }
4076
+ export interface DateTimeValueWhenUnsetConfiguration {
4077
+ ValueWhenUnsetOption?: ValueWhenUnsetOption;
4078
+ CustomValue?: string;
4079
+ }
4080
+ export interface DecimalParameterDeclaration {
4081
+ /**
4082
+ * @minItems 0
4083
+ * @maxItems 150
4084
+ */
4085
+ MappedDataSetParameters?: MappedDataSetParameter[];
4086
+ DefaultValues?: DecimalDefaultValues;
4087
+ ParameterValueType: ParameterValueType;
4088
+ ValueWhenUnset?: DecimalValueWhenUnsetConfiguration;
4089
+ Name: string;
4090
+ }
4091
+ export interface DecimalDefaultValues {
4092
+ DynamicValue?: DynamicDefaultValue;
4093
+ /**
4094
+ * @minItems 0
4095
+ * @maxItems 50000
4096
+ */
4097
+ StaticValues?: number[];
4098
+ }
4099
+ export interface DecimalValueWhenUnsetConfiguration {
4100
+ ValueWhenUnsetOption?: ValueWhenUnsetOption;
4101
+ CustomValue?: number;
4102
+ }
4103
+ export interface IntegerParameterDeclaration {
4104
+ /**
4105
+ * @minItems 0
4106
+ * @maxItems 150
4107
+ */
4108
+ MappedDataSetParameters?: MappedDataSetParameter[];
4109
+ DefaultValues?: IntegerDefaultValues;
4110
+ ParameterValueType: ParameterValueType;
4111
+ ValueWhenUnset?: IntegerValueWhenUnsetConfiguration;
4112
+ Name: string;
4113
+ }
4114
+ export interface IntegerDefaultValues {
4115
+ DynamicValue?: DynamicDefaultValue;
4116
+ /**
4117
+ * @minItems 0
4118
+ * @maxItems 50000
4119
+ */
4120
+ StaticValues?: number[];
4121
+ }
4122
+ export interface IntegerValueWhenUnsetConfiguration {
4123
+ ValueWhenUnsetOption?: ValueWhenUnsetOption;
4124
+ CustomValue?: number;
4125
+ }
4126
+ /**
4127
+ * <p>The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to <code>LENIENT</code>, validation is skipped for specific errors.</p>
4128
+ */
4129
+ export interface ValidationStrategy {
4130
+ Mode: ValidationStrategyMode;
4131
+ }
4132
+ /**
4133
+ * <p>Analysis error.</p>
4134
+ */
4135
+ export interface AnalysisError {
4136
+ Type?: AnalysisErrorType;
4137
+ /**
4138
+ * <p>The message associated with the analysis error.</p>
4139
+ */
4140
+ Message?: string;
4141
+ /**
4142
+ * <p>Lists the violated entities that caused the analysis error</p>
4143
+ *
4144
+ * @minItems 0
4145
+ * @maxItems 200
4146
+ */
4147
+ ViolatedEntities?: Entity[];
4148
+ }
4149
+ export interface Entity {
4150
+ Path?: string;
4151
+ }
4152
+ /**
4153
+ * <p>Permission for the resource.</p>
4154
+ */
4155
+ export interface ResourcePermission {
4156
+ /**
4157
+ * <p>The IAM action to grant or revoke permissions on.</p>
4158
+ *
4159
+ * @minItems 1
4160
+ * @maxItems 20
4161
+ */
4162
+ Actions: string[];
4163
+ /**
4164
+ * <p>The Amazon Resource Name (ARN) of the principal. This can be one of the
4165
+ * following:</p>
4166
+ * <ul>
4167
+ * <li>
4168
+ * <p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p>
4169
+ * </li>
4170
+ * <li>
4171
+ * <p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p>
4172
+ * </li>
4173
+ * <li>
4174
+ * <p>The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight
4175
+ * ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.
4176
+ * (This is less common.) </p>
4177
+ * </li>
4178
+ * </ul>
4179
+ */
4180
+ Principal: string;
4181
+ }
4182
+ /**
4183
+ * <p>The key or keys of the key-value pairs for the resource tag or tags assigned to the
4184
+ * resource.</p>
4185
+ */
4186
+ export interface Tag {
4187
+ /**
4188
+ * <p>Tag value.</p>
4189
+ */
4190
+ Value: string;
4191
+ /**
4192
+ * <p>Tag key.</p>
4193
+ */
4194
+ Key: string;
4195
+ }
4196
+ /**
4197
+ * <p>A <i>sheet</i>, which is an object that contains a set of visuals that
4198
+ * are viewed together on one page in Amazon QuickSight. Every analysis and dashboard
4199
+ * contains at least one sheet. Each sheet contains at least one visualization widget, for
4200
+ * example a chart, pivot table, or narrative insight. Sheets can be associated with other
4201
+ * components, such as controls, filters, and so on.</p>
4202
+ */
4203
+ export interface Sheet {
4204
+ /**
4205
+ * <p>The unique identifier associated with a sheet.</p>
4206
+ */
4207
+ SheetId?: string;
4208
+ /**
4209
+ * @minItems 0
4210
+ * @maxItems 10
4211
+ */
4212
+ Images?: SheetImage[];
4213
+ /**
4214
+ * <p>The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight
4215
+ * console.</p>
4216
+ */
4217
+ Name?: string;
4218
+ }