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