@aws-sdk/client-quicksight 3.696.0 → 3.705.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +88 -0
- package/dist-cjs/index.js +2218 -750
- package/dist-es/QuickSight.js +22 -0
- package/dist-es/commands/BatchCreateTopicReviewedAnswerCommand.js +1 -1
- package/dist-es/commands/CreateAnalysisCommand.js +1 -1
- package/dist-es/commands/CreateDashboardCommand.js +1 -1
- package/dist-es/commands/DeleteDefaultQBusinessApplicationCommand.js +22 -0
- package/dist-es/commands/DescribeAnalysisCommand.js +2 -1
- package/dist-es/commands/DescribeAssetBundleExportJobCommand.js +1 -1
- package/dist-es/commands/DescribeAssetBundleImportJobCommand.js +1 -1
- package/dist-es/commands/DescribeDashboardCommand.js +2 -1
- package/dist-es/commands/DescribeDashboardDefinitionCommand.js +1 -1
- package/dist-es/commands/DescribeDashboardSnapshotJobCommand.js +1 -1
- package/dist-es/commands/DescribeDashboardSnapshotJobResultCommand.js +1 -1
- package/dist-es/commands/DescribeDashboardsQAConfigurationCommand.js +22 -0
- package/dist-es/commands/DescribeDataSetCommand.js +1 -1
- package/dist-es/commands/DescribeDefaultQBusinessApplicationCommand.js +22 -0
- package/dist-es/commands/DescribeQuickSightQSearchConfigurationCommand.js +22 -0
- package/dist-es/commands/DescribeTemplateCommand.js +2 -1
- package/dist-es/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.js +23 -0
- package/dist-es/commands/ListTopicReviewedAnswersCommand.js +1 -1
- package/dist-es/commands/PredictQAResultsCommand.js +23 -0
- package/dist-es/commands/SearchTopicsCommand.js +22 -0
- package/dist-es/commands/UpdateApplicationWithTokenExchangeGrantCommand.js +22 -0
- package/dist-es/commands/UpdateDashboardCommand.js +1 -1
- package/dist-es/commands/UpdateDashboardsQAConfigurationCommand.js +22 -0
- package/dist-es/commands/UpdateDataSetCommand.js +1 -1
- package/dist-es/commands/UpdateDataSourceCommand.js +1 -1
- package/dist-es/commands/UpdateDefaultQBusinessApplicationCommand.js +22 -0
- package/dist-es/commands/UpdateQuickSightQSearchConfigurationCommand.js +22 -0
- package/dist-es/commands/UpdateTemplateCommand.js +1 -1
- package/dist-es/commands/UpdateTopicCommand.js +1 -1
- package/dist-es/commands/index.js +11 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +72 -82
- package/dist-es/models/models_1.js +102 -132
- package/dist-es/models/models_2.js +137 -193
- package/dist-es/models/models_3.js +205 -112
- package/dist-es/models/models_4.js +185 -49
- package/dist-es/models/models_5.js +50 -0
- package/dist-es/pagination/SearchTopicsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +1044 -12
- package/dist-types/QuickSight.d.ts +77 -0
- package/dist-types/QuickSightClient.d.ts +13 -2
- package/dist-types/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/CreateAnalysisCommand.d.ts +434 -5
- package/dist-types/commands/CreateBrandCommand.d.ts +1 -1
- package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/CreateDashboardCommand.d.ts +434 -5
- package/dist-types/commands/CreateTemplateCommand.d.ts +433 -4
- package/dist-types/commands/CreateTopicCommand.d.ts +3 -0
- package/dist-types/commands/DeleteDefaultQBusinessApplicationCommand.d.ts +91 -0
- package/dist-types/commands/DeleteIdentityPropagationConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisCommand.d.ts +79 -0
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +433 -4
- package/dist-types/commands/DescribeAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetBundleExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBrandCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBrandPublishedVersionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardCommand.d.ts +80 -1
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +434 -5
- package/dist-types/commands/DescribeDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardsQAConfigurationCommand.d.ts +94 -0
- package/dist-types/commands/DescribeDataSetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDefaultQBusinessApplicationCommand.d.ts +92 -0
- package/dist-types/commands/DescribeFolderCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIngestionCommand.d.ts +1 -2
- package/dist-types/commands/DescribeNamespaceCommand.d.ts +2 -0
- package/dist-types/commands/DescribeQuickSightQSearchConfigurationCommand.d.ts +94 -0
- package/dist-types/commands/DescribeTemplateCommand.d.ts +79 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +433 -4
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +162 -0
- package/dist-types/commands/ListIdentityPropagationConfigsCommand.d.ts +1 -1
- package/dist-types/commands/ListNamespacesCommand.d.ts +2 -0
- package/dist-types/commands/ListTopicReviewedAnswersCommand.d.ts +2 -1
- package/dist-types/commands/PredictQAResultsCommand.d.ts +139 -0
- package/dist-types/commands/SearchTopicsCommand.d.ts +111 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +433 -4
- package/dist-types/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +97 -0
- package/dist-types/commands/UpdateBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateBrandCommand.d.ts +2 -1
- package/dist-types/commands/UpdateBrandPublishedVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardCommand.d.ts +434 -5
- package/dist-types/commands/UpdateDashboardLinksCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardsQAConfigurationCommand.d.ts +95 -0
- package/dist-types/commands/UpdateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDefaultQBusinessApplicationCommand.d.ts +95 -0
- package/dist-types/commands/UpdateFolderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIdentityPropagationConfigCommand.d.ts +2 -2
- package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateKeyRegistrationCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQPersonalizationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQuickSightQSearchConfigurationCommand.d.ts +95 -0
- package/dist-types/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSPICECapacityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplateCommand.d.ts +434 -5
- package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemeCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTopicCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +487 -546
- package/dist-types/models/models_1.d.ts +1748 -1766
- package/dist-types/models/models_2.d.ts +4413 -4505
- package/dist-types/models/models_3.d.ts +4169 -4324
- package/dist-types/models/models_4.d.ts +3851 -3830
- package/dist-types/models/models_5.d.ts +2394 -0
- package/dist-types/pagination/SearchTopicsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +99 -0
- package/dist-types/ts3.4/QuickSight.d.ts +235 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +66 -0
- package/dist-types/ts3.4/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateAnalysisCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateBrandCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDefaultQBusinessApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAssetBundleExportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAssetBundleImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeBrandCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeBrandPublishedVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardDefinitionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardsQAConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeDataSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDefaultQBusinessApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeFolderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeFolderResolvedPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeGroupMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIngestionCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeQuickSightQSearchConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTopicReviewedAnswersCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/PredictQAResultsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/SearchTopicsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBrandCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateBrandPublishedVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardLinksCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardsQAConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateDataSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDefaultQBusinessApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateFolderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIdentityPropagationConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateKeyRegistrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQPersonalizationConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQuickSightQSearchConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSPICECapacityConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTemplateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateThemeAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateThemePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTopicCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserCustomPermissionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +142 -156
- package/dist-types/ts3.4/models/models_1.d.ts +324 -356
- package/dist-types/ts3.4/models/models_2.d.ts +428 -418
- package/dist-types/ts3.4/models/models_3.d.ts +453 -503
- package/dist-types/ts3.4/models/models_4.d.ts +1426 -1311
- package/dist-types/ts3.4/models/models_5.d.ts +596 -0
- package/dist-types/ts3.4/pagination/SearchTopicsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +132 -0
- package/package.json +4 -4
|
@@ -1,4 +1,330 @@
|
|
|
1
|
-
import { AggregationFunction, AxisBinding, AxisDisplayOptions, BarChartFieldWells, BarChartOrientation, BarsArrangement, ChartAxisLabelOptions, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, DataLabelOptions, DataLabelPosition, DimensionField, FontConfiguration, FormatConfiguration,
|
|
1
|
+
import { AggregationFunction, AxisBinding, AxisDisplayOptions, BarChartFieldWells, BarChartOrientation, BarsArrangement, ChartAxisLabelOptions, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, CustomActionFilterOperation, CustomActionNavigationOperation, CustomActionSetParametersOperation, CustomActionURLOperation, DataLabelOptions, DataLabelPosition, DimensionField, FontConfiguration, FormatConfiguration, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, PercentageDisplayFormatConfiguration, ReferenceLineCustomLabelConfiguration, ReferenceLineDataConfiguration, ReferenceLineLabelHorizontalPosition, ReferenceLineLabelVerticalPosition, ReferenceLineValueLabelConfiguration, SortDirection, TimeGranularity, Visibility, VisualCustomAction, VisualInteractionOptions, WidgetStatus } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* <p>The label configuration of a reference line.</p>
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface ReferenceLineLabelConfiguration {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The value label configuration of the label in a reference line.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
ValueLabelConfiguration?: ReferenceLineValueLabelConfiguration | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The custom label configuration of the label in a reference line.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
CustomLabelConfiguration?: ReferenceLineCustomLabelConfiguration | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* <p>The font configuration of the label in a reference line.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
FontConfiguration?: FontConfiguration | undefined;
|
|
22
|
+
/**
|
|
23
|
+
* <p>The font color configuration of the label in a reference line.</p>
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
FontColor?: string | undefined;
|
|
27
|
+
/**
|
|
28
|
+
* <p>The horizontal position configuration of the label in a reference line. Choose one of
|
|
29
|
+
* the following options:</p>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>
|
|
33
|
+
* <code>LEFT</code>
|
|
34
|
+
* </p>
|
|
35
|
+
* </li>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>
|
|
38
|
+
* <code>CENTER</code>
|
|
39
|
+
* </p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <code>RIGHT</code>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* </ul>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
HorizontalPosition?: ReferenceLineLabelHorizontalPosition | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>The vertical position configuration of the label in a reference line. Choose one of the following options:</p>
|
|
52
|
+
* <ul>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>
|
|
55
|
+
* <code>ABOVE</code>
|
|
56
|
+
* </p>
|
|
57
|
+
* </li>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>
|
|
60
|
+
* <code>BELOW</code>
|
|
61
|
+
* </p>
|
|
62
|
+
* </li>
|
|
63
|
+
* </ul>
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
VerticalPosition?: ReferenceLineLabelVerticalPosition | undefined;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* @public
|
|
70
|
+
* @enum
|
|
71
|
+
*/
|
|
72
|
+
export declare const ReferenceLinePatternType: {
|
|
73
|
+
readonly DASHED: "DASHED";
|
|
74
|
+
readonly DOTTED: "DOTTED";
|
|
75
|
+
readonly SOLID: "SOLID";
|
|
76
|
+
};
|
|
77
|
+
/**
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
export type ReferenceLinePatternType = (typeof ReferenceLinePatternType)[keyof typeof ReferenceLinePatternType];
|
|
81
|
+
/**
|
|
82
|
+
* <p>The style configuration of the reference
|
|
83
|
+
* line.</p>
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export interface ReferenceLineStyleConfiguration {
|
|
87
|
+
/**
|
|
88
|
+
* <p>The pattern type of the line style. Choose one of the following options:</p>
|
|
89
|
+
* <ul>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>
|
|
92
|
+
* <code>SOLID</code>
|
|
93
|
+
* </p>
|
|
94
|
+
* </li>
|
|
95
|
+
* <li>
|
|
96
|
+
* <p>
|
|
97
|
+
* <code>DASHED</code>
|
|
98
|
+
* </p>
|
|
99
|
+
* </li>
|
|
100
|
+
* <li>
|
|
101
|
+
* <p>
|
|
102
|
+
* <code>DOTTED</code>
|
|
103
|
+
* </p>
|
|
104
|
+
* </li>
|
|
105
|
+
* </ul>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
Pattern?: ReferenceLinePatternType | undefined;
|
|
109
|
+
/**
|
|
110
|
+
* <p>The hex color of the reference line.</p>
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
Color?: string | undefined;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* <p>The reference line visual display options.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export interface ReferenceLine {
|
|
120
|
+
/**
|
|
121
|
+
* <p>The status of the reference line. Choose one of the following options:</p>
|
|
122
|
+
* <ul>
|
|
123
|
+
* <li>
|
|
124
|
+
* <p>
|
|
125
|
+
* <code>ENABLE</code>
|
|
126
|
+
* </p>
|
|
127
|
+
* </li>
|
|
128
|
+
* <li>
|
|
129
|
+
* <p>
|
|
130
|
+
* <code>DISABLE</code>
|
|
131
|
+
* </p>
|
|
132
|
+
* </li>
|
|
133
|
+
* </ul>
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
Status?: WidgetStatus | undefined;
|
|
137
|
+
/**
|
|
138
|
+
* <p>The data configuration of the reference line.</p>
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
141
|
+
DataConfiguration: ReferenceLineDataConfiguration | undefined;
|
|
142
|
+
/**
|
|
143
|
+
* <p>The style configuration of the reference line.</p>
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
StyleConfiguration?: ReferenceLineStyleConfiguration | undefined;
|
|
147
|
+
/**
|
|
148
|
+
* <p>The label configuration of the reference line.</p>
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
LabelConfiguration?: ReferenceLineLabelConfiguration | undefined;
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
* @enum
|
|
156
|
+
*/
|
|
157
|
+
export declare const PanelBorderStyle: {
|
|
158
|
+
readonly DASHED: "DASHED";
|
|
159
|
+
readonly DOTTED: "DOTTED";
|
|
160
|
+
readonly SOLID: "SOLID";
|
|
161
|
+
};
|
|
162
|
+
/**
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
export type PanelBorderStyle = (typeof PanelBorderStyle)[keyof typeof PanelBorderStyle];
|
|
166
|
+
/**
|
|
167
|
+
* @public
|
|
168
|
+
* @enum
|
|
169
|
+
*/
|
|
170
|
+
export declare const HorizontalTextAlignment: {
|
|
171
|
+
readonly AUTO: "AUTO";
|
|
172
|
+
readonly CENTER: "CENTER";
|
|
173
|
+
readonly LEFT: "LEFT";
|
|
174
|
+
readonly RIGHT: "RIGHT";
|
|
175
|
+
};
|
|
176
|
+
/**
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
export type HorizontalTextAlignment = (typeof HorizontalTextAlignment)[keyof typeof HorizontalTextAlignment];
|
|
180
|
+
/**
|
|
181
|
+
* <p>The options that determine the title styles for each small multiples
|
|
182
|
+
* panel.</p>
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
export interface PanelTitleOptions {
|
|
186
|
+
/**
|
|
187
|
+
* <p>Determines whether or not panel titles are displayed.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
Visibility?: Visibility | undefined;
|
|
191
|
+
/**
|
|
192
|
+
* <p>Configures the display properties of the given text.</p>
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
FontConfiguration?: FontConfiguration | undefined;
|
|
196
|
+
/**
|
|
197
|
+
* <p>Sets the horizontal text alignment of the title within each panel.</p>
|
|
198
|
+
* @public
|
|
199
|
+
*/
|
|
200
|
+
HorizontalTextAlignment?: HorizontalTextAlignment | undefined;
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* <p>A collection of options that configure how each panel displays in a small multiples chart.</p>
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
export interface PanelConfiguration {
|
|
207
|
+
/**
|
|
208
|
+
* <p>Configures the title display within each small multiples panel.</p>
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
Title?: PanelTitleOptions | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* <p>Determines whether or not each panel displays a border.</p>
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
BorderVisibility?: Visibility | undefined;
|
|
217
|
+
/**
|
|
218
|
+
* <p>Sets the line thickness of panel borders.</p>
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
BorderThickness?: string | undefined;
|
|
222
|
+
/**
|
|
223
|
+
* <p>Sets the line style of panel borders.</p>
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
BorderStyle?: PanelBorderStyle | undefined;
|
|
227
|
+
/**
|
|
228
|
+
* <p>Sets the line color of panel borders.</p>
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
231
|
+
BorderColor?: string | undefined;
|
|
232
|
+
/**
|
|
233
|
+
* <p>Determines whether or not negative space between sibling panels is rendered.</p>
|
|
234
|
+
* @public
|
|
235
|
+
*/
|
|
236
|
+
GutterVisibility?: Visibility | undefined;
|
|
237
|
+
/**
|
|
238
|
+
* <p>Sets the total amount of negative space to display between sibling panels.</p>
|
|
239
|
+
* @public
|
|
240
|
+
*/
|
|
241
|
+
GutterSpacing?: string | undefined;
|
|
242
|
+
/**
|
|
243
|
+
* <p>Determines whether or not a background for each small multiples panel is rendered.</p>
|
|
244
|
+
* @public
|
|
245
|
+
*/
|
|
246
|
+
BackgroundVisibility?: Visibility | undefined;
|
|
247
|
+
/**
|
|
248
|
+
* <p>Sets the background color for each panel.</p>
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
BackgroundColor?: string | undefined;
|
|
252
|
+
}
|
|
253
|
+
/**
|
|
254
|
+
* @public
|
|
255
|
+
* @enum
|
|
256
|
+
*/
|
|
257
|
+
export declare const SmallMultiplesAxisPlacement: {
|
|
258
|
+
readonly INSIDE: "INSIDE";
|
|
259
|
+
readonly OUTSIDE: "OUTSIDE";
|
|
260
|
+
};
|
|
261
|
+
/**
|
|
262
|
+
* @public
|
|
263
|
+
*/
|
|
264
|
+
export type SmallMultiplesAxisPlacement = (typeof SmallMultiplesAxisPlacement)[keyof typeof SmallMultiplesAxisPlacement];
|
|
265
|
+
/**
|
|
266
|
+
* @public
|
|
267
|
+
* @enum
|
|
268
|
+
*/
|
|
269
|
+
export declare const SmallMultiplesAxisScale: {
|
|
270
|
+
readonly INDEPENDENT: "INDEPENDENT";
|
|
271
|
+
readonly SHARED: "SHARED";
|
|
272
|
+
};
|
|
273
|
+
/**
|
|
274
|
+
* @public
|
|
275
|
+
*/
|
|
276
|
+
export type SmallMultiplesAxisScale = (typeof SmallMultiplesAxisScale)[keyof typeof SmallMultiplesAxisScale];
|
|
277
|
+
/**
|
|
278
|
+
* <p>Configures the properties of a chart's axes that are used by small multiples panels.</p>
|
|
279
|
+
* @public
|
|
280
|
+
*/
|
|
281
|
+
export interface SmallMultiplesAxisProperties {
|
|
282
|
+
/**
|
|
283
|
+
* <p>Determines whether scale of the axes are shared or independent. The default value is <code>SHARED</code>.</p>
|
|
284
|
+
* @public
|
|
285
|
+
*/
|
|
286
|
+
Scale?: SmallMultiplesAxisScale | undefined;
|
|
287
|
+
/**
|
|
288
|
+
* <p>Defines the placement of the axis. By default, axes are rendered <code>OUTSIDE</code> of the panels. Axes with <code>INDEPENDENT</code> scale are rendered <code>INSIDE</code> the panels.</p>
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
291
|
+
Placement?: SmallMultiplesAxisPlacement | undefined;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* <p>Options that determine the layout and display options of a chart's small multiples.</p>
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
export interface SmallMultiplesOptions {
|
|
298
|
+
/**
|
|
299
|
+
* <p>Sets the maximum number of visible rows to display in the grid of small multiples panels.</p>
|
|
300
|
+
* <p>The default value is <code>Auto</code>,
|
|
301
|
+
* which automatically adjusts the rows in the grid
|
|
302
|
+
* to fit the overall layout and size of the given chart.</p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
MaxVisibleRows?: number | undefined;
|
|
306
|
+
/**
|
|
307
|
+
* <p>Sets the maximum number of visible columns to display in the grid of small multiples panels.</p>
|
|
308
|
+
* <p>The default is <code>Auto</code>, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.</p>
|
|
309
|
+
* @public
|
|
310
|
+
*/
|
|
311
|
+
MaxVisibleColumns?: number | undefined;
|
|
312
|
+
/**
|
|
313
|
+
* <p>Configures the display options for each small multiples panel.</p>
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
PanelConfiguration?: PanelConfiguration | undefined;
|
|
317
|
+
/**
|
|
318
|
+
* <p>The properties of a small multiples X axis.</p>
|
|
319
|
+
* @public
|
|
320
|
+
*/
|
|
321
|
+
XAxis?: SmallMultiplesAxisProperties | undefined;
|
|
322
|
+
/**
|
|
323
|
+
* <p>The properties of a small multiples Y axis.</p>
|
|
324
|
+
* @public
|
|
325
|
+
*/
|
|
326
|
+
YAxis?: SmallMultiplesAxisProperties | undefined;
|
|
327
|
+
}
|
|
2
328
|
/**
|
|
3
329
|
* @public
|
|
4
330
|
* @enum
|
|
@@ -780,6 +1106,11 @@ export interface BarChartVisual {
|
|
|
780
1106
|
* @public
|
|
781
1107
|
*/
|
|
782
1108
|
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
1109
|
+
/**
|
|
1110
|
+
* <p>The alt text for the visual.</p>
|
|
1111
|
+
* @public
|
|
1112
|
+
*/
|
|
1113
|
+
VisualContentAltText?: string | undefined;
|
|
783
1114
|
}
|
|
784
1115
|
/**
|
|
785
1116
|
* @public
|
|
@@ -987,6 +1318,11 @@ export interface BoxPlotVisual {
|
|
|
987
1318
|
* @public
|
|
988
1319
|
*/
|
|
989
1320
|
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
1321
|
+
/**
|
|
1322
|
+
* <p>The alt text for the visual.</p>
|
|
1323
|
+
* @public
|
|
1324
|
+
*/
|
|
1325
|
+
VisualContentAltText?: string | undefined;
|
|
990
1326
|
}
|
|
991
1327
|
/**
|
|
992
1328
|
* <p>The aggregated field wells of a combo chart.</p>
|
|
@@ -1235,6 +1571,11 @@ export interface ComboChartVisual {
|
|
|
1235
1571
|
* @public
|
|
1236
1572
|
*/
|
|
1237
1573
|
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
1574
|
+
/**
|
|
1575
|
+
* <p>The alt text for the visual.</p>
|
|
1576
|
+
* @public
|
|
1577
|
+
*/
|
|
1578
|
+
VisualContentAltText?: string | undefined;
|
|
1238
1579
|
}
|
|
1239
1580
|
/**
|
|
1240
1581
|
* @public
|
|
@@ -1324,6 +1665,11 @@ export interface CustomContentVisual {
|
|
|
1324
1665
|
* @public
|
|
1325
1666
|
*/
|
|
1326
1667
|
DataSetIdentifier: string | undefined;
|
|
1668
|
+
/**
|
|
1669
|
+
* <p>The alt text for the visual.</p>
|
|
1670
|
+
* @public
|
|
1671
|
+
*/
|
|
1672
|
+
VisualContentAltText?: string | undefined;
|
|
1327
1673
|
}
|
|
1328
1674
|
/**
|
|
1329
1675
|
* <p>An empty visual.</p>
|
|
@@ -1677,6 +2023,11 @@ export interface FilledMapVisual {
|
|
|
1677
2023
|
* @public
|
|
1678
2024
|
*/
|
|
1679
2025
|
Actions?: VisualCustomAction[] | undefined;
|
|
2026
|
+
/**
|
|
2027
|
+
* <p>The alt text for the visual.</p>
|
|
2028
|
+
* @public
|
|
2029
|
+
*/
|
|
2030
|
+
VisualContentAltText?: string | undefined;
|
|
1680
2031
|
}
|
|
1681
2032
|
/**
|
|
1682
2033
|
* @public
|
|
@@ -1861,6 +2212,11 @@ export interface FunnelChartVisual {
|
|
|
1861
2212
|
* @public
|
|
1862
2213
|
*/
|
|
1863
2214
|
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
2215
|
+
/**
|
|
2216
|
+
* <p>The alt text for the visual.</p>
|
|
2217
|
+
* @public
|
|
2218
|
+
*/
|
|
2219
|
+
VisualContentAltText?: string | undefined;
|
|
1864
2220
|
}
|
|
1865
2221
|
/**
|
|
1866
2222
|
* <p>The color configuration of a <code>GaugeChartVisual</code>.</p>
|
|
@@ -2346,6 +2702,11 @@ export interface GaugeChartVisual {
|
|
|
2346
2702
|
* @public
|
|
2347
2703
|
*/
|
|
2348
2704
|
Actions?: VisualCustomAction[] | undefined;
|
|
2705
|
+
/**
|
|
2706
|
+
* <p>The alt text for the visual.</p>
|
|
2707
|
+
* @public
|
|
2708
|
+
*/
|
|
2709
|
+
VisualContentAltText?: string | undefined;
|
|
2349
2710
|
}
|
|
2350
2711
|
/**
|
|
2351
2712
|
* <p>The aggregated field wells for a geospatial map.</p>
|
|
@@ -2563,6 +2924,11 @@ export interface GeospatialMapVisual {
|
|
|
2563
2924
|
* @public
|
|
2564
2925
|
*/
|
|
2565
2926
|
Actions?: VisualCustomAction[] | undefined;
|
|
2927
|
+
/**
|
|
2928
|
+
* <p>The alt text for the visual.</p>
|
|
2929
|
+
* @public
|
|
2930
|
+
*/
|
|
2931
|
+
VisualContentAltText?: string | undefined;
|
|
2566
2932
|
}
|
|
2567
2933
|
/**
|
|
2568
2934
|
* @public
|
|
@@ -2759,6 +3125,11 @@ export interface HeatMapVisual {
|
|
|
2759
3125
|
* @public
|
|
2760
3126
|
*/
|
|
2761
3127
|
Actions?: VisualCustomAction[] | undefined;
|
|
3128
|
+
/**
|
|
3129
|
+
* <p>The alt text for the visual.</p>
|
|
3130
|
+
* @public
|
|
3131
|
+
*/
|
|
3132
|
+
VisualContentAltText?: string | undefined;
|
|
2762
3133
|
}
|
|
2763
3134
|
/**
|
|
2764
3135
|
* <p>The options that determine the bin count of a histogram.</p>
|
|
@@ -2929,6 +3300,11 @@ export interface HistogramVisual {
|
|
|
2929
3300
|
* @public
|
|
2930
3301
|
*/
|
|
2931
3302
|
Actions?: VisualCustomAction[] | undefined;
|
|
3303
|
+
/**
|
|
3304
|
+
* <p>The alt text for the visual.</p>
|
|
3305
|
+
* @public
|
|
3306
|
+
*/
|
|
3307
|
+
VisualContentAltText?: string | undefined;
|
|
2932
3308
|
}
|
|
2933
3309
|
/**
|
|
2934
3310
|
* @public
|
|
@@ -3481,7 +3857,12 @@ export interface InsightVisual {
|
|
|
3481
3857
|
* @public
|
|
3482
3858
|
*/
|
|
3483
3859
|
DataSetIdentifier: string | undefined;
|
|
3484
|
-
|
|
3860
|
+
/**
|
|
3861
|
+
* <p>The alt text for the visual.</p>
|
|
3862
|
+
* @public
|
|
3863
|
+
*/
|
|
3864
|
+
VisualContentAltText?: string | undefined;
|
|
3865
|
+
}
|
|
3485
3866
|
/**
|
|
3486
3867
|
* <p>The field well configuration of a KPI visual.</p>
|
|
3487
3868
|
* @public
|
|
@@ -3833,1796 +4214,1308 @@ export interface KPIVisual {
|
|
|
3833
4214
|
* @public
|
|
3834
4215
|
*/
|
|
3835
4216
|
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
4217
|
+
/**
|
|
4218
|
+
* <p>The alt text for the visual.</p>
|
|
4219
|
+
* @public
|
|
4220
|
+
*/
|
|
4221
|
+
VisualContentAltText?: string | undefined;
|
|
3836
4222
|
}
|
|
3837
4223
|
/**
|
|
3838
|
-
*
|
|
3839
|
-
*
|
|
3840
|
-
*/
|
|
3841
|
-
export declare const LineInterpolation: {
|
|
3842
|
-
readonly LINEAR: "LINEAR";
|
|
3843
|
-
readonly SMOOTH: "SMOOTH";
|
|
3844
|
-
readonly STEPPED: "STEPPED";
|
|
3845
|
-
};
|
|
3846
|
-
/**
|
|
4224
|
+
* <p>The operation that is defined by the custom action.</p>
|
|
4225
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
3847
4226
|
* @public
|
|
3848
4227
|
*/
|
|
3849
|
-
export
|
|
4228
|
+
export interface LayerCustomActionOperation {
|
|
4229
|
+
/**
|
|
4230
|
+
* <p>The filter operation that filters data included in a visual or in an entire sheet.</p>
|
|
4231
|
+
* @public
|
|
4232
|
+
*/
|
|
4233
|
+
FilterOperation?: CustomActionFilterOperation | undefined;
|
|
4234
|
+
/**
|
|
4235
|
+
* <p>The navigation operation that navigates between different sheets in the same analysis.</p>
|
|
4236
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
4237
|
+
* @public
|
|
4238
|
+
*/
|
|
4239
|
+
NavigationOperation?: CustomActionNavigationOperation | undefined;
|
|
4240
|
+
/**
|
|
4241
|
+
* <p>The URL operation that opens a link to another webpage.</p>
|
|
4242
|
+
* @public
|
|
4243
|
+
*/
|
|
4244
|
+
URLOperation?: CustomActionURLOperation | undefined;
|
|
4245
|
+
/**
|
|
4246
|
+
* <p>The set parameter operation that sets parameters in custom action.</p>
|
|
4247
|
+
* @public
|
|
4248
|
+
*/
|
|
4249
|
+
SetParametersOperation?: CustomActionSetParametersOperation | undefined;
|
|
4250
|
+
}
|
|
3850
4251
|
/**
|
|
3851
4252
|
* @public
|
|
3852
4253
|
* @enum
|
|
3853
4254
|
*/
|
|
3854
|
-
export declare const
|
|
3855
|
-
readonly
|
|
3856
|
-
readonly
|
|
3857
|
-
readonly SOLID: "SOLID";
|
|
4255
|
+
export declare const LayerCustomActionTrigger: {
|
|
4256
|
+
readonly DATA_POINT_CLICK: "DATA_POINT_CLICK";
|
|
4257
|
+
readonly DATA_POINT_MENU: "DATA_POINT_MENU";
|
|
3858
4258
|
};
|
|
3859
4259
|
/**
|
|
3860
4260
|
* @public
|
|
3861
4261
|
*/
|
|
3862
|
-
export type
|
|
4262
|
+
export type LayerCustomActionTrigger = (typeof LayerCustomActionTrigger)[keyof typeof LayerCustomActionTrigger];
|
|
3863
4263
|
/**
|
|
3864
|
-
* <p>
|
|
4264
|
+
* <p>A layer custom action.</p>
|
|
3865
4265
|
* @public
|
|
3866
4266
|
*/
|
|
3867
|
-
export interface
|
|
4267
|
+
export interface LayerCustomAction {
|
|
3868
4268
|
/**
|
|
3869
|
-
* <p>
|
|
4269
|
+
* <p>The ID of the custom action.</p>
|
|
3870
4270
|
* @public
|
|
3871
4271
|
*/
|
|
3872
|
-
|
|
4272
|
+
CustomActionId: string | undefined;
|
|
3873
4273
|
/**
|
|
3874
|
-
* <p>
|
|
3875
|
-
* <ul>
|
|
3876
|
-
* <li>
|
|
3877
|
-
* <p>
|
|
3878
|
-
* <code>LINEAR</code>: Show as default, linear style.</p>
|
|
3879
|
-
* </li>
|
|
3880
|
-
* <li>
|
|
3881
|
-
* <p>
|
|
3882
|
-
* <code>SMOOTH</code>: Show as a smooth curve.</p>
|
|
3883
|
-
* </li>
|
|
3884
|
-
* <li>
|
|
3885
|
-
* <p>
|
|
3886
|
-
* <code>STEPPED</code>: Show steps in line.</p>
|
|
3887
|
-
* </li>
|
|
3888
|
-
* </ul>
|
|
4274
|
+
* <p>The name of the custom action.</p>
|
|
3889
4275
|
* @public
|
|
3890
4276
|
*/
|
|
3891
|
-
|
|
4277
|
+
Name: string | undefined;
|
|
3892
4278
|
/**
|
|
3893
|
-
* <p>
|
|
4279
|
+
* <p>The status of the <code>LayerCustomAction</code>.</p>
|
|
4280
|
+
* @public
|
|
4281
|
+
*/
|
|
4282
|
+
Status?: WidgetStatus | undefined;
|
|
4283
|
+
/**
|
|
4284
|
+
* <p>The trigger of the <code>LayerCustomAction</code>.</p>
|
|
4285
|
+
* <p>Valid values are defined as follows:</p>
|
|
3894
4286
|
* <ul>
|
|
3895
4287
|
* <li>
|
|
3896
4288
|
* <p>
|
|
3897
|
-
* <code>
|
|
3898
|
-
* </li>
|
|
3899
|
-
* <li>
|
|
3900
|
-
* <p>
|
|
3901
|
-
* <code>DOTTED</code>: Show as a dotted line.</p>
|
|
4289
|
+
* <code>DATA_POINT_CLICK</code>: Initiates a custom action by a left pointer click on a data point.</p>
|
|
3902
4290
|
* </li>
|
|
3903
4291
|
* <li>
|
|
3904
4292
|
* <p>
|
|
3905
|
-
* <code>
|
|
4293
|
+
* <code>DATA_POINT_MENU</code>: Initiates a custom action by right pointer click from the menu.</p>
|
|
3906
4294
|
* </li>
|
|
3907
4295
|
* </ul>
|
|
3908
4296
|
* @public
|
|
3909
4297
|
*/
|
|
3910
|
-
|
|
4298
|
+
Trigger: LayerCustomActionTrigger | undefined;
|
|
3911
4299
|
/**
|
|
3912
|
-
* <p>
|
|
4300
|
+
* <p>A list of <code>LayerCustomActionOperations</code>.</p>
|
|
4301
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
3913
4302
|
* @public
|
|
3914
4303
|
*/
|
|
3915
|
-
|
|
4304
|
+
ActionOperations: LayerCustomActionOperation[] | undefined;
|
|
3916
4305
|
}
|
|
3917
4306
|
/**
|
|
4307
|
+
* <p>The source properties for a geospatial static file.</p>
|
|
3918
4308
|
* @public
|
|
3919
|
-
* @enum
|
|
3920
4309
|
*/
|
|
3921
|
-
export
|
|
3922
|
-
|
|
3923
|
-
|
|
3924
|
-
|
|
3925
|
-
|
|
3926
|
-
|
|
3927
|
-
}
|
|
4310
|
+
export interface GeospatialStaticFileSource {
|
|
4311
|
+
/**
|
|
4312
|
+
* <p>The ID of the static file.</p>
|
|
4313
|
+
* @public
|
|
4314
|
+
*/
|
|
4315
|
+
StaticFileId: string | undefined;
|
|
4316
|
+
}
|
|
3928
4317
|
/**
|
|
4318
|
+
* <p>The data source properties for the geospatial data.</p>
|
|
3929
4319
|
* @public
|
|
3930
4320
|
*/
|
|
3931
|
-
export
|
|
4321
|
+
export interface GeospatialDataSourceItem {
|
|
4322
|
+
/**
|
|
4323
|
+
* <p>The static file data source properties for the geospatial data.</p>
|
|
4324
|
+
* @public
|
|
4325
|
+
*/
|
|
4326
|
+
StaticFileDataSource?: GeospatialStaticFileSource | undefined;
|
|
4327
|
+
}
|
|
3932
4328
|
/**
|
|
3933
|
-
* <p>
|
|
4329
|
+
* <p>The color field that defines a gradient or categorical style.</p>
|
|
3934
4330
|
* @public
|
|
3935
4331
|
*/
|
|
3936
|
-
export interface
|
|
4332
|
+
export interface GeospatialLayerColorField {
|
|
3937
4333
|
/**
|
|
3938
|
-
* <p>
|
|
4334
|
+
* <p>A list of color dimension fields.</p>
|
|
3939
4335
|
* @public
|
|
3940
4336
|
*/
|
|
3941
|
-
|
|
4337
|
+
ColorDimensionsFields?: DimensionField[] | undefined;
|
|
3942
4338
|
/**
|
|
3943
|
-
* <p>
|
|
3944
|
-
* <ul>
|
|
3945
|
-
* <li>
|
|
3946
|
-
* <p>
|
|
3947
|
-
* <code>CIRCLE</code>: Show marker as a circle.</p>
|
|
3948
|
-
* </li>
|
|
3949
|
-
* <li>
|
|
3950
|
-
* <p>
|
|
3951
|
-
* <code>TRIANGLE</code>: Show marker as a triangle.</p>
|
|
3952
|
-
* </li>
|
|
3953
|
-
* <li>
|
|
3954
|
-
* <p>
|
|
3955
|
-
* <code>SQUARE</code>: Show marker as a square.</p>
|
|
3956
|
-
* </li>
|
|
3957
|
-
* <li>
|
|
3958
|
-
* <p>
|
|
3959
|
-
* <code>DIAMOND</code>: Show marker as a diamond.</p>
|
|
3960
|
-
* </li>
|
|
3961
|
-
* <li>
|
|
3962
|
-
* <p>
|
|
3963
|
-
* <code>ROUNDED_SQUARE</code>: Show marker as a rounded square.</p>
|
|
3964
|
-
* </li>
|
|
3965
|
-
* </ul>
|
|
4339
|
+
* <p>A list of color measure fields.</p>
|
|
3966
4340
|
* @public
|
|
3967
4341
|
*/
|
|
3968
|
-
|
|
4342
|
+
ColorValuesFields?: MeasureField[] | undefined;
|
|
4343
|
+
}
|
|
4344
|
+
/**
|
|
4345
|
+
* <p>The unaggregated field for a table.</p>
|
|
4346
|
+
* @public
|
|
4347
|
+
*/
|
|
4348
|
+
export interface UnaggregatedField {
|
|
3969
4349
|
/**
|
|
3970
|
-
* <p>
|
|
4350
|
+
* <p>The custom field ID.</p>
|
|
3971
4351
|
* @public
|
|
3972
4352
|
*/
|
|
3973
|
-
|
|
4353
|
+
FieldId: string | undefined;
|
|
3974
4354
|
/**
|
|
3975
|
-
* <p>
|
|
4355
|
+
* <p>The column that is used in the <code>UnaggregatedField</code>.</p>
|
|
3976
4356
|
* @public
|
|
3977
4357
|
*/
|
|
3978
|
-
|
|
4358
|
+
Column: ColumnIdentifier | undefined;
|
|
4359
|
+
/**
|
|
4360
|
+
* <p>The format configuration of the field.</p>
|
|
4361
|
+
* @public
|
|
4362
|
+
*/
|
|
4363
|
+
FormatConfiguration?: FormatConfiguration | undefined;
|
|
3979
4364
|
}
|
|
3980
4365
|
/**
|
|
3981
|
-
* <p>The
|
|
4366
|
+
* <p>The custom actions for a layer.</p>
|
|
3982
4367
|
* @public
|
|
3983
4368
|
*/
|
|
3984
|
-
export interface
|
|
4369
|
+
export interface GeospatialLayerJoinDefinition {
|
|
3985
4370
|
/**
|
|
3986
|
-
* <p>The
|
|
4371
|
+
* <p>The name of the field or property in the geospatial data source.</p>
|
|
3987
4372
|
* @public
|
|
3988
4373
|
*/
|
|
3989
|
-
|
|
4374
|
+
ShapeKeyField?: string | undefined;
|
|
3990
4375
|
/**
|
|
3991
|
-
* <p>
|
|
4376
|
+
* <p>The unaggregated field for a table.</p>
|
|
3992
4377
|
* @public
|
|
3993
4378
|
*/
|
|
3994
|
-
|
|
4379
|
+
DatasetKeyField?: UnaggregatedField | undefined;
|
|
3995
4380
|
/**
|
|
3996
|
-
* <p>
|
|
4381
|
+
* <p>The geospatial color field for the join definition.</p>
|
|
3997
4382
|
* @public
|
|
3998
4383
|
*/
|
|
3999
|
-
|
|
4384
|
+
ColorField?: GeospatialLayerColorField | undefined;
|
|
4000
4385
|
}
|
|
4001
4386
|
/**
|
|
4002
|
-
* <p>The
|
|
4387
|
+
* <p>The categorical data color for a single category.</p>
|
|
4003
4388
|
* @public
|
|
4004
4389
|
*/
|
|
4005
|
-
export interface
|
|
4390
|
+
export interface GeospatialCategoricalDataColor {
|
|
4006
4391
|
/**
|
|
4007
|
-
* <p>The
|
|
4392
|
+
* <p>The color and opacity values for the category data color.</p>
|
|
4008
4393
|
* @public
|
|
4009
4394
|
*/
|
|
4010
|
-
|
|
4395
|
+
Color: string | undefined;
|
|
4011
4396
|
/**
|
|
4012
|
-
* <p>The value
|
|
4397
|
+
* <p>The data value for the category data color.</p>
|
|
4013
4398
|
* @public
|
|
4014
4399
|
*/
|
|
4015
|
-
|
|
4400
|
+
DataValue: string | undefined;
|
|
4401
|
+
}
|
|
4402
|
+
/**
|
|
4403
|
+
* <p>The symbol style for null data.</p>
|
|
4404
|
+
* @public
|
|
4405
|
+
*/
|
|
4406
|
+
export interface GeospatialNullSymbolStyle {
|
|
4016
4407
|
/**
|
|
4017
|
-
* <p>The color
|
|
4408
|
+
* <p>The color and opacity values for the fill color.</p>
|
|
4018
4409
|
* @public
|
|
4019
4410
|
*/
|
|
4020
|
-
|
|
4411
|
+
FillColor?: string | undefined;
|
|
4021
4412
|
/**
|
|
4022
|
-
* <p>The
|
|
4413
|
+
* <p>The color and opacity values for the stroke color.</p>
|
|
4023
4414
|
* @public
|
|
4024
4415
|
*/
|
|
4025
|
-
|
|
4416
|
+
StrokeColor?: string | undefined;
|
|
4417
|
+
/**
|
|
4418
|
+
* <p>The width of the border stroke.</p>
|
|
4419
|
+
* @public
|
|
4420
|
+
*/
|
|
4421
|
+
StrokeWidth?: number | undefined;
|
|
4026
4422
|
}
|
|
4027
4423
|
/**
|
|
4028
|
-
* <p>The
|
|
4424
|
+
* <p>The properties for the visualization of null data.</p>
|
|
4029
4425
|
* @public
|
|
4030
4426
|
*/
|
|
4031
|
-
export interface
|
|
4427
|
+
export interface GeospatialNullDataSettings {
|
|
4032
4428
|
/**
|
|
4033
|
-
* <p>The
|
|
4429
|
+
* <p>The symbol style for null data.</p>
|
|
4034
4430
|
* @public
|
|
4035
4431
|
*/
|
|
4036
|
-
|
|
4432
|
+
SymbolStyle: GeospatialNullSymbolStyle | undefined;
|
|
4037
4433
|
}
|
|
4038
4434
|
/**
|
|
4039
|
-
* <p>The
|
|
4435
|
+
* <p>The definition for a categorical color.</p>
|
|
4040
4436
|
* @public
|
|
4041
4437
|
*/
|
|
4042
|
-
export interface
|
|
4043
|
-
/**
|
|
4044
|
-
* <p>The periods forward setup of a forecast computation.</p>
|
|
4045
|
-
* @public
|
|
4046
|
-
*/
|
|
4047
|
-
PeriodsForward?: number | undefined;
|
|
4048
|
-
/**
|
|
4049
|
-
* <p>The periods backward setup of a forecast computation.</p>
|
|
4050
|
-
* @public
|
|
4051
|
-
*/
|
|
4052
|
-
PeriodsBackward?: number | undefined;
|
|
4438
|
+
export interface GeospatialCategoricalColor {
|
|
4053
4439
|
/**
|
|
4054
|
-
* <p>
|
|
4440
|
+
* <p>A list of categorical data colors for each category.</p>
|
|
4055
4441
|
* @public
|
|
4056
4442
|
*/
|
|
4057
|
-
|
|
4443
|
+
CategoryDataColors: GeospatialCategoricalDataColor[] | undefined;
|
|
4058
4444
|
/**
|
|
4059
|
-
* <p>The
|
|
4445
|
+
* <p>The state of visibility for null data.</p>
|
|
4060
4446
|
* @public
|
|
4061
4447
|
*/
|
|
4062
|
-
|
|
4448
|
+
NullDataVisibility?: Visibility | undefined;
|
|
4063
4449
|
/**
|
|
4064
|
-
* <p>The
|
|
4450
|
+
* <p>The null data visualization settings.</p>
|
|
4065
4451
|
* @public
|
|
4066
4452
|
*/
|
|
4067
|
-
|
|
4453
|
+
NullDataSettings?: GeospatialNullDataSettings | undefined;
|
|
4068
4454
|
/**
|
|
4069
|
-
* <p>The
|
|
4070
|
-
* <ul>
|
|
4071
|
-
* <li>
|
|
4072
|
-
* <p>
|
|
4073
|
-
* <code>NULL</code>: The input is set to <code>NULL</code>.</p>
|
|
4074
|
-
* </li>
|
|
4075
|
-
* <li>
|
|
4076
|
-
* <p>
|
|
4077
|
-
* <code>NON_NULL</code>: The input is set to a custom value.</p>
|
|
4078
|
-
* </li>
|
|
4079
|
-
* </ul>
|
|
4455
|
+
* <p>The default opacity of a categorical color.</p>
|
|
4080
4456
|
* @public
|
|
4081
4457
|
*/
|
|
4082
|
-
|
|
4458
|
+
DefaultOpacity?: number | undefined;
|
|
4083
4459
|
}
|
|
4084
4460
|
/**
|
|
4085
|
-
* <p>
|
|
4461
|
+
* <p>The gradient step color for a single step.</p>
|
|
4086
4462
|
* @public
|
|
4087
4463
|
*/
|
|
4088
|
-
export interface
|
|
4464
|
+
export interface GeospatialGradientStepColor {
|
|
4089
4465
|
/**
|
|
4090
|
-
* <p>The
|
|
4466
|
+
* <p>The color and opacity values for the gradient step color.</p>
|
|
4091
4467
|
* @public
|
|
4092
4468
|
*/
|
|
4093
|
-
|
|
4469
|
+
Color: string | undefined;
|
|
4094
4470
|
/**
|
|
4095
|
-
* <p>The
|
|
4471
|
+
* <p>The data value for the gradient step color.</p>
|
|
4096
4472
|
* @public
|
|
4097
4473
|
*/
|
|
4098
|
-
|
|
4474
|
+
DataValue: number | undefined;
|
|
4099
4475
|
}
|
|
4100
4476
|
/**
|
|
4101
|
-
* <p>
|
|
4477
|
+
* <p>The definition for a gradient color.</p>
|
|
4102
4478
|
* @public
|
|
4103
4479
|
*/
|
|
4104
|
-
export interface
|
|
4480
|
+
export interface GeospatialGradientColor {
|
|
4105
4481
|
/**
|
|
4106
|
-
* <p>
|
|
4482
|
+
* <p>A list of gradient step colors for the gradient.</p>
|
|
4107
4483
|
* @public
|
|
4108
4484
|
*/
|
|
4109
|
-
|
|
4485
|
+
StepColors: GeospatialGradientStepColor[] | undefined;
|
|
4110
4486
|
/**
|
|
4111
|
-
* <p>The
|
|
4487
|
+
* <p>The state of visibility for null data.</p>
|
|
4112
4488
|
* @public
|
|
4113
4489
|
*/
|
|
4114
|
-
|
|
4490
|
+
NullDataVisibility?: Visibility | undefined;
|
|
4115
4491
|
/**
|
|
4116
|
-
* <p>The
|
|
4492
|
+
* <p>The null data visualization settings.</p>
|
|
4117
4493
|
* @public
|
|
4118
4494
|
*/
|
|
4119
|
-
|
|
4495
|
+
NullDataSettings?: GeospatialNullDataSettings | undefined;
|
|
4496
|
+
/**
|
|
4497
|
+
* <p>The default opacity for the gradient color.</p>
|
|
4498
|
+
* @public
|
|
4499
|
+
*/
|
|
4500
|
+
DefaultOpacity?: number | undefined;
|
|
4120
4501
|
}
|
|
4121
4502
|
/**
|
|
4122
|
-
* <p>The forecast scenario of a forecast in the line chart.</p>
|
|
4123
4503
|
* @public
|
|
4504
|
+
* @enum
|
|
4124
4505
|
*/
|
|
4125
|
-
export
|
|
4506
|
+
export declare const GeospatialColorState: {
|
|
4507
|
+
readonly DISABLED: "DISABLED";
|
|
4508
|
+
readonly ENABLED: "ENABLED";
|
|
4509
|
+
};
|
|
4510
|
+
/**
|
|
4511
|
+
* @public
|
|
4512
|
+
*/
|
|
4513
|
+
export type GeospatialColorState = (typeof GeospatialColorState)[keyof typeof GeospatialColorState];
|
|
4514
|
+
/**
|
|
4515
|
+
* <p>The definition for a solid color.</p>
|
|
4516
|
+
* @public
|
|
4517
|
+
*/
|
|
4518
|
+
export interface GeospatialSolidColor {
|
|
4126
4519
|
/**
|
|
4127
|
-
* <p>The
|
|
4520
|
+
* <p>The color and opacity values for the color.</p>
|
|
4128
4521
|
* @public
|
|
4129
4522
|
*/
|
|
4130
|
-
|
|
4523
|
+
Color: string | undefined;
|
|
4131
4524
|
/**
|
|
4132
|
-
* <p>
|
|
4525
|
+
* <p>Enables and disables the view state of the color.</p>
|
|
4133
4526
|
* @public
|
|
4134
4527
|
*/
|
|
4135
|
-
|
|
4528
|
+
State?: GeospatialColorState | undefined;
|
|
4136
4529
|
}
|
|
4137
4530
|
/**
|
|
4138
|
-
* <p>The
|
|
4531
|
+
* <p>The visualization properties for solid, gradient, and categorical colors.</p>
|
|
4139
4532
|
* @public
|
|
4140
4533
|
*/
|
|
4141
|
-
export interface
|
|
4534
|
+
export interface GeospatialColor {
|
|
4142
4535
|
/**
|
|
4143
|
-
* <p>The
|
|
4144
|
-
* chart.</p>
|
|
4536
|
+
* <p>The visualization properties for the solid color.</p>
|
|
4145
4537
|
* @public
|
|
4146
4538
|
*/
|
|
4147
|
-
|
|
4539
|
+
Solid?: GeospatialSolidColor | undefined;
|
|
4148
4540
|
/**
|
|
4149
|
-
* <p>The
|
|
4541
|
+
* <p>The visualization properties for the gradient color.</p>
|
|
4150
4542
|
* @public
|
|
4151
4543
|
*/
|
|
4152
|
-
|
|
4544
|
+
Gradient?: GeospatialGradientColor | undefined;
|
|
4545
|
+
/**
|
|
4546
|
+
* <p>The visualization properties for the categorical color.</p>
|
|
4547
|
+
* @public
|
|
4548
|
+
*/
|
|
4549
|
+
Categorical?: GeospatialCategoricalColor | undefined;
|
|
4153
4550
|
}
|
|
4154
4551
|
/**
|
|
4552
|
+
* <p>The width properties for a line.</p>
|
|
4155
4553
|
* @public
|
|
4156
|
-
* @enum
|
|
4157
4554
|
*/
|
|
4158
|
-
export
|
|
4159
|
-
|
|
4160
|
-
|
|
4161
|
-
|
|
4162
|
-
|
|
4555
|
+
export interface GeospatialLineWidth {
|
|
4556
|
+
/**
|
|
4557
|
+
* <p>The positive value for the width of a line.</p>
|
|
4558
|
+
* @public
|
|
4559
|
+
*/
|
|
4560
|
+
LineWidth?: number | undefined;
|
|
4561
|
+
}
|
|
4163
4562
|
/**
|
|
4563
|
+
* <p>The symbol style for a line layer.</p>
|
|
4164
4564
|
* @public
|
|
4165
4565
|
*/
|
|
4166
|
-
export
|
|
4566
|
+
export interface GeospatialLineSymbolStyle {
|
|
4567
|
+
/**
|
|
4568
|
+
* <p>The color and opacity values for the fill color.</p>
|
|
4569
|
+
* @public
|
|
4570
|
+
*/
|
|
4571
|
+
FillColor?: GeospatialColor | undefined;
|
|
4572
|
+
/**
|
|
4573
|
+
* <p>The width value for a line.</p>
|
|
4574
|
+
* @public
|
|
4575
|
+
*/
|
|
4576
|
+
LineWidth?: GeospatialLineWidth | undefined;
|
|
4577
|
+
}
|
|
4167
4578
|
/**
|
|
4168
|
-
* <p>The
|
|
4579
|
+
* <p>The visualization style for a line layer.</p>
|
|
4169
4580
|
* @public
|
|
4170
4581
|
*/
|
|
4171
|
-
export interface
|
|
4582
|
+
export interface GeospatialLineStyle {
|
|
4172
4583
|
/**
|
|
4173
|
-
* <p>The
|
|
4174
|
-
* from the following options:</p>
|
|
4175
|
-
* <ul>
|
|
4176
|
-
* <li>
|
|
4177
|
-
* <p>
|
|
4178
|
-
* <code>INTERPOLATE</code>: Interpolate missing values between the prior and the next known value.</p>
|
|
4179
|
-
* </li>
|
|
4180
|
-
* <li>
|
|
4181
|
-
* <p>
|
|
4182
|
-
* <code>SHOW_AS_ZERO</code>: Show missing values as the value <code>0</code>.</p>
|
|
4183
|
-
* </li>
|
|
4184
|
-
* <li>
|
|
4185
|
-
* <p>
|
|
4186
|
-
* <code>SHOW_AS_BLANK</code>: Display a blank space when rendering missing data.</p>
|
|
4187
|
-
* </li>
|
|
4188
|
-
* </ul>
|
|
4584
|
+
* <p>The symbol style for a line style.</p>
|
|
4189
4585
|
* @public
|
|
4190
4586
|
*/
|
|
4191
|
-
|
|
4587
|
+
LineSymbolStyle?: GeospatialLineSymbolStyle | undefined;
|
|
4192
4588
|
}
|
|
4193
4589
|
/**
|
|
4194
|
-
* <p>The
|
|
4590
|
+
* <p>The geospatial Line layer.</p>
|
|
4195
4591
|
* @public
|
|
4196
4592
|
*/
|
|
4197
|
-
export interface
|
|
4198
|
-
/**
|
|
4199
|
-
* <p>The options that determine the presentation of the line series axis.</p>
|
|
4200
|
-
* @public
|
|
4201
|
-
*/
|
|
4202
|
-
AxisOptions?: AxisDisplayOptions | undefined;
|
|
4593
|
+
export interface GeospatialLineLayer {
|
|
4203
4594
|
/**
|
|
4204
|
-
* <p>The
|
|
4595
|
+
* <p>The visualization style for a line layer.</p>
|
|
4205
4596
|
* @public
|
|
4206
4597
|
*/
|
|
4207
|
-
|
|
4598
|
+
Style: GeospatialLineStyle | undefined;
|
|
4208
4599
|
}
|
|
4209
4600
|
/**
|
|
4210
|
-
* <p>The
|
|
4601
|
+
* <p>The geospatial radius for a circle.</p>
|
|
4211
4602
|
* @public
|
|
4212
4603
|
*/
|
|
4213
|
-
export interface
|
|
4214
|
-
/**
|
|
4215
|
-
* <p>Line styles options for a line series in <code>LineChartVisual</code>.</p>
|
|
4216
|
-
* @public
|
|
4217
|
-
*/
|
|
4218
|
-
LineStyleSettings?: LineChartLineStyleSettings | undefined;
|
|
4604
|
+
export interface GeospatialCircleRadius {
|
|
4219
4605
|
/**
|
|
4220
|
-
* <p>
|
|
4606
|
+
* <p>The positive value for the radius of a circle.</p>
|
|
4221
4607
|
* @public
|
|
4222
4608
|
*/
|
|
4223
|
-
|
|
4609
|
+
Radius?: number | undefined;
|
|
4224
4610
|
}
|
|
4225
4611
|
/**
|
|
4226
|
-
* <p>The
|
|
4612
|
+
* <p>The properties for a circle symbol style.</p>
|
|
4227
4613
|
* @public
|
|
4228
4614
|
*/
|
|
4229
|
-
export interface
|
|
4615
|
+
export interface GeospatialCircleSymbolStyle {
|
|
4230
4616
|
/**
|
|
4231
|
-
* <p>The
|
|
4617
|
+
* <p>The color and opacity values for the fill color.</p>
|
|
4232
4618
|
* @public
|
|
4233
4619
|
*/
|
|
4234
|
-
|
|
4620
|
+
FillColor?: GeospatialColor | undefined;
|
|
4235
4621
|
/**
|
|
4236
|
-
* <p>The
|
|
4622
|
+
* <p>The color and opacity values for the stroke color.</p>
|
|
4237
4623
|
* @public
|
|
4238
4624
|
*/
|
|
4239
|
-
|
|
4625
|
+
StrokeColor?: GeospatialColor | undefined;
|
|
4240
4626
|
/**
|
|
4241
|
-
* <p>The
|
|
4627
|
+
* <p>The width of the stroke (border).</p>
|
|
4242
4628
|
* @public
|
|
4243
4629
|
*/
|
|
4244
|
-
|
|
4630
|
+
StrokeWidth?: GeospatialLineWidth | undefined;
|
|
4245
4631
|
/**
|
|
4246
|
-
* <p>The
|
|
4632
|
+
* <p>The radius of the circle.</p>
|
|
4247
4633
|
* @public
|
|
4248
4634
|
*/
|
|
4249
|
-
|
|
4635
|
+
CircleRadius?: GeospatialCircleRadius | undefined;
|
|
4250
4636
|
}
|
|
4251
4637
|
/**
|
|
4252
|
-
* <p>The
|
|
4638
|
+
* <p>The point style for a point layer.</p>
|
|
4253
4639
|
* @public
|
|
4254
4640
|
*/
|
|
4255
|
-
export interface
|
|
4641
|
+
export interface GeospatialPointStyle {
|
|
4256
4642
|
/**
|
|
4257
|
-
* <p>The
|
|
4258
|
-
* @public
|
|
4259
|
-
*/
|
|
4260
|
-
FieldId: string | undefined;
|
|
4261
|
-
/**
|
|
4262
|
-
* <p>The axis that you are binding the field to.</p>
|
|
4643
|
+
* <p>The circle symbol style for a point layer.</p>
|
|
4263
4644
|
* @public
|
|
4264
4645
|
*/
|
|
4265
|
-
|
|
4646
|
+
CircleSymbolStyle?: GeospatialCircleSymbolStyle | undefined;
|
|
4647
|
+
}
|
|
4648
|
+
/**
|
|
4649
|
+
* <p>The geospatial Point layer.</p>
|
|
4650
|
+
* @public
|
|
4651
|
+
*/
|
|
4652
|
+
export interface GeospatialPointLayer {
|
|
4266
4653
|
/**
|
|
4267
|
-
* <p>The
|
|
4654
|
+
* <p>The visualization style for a point layer.</p>
|
|
4268
4655
|
* @public
|
|
4269
4656
|
*/
|
|
4270
|
-
|
|
4657
|
+
Style: GeospatialPointStyle | undefined;
|
|
4271
4658
|
}
|
|
4272
4659
|
/**
|
|
4273
|
-
* <p>The
|
|
4274
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
4660
|
+
* <p>The polygon symbol style for a polygon layer.</p>
|
|
4275
4661
|
* @public
|
|
4276
4662
|
*/
|
|
4277
|
-
export interface
|
|
4663
|
+
export interface GeospatialPolygonSymbolStyle {
|
|
4278
4664
|
/**
|
|
4279
|
-
* <p>The
|
|
4665
|
+
* <p>The color and opacity values for the fill color.</p>
|
|
4280
4666
|
* @public
|
|
4281
4667
|
*/
|
|
4282
|
-
|
|
4668
|
+
FillColor?: GeospatialColor | undefined;
|
|
4283
4669
|
/**
|
|
4284
|
-
* <p>The
|
|
4670
|
+
* <p>The color and opacity values for the stroke color.</p>
|
|
4285
4671
|
* @public
|
|
4286
4672
|
*/
|
|
4287
|
-
|
|
4673
|
+
StrokeColor?: GeospatialColor | undefined;
|
|
4674
|
+
/**
|
|
4675
|
+
* <p>The width of the border stroke.</p>
|
|
4676
|
+
* @public
|
|
4677
|
+
*/
|
|
4678
|
+
StrokeWidth?: GeospatialLineWidth | undefined;
|
|
4288
4679
|
}
|
|
4289
4680
|
/**
|
|
4290
|
-
* <p>The
|
|
4681
|
+
* <p>The polygon style for a polygon layer.</p>
|
|
4291
4682
|
* @public
|
|
4292
4683
|
*/
|
|
4293
|
-
export interface
|
|
4684
|
+
export interface GeospatialPolygonStyle {
|
|
4294
4685
|
/**
|
|
4295
|
-
* <p>The
|
|
4686
|
+
* <p>The polygon symbol style for a polygon layer.</p>
|
|
4296
4687
|
* @public
|
|
4297
4688
|
*/
|
|
4298
|
-
|
|
4689
|
+
PolygonSymbolStyle?: GeospatialPolygonSymbolStyle | undefined;
|
|
4690
|
+
}
|
|
4691
|
+
/**
|
|
4692
|
+
* <p>The geospatial polygon layer.</p>
|
|
4693
|
+
* @public
|
|
4694
|
+
*/
|
|
4695
|
+
export interface GeospatialPolygonLayer {
|
|
4299
4696
|
/**
|
|
4300
|
-
* <p>The
|
|
4697
|
+
* <p>The visualization style for a polygon layer.</p>
|
|
4301
4698
|
* @public
|
|
4302
4699
|
*/
|
|
4303
|
-
|
|
4700
|
+
Style: GeospatialPolygonStyle | undefined;
|
|
4701
|
+
}
|
|
4702
|
+
/**
|
|
4703
|
+
* <p>The definition properties for a geospatial layer.</p>
|
|
4704
|
+
* @public
|
|
4705
|
+
*/
|
|
4706
|
+
export interface GeospatialLayerDefinition {
|
|
4304
4707
|
/**
|
|
4305
|
-
* <p>The
|
|
4708
|
+
* <p>The definition for a point layer.</p>
|
|
4306
4709
|
* @public
|
|
4307
4710
|
*/
|
|
4308
|
-
|
|
4711
|
+
PointLayer?: GeospatialPointLayer | undefined;
|
|
4309
4712
|
/**
|
|
4310
|
-
* <p>The
|
|
4713
|
+
* <p>The definition for a line layer.</p>
|
|
4311
4714
|
* @public
|
|
4312
4715
|
*/
|
|
4313
|
-
|
|
4716
|
+
LineLayer?: GeospatialLineLayer | undefined;
|
|
4314
4717
|
/**
|
|
4315
|
-
* <p>The
|
|
4718
|
+
* <p>The definition for a polygon layer.</p>
|
|
4316
4719
|
* @public
|
|
4317
4720
|
*/
|
|
4318
|
-
|
|
4721
|
+
PolygonLayer?: GeospatialPolygonLayer | undefined;
|
|
4319
4722
|
}
|
|
4320
4723
|
/**
|
|
4321
4724
|
* @public
|
|
4322
4725
|
* @enum
|
|
4323
4726
|
*/
|
|
4324
|
-
export declare const
|
|
4325
|
-
readonly AREA: "AREA";
|
|
4727
|
+
export declare const GeospatialLayerType: {
|
|
4326
4728
|
readonly LINE: "LINE";
|
|
4327
|
-
readonly
|
|
4729
|
+
readonly POINT: "POINT";
|
|
4730
|
+
readonly POLYGON: "POLYGON";
|
|
4328
4731
|
};
|
|
4329
4732
|
/**
|
|
4330
4733
|
* @public
|
|
4331
4734
|
*/
|
|
4332
|
-
export type
|
|
4735
|
+
export type GeospatialLayerType = (typeof GeospatialLayerType)[keyof typeof GeospatialLayerType];
|
|
4333
4736
|
/**
|
|
4334
|
-
* <p>The
|
|
4737
|
+
* <p>The properties for a single geospatial layer.</p>
|
|
4335
4738
|
* @public
|
|
4336
4739
|
*/
|
|
4337
|
-
export interface
|
|
4740
|
+
export interface GeospatialLayerItem {
|
|
4338
4741
|
/**
|
|
4339
|
-
* <p>The
|
|
4742
|
+
* <p>The ID of the layer.</p>
|
|
4340
4743
|
* @public
|
|
4341
4744
|
*/
|
|
4342
|
-
|
|
4745
|
+
LayerId: string | undefined;
|
|
4343
4746
|
/**
|
|
4344
|
-
* <p>The
|
|
4747
|
+
* <p>The layer type.</p>
|
|
4345
4748
|
* @public
|
|
4346
4749
|
*/
|
|
4347
|
-
|
|
4750
|
+
LayerType?: GeospatialLayerType | undefined;
|
|
4348
4751
|
/**
|
|
4349
|
-
* <p>The
|
|
4752
|
+
* <p>The data source for the layer.</p>
|
|
4350
4753
|
* @public
|
|
4351
4754
|
*/
|
|
4352
|
-
|
|
4755
|
+
DataSource?: GeospatialDataSourceItem | undefined;
|
|
4353
4756
|
/**
|
|
4354
|
-
* <p>
|
|
4757
|
+
* <p>The label that is displayed for the layer.</p>
|
|
4355
4758
|
* @public
|
|
4356
4759
|
*/
|
|
4357
|
-
|
|
4760
|
+
Label?: string | undefined;
|
|
4358
4761
|
/**
|
|
4359
|
-
* <p>The
|
|
4762
|
+
* <p>The state of visibility for the layer.</p>
|
|
4360
4763
|
* @public
|
|
4361
4764
|
*/
|
|
4362
|
-
|
|
4765
|
+
Visibility?: Visibility | undefined;
|
|
4363
4766
|
/**
|
|
4364
|
-
* <p>The
|
|
4767
|
+
* <p>The definition properties for a layer.</p>
|
|
4365
4768
|
* @public
|
|
4366
4769
|
*/
|
|
4367
|
-
|
|
4770
|
+
LayerDefinition?: GeospatialLayerDefinition | undefined;
|
|
4368
4771
|
/**
|
|
4369
|
-
* <p>The options
|
|
4772
|
+
* <p>The display options for the visual tooltip.</p>
|
|
4370
4773
|
* @public
|
|
4371
4774
|
*/
|
|
4372
|
-
|
|
4775
|
+
Tooltip?: TooltipOptions | undefined;
|
|
4373
4776
|
/**
|
|
4374
|
-
* <p>The
|
|
4777
|
+
* <p>The join definition properties for a layer.</p>
|
|
4375
4778
|
* @public
|
|
4376
4779
|
*/
|
|
4377
|
-
|
|
4780
|
+
JoinDefinition?: GeospatialLayerJoinDefinition | undefined;
|
|
4378
4781
|
/**
|
|
4379
|
-
* <p>
|
|
4782
|
+
* <p>A list of custom actions for a layer.</p>
|
|
4380
4783
|
* @public
|
|
4381
4784
|
*/
|
|
4382
|
-
|
|
4785
|
+
Actions?: LayerCustomAction[] | undefined;
|
|
4786
|
+
}
|
|
4787
|
+
/**
|
|
4788
|
+
* @public
|
|
4789
|
+
* @enum
|
|
4790
|
+
*/
|
|
4791
|
+
export declare const GeospatialMapNavigation: {
|
|
4792
|
+
readonly DISABLED: "DISABLED";
|
|
4793
|
+
readonly ENABLED: "ENABLED";
|
|
4794
|
+
};
|
|
4795
|
+
/**
|
|
4796
|
+
* @public
|
|
4797
|
+
*/
|
|
4798
|
+
export type GeospatialMapNavigation = (typeof GeospatialMapNavigation)[keyof typeof GeospatialMapNavigation];
|
|
4799
|
+
/**
|
|
4800
|
+
* <p>The map state properties for a map.</p>
|
|
4801
|
+
* @public
|
|
4802
|
+
*/
|
|
4803
|
+
export interface GeospatialMapState {
|
|
4383
4804
|
/**
|
|
4384
|
-
* <p>The
|
|
4805
|
+
* <p>The bound
|
|
4806
|
+
* options (north, south, west, east) of the geospatial window options.</p>
|
|
4385
4807
|
* @public
|
|
4386
4808
|
*/
|
|
4387
|
-
|
|
4809
|
+
Bounds?: GeospatialCoordinateBounds | undefined;
|
|
4388
4810
|
/**
|
|
4389
|
-
* <p>
|
|
4811
|
+
* <p>Enables or disables map navigation for a map.</p>
|
|
4390
4812
|
* @public
|
|
4391
4813
|
*/
|
|
4392
|
-
|
|
4814
|
+
MapNavigation?: GeospatialMapNavigation | undefined;
|
|
4815
|
+
}
|
|
4816
|
+
/**
|
|
4817
|
+
* <p>The map style properties for a map.</p>
|
|
4818
|
+
* @public
|
|
4819
|
+
*/
|
|
4820
|
+
export interface GeospatialMapStyle {
|
|
4393
4821
|
/**
|
|
4394
|
-
* <p>The
|
|
4822
|
+
* <p>The selected base map style.</p>
|
|
4395
4823
|
* @public
|
|
4396
4824
|
*/
|
|
4397
|
-
|
|
4825
|
+
BaseMapStyle?: BaseMapStyleType | undefined;
|
|
4398
4826
|
/**
|
|
4399
|
-
* <p>The
|
|
4827
|
+
* <p>The background color and opacity values for a map.</p>
|
|
4400
4828
|
* @public
|
|
4401
4829
|
*/
|
|
4402
|
-
|
|
4830
|
+
BackgroundColor?: string | undefined;
|
|
4403
4831
|
/**
|
|
4404
|
-
* <p>The
|
|
4832
|
+
* <p>The state of visibility for the base map.</p>
|
|
4405
4833
|
* @public
|
|
4406
4834
|
*/
|
|
4407
|
-
|
|
4835
|
+
BaseMapVisibility?: Visibility | undefined;
|
|
4836
|
+
}
|
|
4837
|
+
/**
|
|
4838
|
+
* <p>The map definition that defines map state, map style, and geospatial layers.</p>
|
|
4839
|
+
* @public
|
|
4840
|
+
*/
|
|
4841
|
+
export interface GeospatialLayerMapConfiguration {
|
|
4408
4842
|
/**
|
|
4409
|
-
* <p>The legend
|
|
4843
|
+
* <p>The options for the legend setup of a visual.</p>
|
|
4410
4844
|
* @public
|
|
4411
4845
|
*/
|
|
4412
4846
|
Legend?: LegendOptions | undefined;
|
|
4413
4847
|
/**
|
|
4414
|
-
* <p>The
|
|
4415
|
-
* @public
|
|
4416
|
-
*/
|
|
4417
|
-
DataLabels?: DataLabelOptions | undefined;
|
|
4418
|
-
/**
|
|
4419
|
-
* <p>The reference lines configuration of a line chart.</p>
|
|
4420
|
-
* @public
|
|
4421
|
-
*/
|
|
4422
|
-
ReferenceLines?: ReferenceLine[] | undefined;
|
|
4423
|
-
/**
|
|
4424
|
-
* <p>The tooltip configuration of a line chart.</p>
|
|
4848
|
+
* <p>The geospatial layers to visualize on the map.</p>
|
|
4425
4849
|
* @public
|
|
4426
4850
|
*/
|
|
4427
|
-
|
|
4851
|
+
MapLayers?: GeospatialLayerItem[] | undefined;
|
|
4428
4852
|
/**
|
|
4429
|
-
* <p>The
|
|
4853
|
+
* <p>The map state properties for the map.</p>
|
|
4430
4854
|
* @public
|
|
4431
4855
|
*/
|
|
4432
|
-
|
|
4856
|
+
MapState?: GeospatialMapState | undefined;
|
|
4433
4857
|
/**
|
|
4434
|
-
* <p>The
|
|
4858
|
+
* <p>The map style properties for the map.</p>
|
|
4435
4859
|
* @public
|
|
4436
4860
|
*/
|
|
4437
|
-
|
|
4861
|
+
MapStyle?: GeospatialMapStyle | undefined;
|
|
4438
4862
|
/**
|
|
4439
|
-
* <p>The general visual interactions setup for
|
|
4863
|
+
* <p>The general visual interactions setup for visual publish options</p>
|
|
4440
4864
|
* @public
|
|
4441
4865
|
*/
|
|
4442
4866
|
Interactions?: VisualInteractionOptions | undefined;
|
|
4443
4867
|
}
|
|
4444
4868
|
/**
|
|
4445
|
-
* <p>A
|
|
4446
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html">Using line charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
4869
|
+
* <p>A layer map visual.</p>
|
|
4447
4870
|
* @public
|
|
4448
4871
|
*/
|
|
4449
|
-
export interface
|
|
4872
|
+
export interface LayerMapVisual {
|
|
4450
4873
|
/**
|
|
4451
|
-
* <p>The
|
|
4874
|
+
* <p>The ID of the visual.</p>
|
|
4452
4875
|
* @public
|
|
4453
4876
|
*/
|
|
4454
4877
|
VisualId: string | undefined;
|
|
4455
4878
|
/**
|
|
4456
|
-
* <p>The title
|
|
4879
|
+
* <p>The title label options for a visual.</p>
|
|
4457
4880
|
* @public
|
|
4458
4881
|
*/
|
|
4459
4882
|
Title?: VisualTitleLabelOptions | undefined;
|
|
4460
4883
|
/**
|
|
4461
|
-
* <p>The subtitle
|
|
4884
|
+
* <p>The subtitle label options for a visual.</p>
|
|
4462
4885
|
* @public
|
|
4463
4886
|
*/
|
|
4464
4887
|
Subtitle?: VisualSubtitleLabelOptions | undefined;
|
|
4465
4888
|
/**
|
|
4466
|
-
* <p>The configuration of
|
|
4889
|
+
* <p>The configuration settings of the visual.</p>
|
|
4467
4890
|
* @public
|
|
4468
4891
|
*/
|
|
4469
|
-
ChartConfiguration?:
|
|
4892
|
+
ChartConfiguration?: GeospatialLayerMapConfiguration | undefined;
|
|
4470
4893
|
/**
|
|
4471
|
-
* <p>The
|
|
4894
|
+
* <p>The dataset that is used to create the layer map visual. You can't create a visual without a dataset.</p>
|
|
4472
4895
|
* @public
|
|
4473
4896
|
*/
|
|
4474
|
-
|
|
4897
|
+
DataSetIdentifier: string | undefined;
|
|
4475
4898
|
/**
|
|
4476
|
-
* <p>The
|
|
4899
|
+
* <p>The alt text for the visual.</p>
|
|
4477
4900
|
* @public
|
|
4478
4901
|
*/
|
|
4479
|
-
|
|
4902
|
+
VisualContentAltText?: string | undefined;
|
|
4480
4903
|
}
|
|
4481
4904
|
/**
|
|
4482
4905
|
* @public
|
|
4483
4906
|
* @enum
|
|
4484
4907
|
*/
|
|
4485
|
-
export declare const
|
|
4486
|
-
readonly
|
|
4487
|
-
readonly
|
|
4488
|
-
readonly
|
|
4489
|
-
readonly WHOLE: "WHOLE";
|
|
4908
|
+
export declare const LineInterpolation: {
|
|
4909
|
+
readonly LINEAR: "LINEAR";
|
|
4910
|
+
readonly SMOOTH: "SMOOTH";
|
|
4911
|
+
readonly STEPPED: "STEPPED";
|
|
4490
4912
|
};
|
|
4491
4913
|
/**
|
|
4492
4914
|
* @public
|
|
4493
4915
|
*/
|
|
4494
|
-
export type
|
|
4916
|
+
export type LineInterpolation = (typeof LineInterpolation)[keyof typeof LineInterpolation];
|
|
4495
4917
|
/**
|
|
4496
|
-
* <p>The options that determine the arc thickness of a <code>GaugeChartVisual</code>.</p>
|
|
4497
4918
|
* @public
|
|
4919
|
+
* @enum
|
|
4498
4920
|
*/
|
|
4499
|
-
export
|
|
4500
|
-
|
|
4501
|
-
|
|
4502
|
-
|
|
4503
|
-
|
|
4504
|
-
ArcThickness?: ArcThickness | undefined;
|
|
4505
|
-
}
|
|
4921
|
+
export declare const LineChartLineStyle: {
|
|
4922
|
+
readonly DASHED: "DASHED";
|
|
4923
|
+
readonly DOTTED: "DOTTED";
|
|
4924
|
+
readonly SOLID: "SOLID";
|
|
4925
|
+
};
|
|
4506
4926
|
/**
|
|
4507
|
-
* <p>The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.</p>
|
|
4508
4927
|
* @public
|
|
4509
4928
|
*/
|
|
4510
|
-
export
|
|
4511
|
-
/**
|
|
4512
|
-
* <p>Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called <code>'Show total'</code>.</p>
|
|
4513
|
-
* @public
|
|
4514
|
-
*/
|
|
4515
|
-
LabelVisibility?: Visibility | undefined;
|
|
4516
|
-
}
|
|
4929
|
+
export type LineChartLineStyle = (typeof LineChartLineStyle)[keyof typeof LineChartLineStyle];
|
|
4517
4930
|
/**
|
|
4518
|
-
* <p>
|
|
4931
|
+
* <p>Line styles options for a line series in <code>LineChartVisual</code>.</p>
|
|
4519
4932
|
* @public
|
|
4520
4933
|
*/
|
|
4521
|
-
export interface
|
|
4934
|
+
export interface LineChartLineStyleSettings {
|
|
4522
4935
|
/**
|
|
4523
|
-
* <p>
|
|
4936
|
+
* <p>Configuration option that determines whether to show the line for the series.</p>
|
|
4937
|
+
* @public
|
|
4938
|
+
*/
|
|
4939
|
+
LineVisibility?: Visibility | undefined;
|
|
4940
|
+
/**
|
|
4941
|
+
* <p>Interpolation style for line series.</p>
|
|
4524
4942
|
* <ul>
|
|
4525
4943
|
* <li>
|
|
4526
4944
|
* <p>
|
|
4527
|
-
* <code>
|
|
4945
|
+
* <code>LINEAR</code>: Show as default, linear style.</p>
|
|
4528
4946
|
* </li>
|
|
4529
4947
|
* <li>
|
|
4530
4948
|
* <p>
|
|
4531
|
-
* <code>
|
|
4949
|
+
* <code>SMOOTH</code>: Show as a smooth curve.</p>
|
|
4532
4950
|
* </li>
|
|
4533
4951
|
* <li>
|
|
4534
4952
|
* <p>
|
|
4535
|
-
* <code>
|
|
4953
|
+
* <code>STEPPED</code>: Show steps in line.</p>
|
|
4954
|
+
* </li>
|
|
4955
|
+
* </ul>
|
|
4956
|
+
* @public
|
|
4957
|
+
*/
|
|
4958
|
+
LineInterpolation?: LineInterpolation | undefined;
|
|
4959
|
+
/**
|
|
4960
|
+
* <p>Line style for line series.</p>
|
|
4961
|
+
* <ul>
|
|
4962
|
+
* <li>
|
|
4963
|
+
* <p>
|
|
4964
|
+
* <code>SOLID</code>: Show as a solid line.</p>
|
|
4536
4965
|
* </li>
|
|
4537
4966
|
* <li>
|
|
4538
4967
|
* <p>
|
|
4539
|
-
* <code>
|
|
4968
|
+
* <code>DOTTED</code>: Show as a dotted line.</p>
|
|
4969
|
+
* </li>
|
|
4970
|
+
* <li>
|
|
4971
|
+
* <p>
|
|
4972
|
+
* <code>DASHED</code>: Show as a dashed line.</p>
|
|
4540
4973
|
* </li>
|
|
4541
4974
|
* </ul>
|
|
4542
4975
|
* @public
|
|
4543
4976
|
*/
|
|
4544
|
-
|
|
4977
|
+
LineStyle?: LineChartLineStyle | undefined;
|
|
4545
4978
|
/**
|
|
4546
|
-
* <p>
|
|
4979
|
+
* <p>Width that determines the line thickness.</p>
|
|
4547
4980
|
* @public
|
|
4548
4981
|
*/
|
|
4549
|
-
|
|
4982
|
+
LineWidth?: string | undefined;
|
|
4550
4983
|
}
|
|
4551
4984
|
/**
|
|
4552
|
-
* <p>The field well configuration of a pie chart.</p>
|
|
4553
4985
|
* @public
|
|
4986
|
+
* @enum
|
|
4554
4987
|
*/
|
|
4555
|
-
export
|
|
4988
|
+
export declare const LineChartMarkerShape: {
|
|
4989
|
+
readonly CIRCLE: "CIRCLE";
|
|
4990
|
+
readonly DIAMOND: "DIAMOND";
|
|
4991
|
+
readonly ROUNDED_SQUARE: "ROUNDED_SQUARE";
|
|
4992
|
+
readonly SQUARE: "SQUARE";
|
|
4993
|
+
readonly TRIANGLE: "TRIANGLE";
|
|
4994
|
+
};
|
|
4995
|
+
/**
|
|
4996
|
+
* @public
|
|
4997
|
+
*/
|
|
4998
|
+
export type LineChartMarkerShape = (typeof LineChartMarkerShape)[keyof typeof LineChartMarkerShape];
|
|
4999
|
+
/**
|
|
5000
|
+
* <p>Marker styles options for a line series in <code>LineChartVisual</code>.</p>
|
|
5001
|
+
* @public
|
|
5002
|
+
*/
|
|
5003
|
+
export interface LineChartMarkerStyleSettings {
|
|
4556
5004
|
/**
|
|
4557
|
-
* <p>
|
|
5005
|
+
* <p>Configuration option that determines whether to show the markers in the series.</p>
|
|
4558
5006
|
* @public
|
|
4559
5007
|
*/
|
|
4560
|
-
|
|
5008
|
+
MarkerVisibility?: Visibility | undefined;
|
|
4561
5009
|
/**
|
|
4562
|
-
* <p>
|
|
5010
|
+
* <p>Shape option for markers in the series.</p>
|
|
5011
|
+
* <ul>
|
|
5012
|
+
* <li>
|
|
5013
|
+
* <p>
|
|
5014
|
+
* <code>CIRCLE</code>: Show marker as a circle.</p>
|
|
5015
|
+
* </li>
|
|
5016
|
+
* <li>
|
|
5017
|
+
* <p>
|
|
5018
|
+
* <code>TRIANGLE</code>: Show marker as a triangle.</p>
|
|
5019
|
+
* </li>
|
|
5020
|
+
* <li>
|
|
5021
|
+
* <p>
|
|
5022
|
+
* <code>SQUARE</code>: Show marker as a square.</p>
|
|
5023
|
+
* </li>
|
|
5024
|
+
* <li>
|
|
5025
|
+
* <p>
|
|
5026
|
+
* <code>DIAMOND</code>: Show marker as a diamond.</p>
|
|
5027
|
+
* </li>
|
|
5028
|
+
* <li>
|
|
5029
|
+
* <p>
|
|
5030
|
+
* <code>ROUNDED_SQUARE</code>: Show marker as a rounded square.</p>
|
|
5031
|
+
* </li>
|
|
5032
|
+
* </ul>
|
|
4563
5033
|
* @public
|
|
4564
5034
|
*/
|
|
4565
|
-
|
|
5035
|
+
MarkerShape?: LineChartMarkerShape | undefined;
|
|
4566
5036
|
/**
|
|
4567
|
-
* <p>
|
|
5037
|
+
* <p>Size of marker in the series.</p>
|
|
4568
5038
|
* @public
|
|
4569
5039
|
*/
|
|
4570
|
-
|
|
4571
|
-
}
|
|
4572
|
-
/**
|
|
4573
|
-
* <p>The field well configuration of a pie chart.</p>
|
|
4574
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
4575
|
-
* @public
|
|
4576
|
-
*/
|
|
4577
|
-
export interface PieChartFieldWells {
|
|
5040
|
+
MarkerSize?: string | undefined;
|
|
4578
5041
|
/**
|
|
4579
|
-
* <p>
|
|
5042
|
+
* <p>Color of marker in the series.</p>
|
|
4580
5043
|
* @public
|
|
4581
5044
|
*/
|
|
4582
|
-
|
|
5045
|
+
MarkerColor?: string | undefined;
|
|
4583
5046
|
}
|
|
4584
5047
|
/**
|
|
4585
|
-
* <p>The
|
|
5048
|
+
* <p>The options that determine the default presentation of all line series in <code>LineChartVisual</code>.</p>
|
|
4586
5049
|
* @public
|
|
4587
5050
|
*/
|
|
4588
|
-
export interface
|
|
4589
|
-
/**
|
|
4590
|
-
* <p>The sort configuration of the category fields.</p>
|
|
4591
|
-
* @public
|
|
4592
|
-
*/
|
|
4593
|
-
CategorySort?: FieldSortOptions[] | undefined;
|
|
5051
|
+
export interface LineChartDefaultSeriesSettings {
|
|
4594
5052
|
/**
|
|
4595
|
-
* <p>The
|
|
5053
|
+
* <p>The axis to which you are binding all line series to.</p>
|
|
4596
5054
|
* @public
|
|
4597
5055
|
*/
|
|
4598
|
-
|
|
5056
|
+
AxisBinding?: AxisBinding | undefined;
|
|
4599
5057
|
/**
|
|
4600
|
-
* <p>
|
|
5058
|
+
* <p>Line styles options for all line series in the visual.</p>
|
|
4601
5059
|
* @public
|
|
4602
5060
|
*/
|
|
4603
|
-
|
|
5061
|
+
LineStyleSettings?: LineChartLineStyleSettings | undefined;
|
|
4604
5062
|
/**
|
|
4605
|
-
* <p>
|
|
5063
|
+
* <p>Marker styles options for all line series in the visual.</p>
|
|
4606
5064
|
* @public
|
|
4607
5065
|
*/
|
|
4608
|
-
|
|
5066
|
+
MarkerStyleSettings?: LineChartMarkerStyleSettings | undefined;
|
|
4609
5067
|
}
|
|
4610
5068
|
/**
|
|
4611
|
-
* <p>The configuration of a
|
|
5069
|
+
* <p>The field well configuration of a line chart.</p>
|
|
4612
5070
|
* @public
|
|
4613
5071
|
*/
|
|
4614
|
-
export interface
|
|
4615
|
-
/**
|
|
4616
|
-
* <p>The field wells of the visual.</p>
|
|
4617
|
-
* @public
|
|
4618
|
-
*/
|
|
4619
|
-
FieldWells?: PieChartFieldWells | undefined;
|
|
5072
|
+
export interface LineChartAggregatedFieldWells {
|
|
4620
5073
|
/**
|
|
4621
|
-
* <p>The
|
|
5074
|
+
* <p>The category field wells of a line chart. Values are grouped by category fields.</p>
|
|
4622
5075
|
* @public
|
|
4623
5076
|
*/
|
|
4624
|
-
|
|
5077
|
+
Category?: DimensionField[] | undefined;
|
|
4625
5078
|
/**
|
|
4626
|
-
* <p>The
|
|
5079
|
+
* <p>The value field wells of a line chart. Values are aggregated based on categories.</p>
|
|
4627
5080
|
* @public
|
|
4628
5081
|
*/
|
|
4629
|
-
|
|
5082
|
+
Values?: MeasureField[] | undefined;
|
|
4630
5083
|
/**
|
|
4631
|
-
* <p>The
|
|
5084
|
+
* <p>The color field wells of a line chart. Values are grouped by category fields.</p>
|
|
4632
5085
|
* @public
|
|
4633
5086
|
*/
|
|
4634
|
-
|
|
5087
|
+
Colors?: DimensionField[] | undefined;
|
|
4635
5088
|
/**
|
|
4636
|
-
* <p>The
|
|
5089
|
+
* <p>The small multiples field well of a line chart.</p>
|
|
4637
5090
|
* @public
|
|
4638
5091
|
*/
|
|
4639
|
-
|
|
5092
|
+
SmallMultiples?: DimensionField[] | undefined;
|
|
5093
|
+
}
|
|
5094
|
+
/**
|
|
5095
|
+
* <p>The field well configuration of a line chart.</p>
|
|
5096
|
+
* @public
|
|
5097
|
+
*/
|
|
5098
|
+
export interface LineChartFieldWells {
|
|
4640
5099
|
/**
|
|
4641
|
-
* <p>The
|
|
5100
|
+
* <p>The field well configuration of a line chart.</p>
|
|
4642
5101
|
* @public
|
|
4643
5102
|
*/
|
|
4644
|
-
|
|
5103
|
+
LineChartAggregatedFieldWells?: LineChartAggregatedFieldWells | undefined;
|
|
5104
|
+
}
|
|
5105
|
+
/**
|
|
5106
|
+
* <p>The forecast properties setup of a forecast in the line chart.</p>
|
|
5107
|
+
* @public
|
|
5108
|
+
*/
|
|
5109
|
+
export interface TimeBasedForecastProperties {
|
|
4645
5110
|
/**
|
|
4646
|
-
* <p>The
|
|
5111
|
+
* <p>The periods forward setup of a forecast computation.</p>
|
|
4647
5112
|
* @public
|
|
4648
5113
|
*/
|
|
4649
|
-
|
|
5114
|
+
PeriodsForward?: number | undefined;
|
|
4650
5115
|
/**
|
|
4651
|
-
* <p>The
|
|
5116
|
+
* <p>The periods backward setup of a forecast computation.</p>
|
|
4652
5117
|
* @public
|
|
4653
5118
|
*/
|
|
4654
|
-
|
|
5119
|
+
PeriodsBackward?: number | undefined;
|
|
4655
5120
|
/**
|
|
4656
|
-
* <p>The
|
|
5121
|
+
* <p>The upper boundary setup of a forecast computation.</p>
|
|
4657
5122
|
* @public
|
|
4658
5123
|
*/
|
|
4659
|
-
|
|
5124
|
+
UpperBoundary?: number | undefined;
|
|
4660
5125
|
/**
|
|
4661
|
-
* <p>The
|
|
5126
|
+
* <p>The lower boundary setup of a forecast computation.</p>
|
|
4662
5127
|
* @public
|
|
4663
5128
|
*/
|
|
4664
|
-
|
|
5129
|
+
LowerBoundary?: number | undefined;
|
|
4665
5130
|
/**
|
|
4666
|
-
* <p>The
|
|
5131
|
+
* <p>The prediction interval setup of a forecast computation.</p>
|
|
4667
5132
|
* @public
|
|
4668
5133
|
*/
|
|
4669
|
-
|
|
5134
|
+
PredictionInterval?: number | undefined;
|
|
4670
5135
|
/**
|
|
4671
|
-
* <p>The
|
|
5136
|
+
* <p>The seasonality setup of a forecast computation. Choose one of the following options:</p>
|
|
5137
|
+
* <ul>
|
|
5138
|
+
* <li>
|
|
5139
|
+
* <p>
|
|
5140
|
+
* <code>NULL</code>: The input is set to <code>NULL</code>.</p>
|
|
5141
|
+
* </li>
|
|
5142
|
+
* <li>
|
|
5143
|
+
* <p>
|
|
5144
|
+
* <code>NON_NULL</code>: The input is set to a custom value.</p>
|
|
5145
|
+
* </li>
|
|
5146
|
+
* </ul>
|
|
4672
5147
|
* @public
|
|
4673
5148
|
*/
|
|
4674
|
-
|
|
5149
|
+
Seasonality?: number | undefined;
|
|
4675
5150
|
}
|
|
4676
5151
|
/**
|
|
4677
|
-
* <p>
|
|
4678
|
-
* <p>The <code>PieChartVisual</code> structure describes a visual that is a member of the pie chart family.</p>
|
|
4679
|
-
* <p>The following charts can be described by using this structure:</p>
|
|
4680
|
-
* <ul>
|
|
4681
|
-
* <li>
|
|
4682
|
-
* <p>Pie charts</p>
|
|
4683
|
-
* </li>
|
|
4684
|
-
* <li>
|
|
4685
|
-
* <p>Donut charts</p>
|
|
4686
|
-
* </li>
|
|
4687
|
-
* </ul>
|
|
4688
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html">Using pie charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
4689
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html">Using donut charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
5152
|
+
* <p>Provides the forecast to meet the target for a particular date.</p>
|
|
4690
5153
|
* @public
|
|
4691
5154
|
*/
|
|
4692
|
-
export interface
|
|
4693
|
-
/**
|
|
4694
|
-
* <p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>
|
|
4695
|
-
* @public
|
|
4696
|
-
*/
|
|
4697
|
-
VisualId: string | undefined;
|
|
5155
|
+
export interface WhatIfPointScenario {
|
|
4698
5156
|
/**
|
|
4699
|
-
* <p>The
|
|
5157
|
+
* <p>The date that you need the forecast results for.</p>
|
|
4700
5158
|
* @public
|
|
4701
5159
|
*/
|
|
4702
|
-
|
|
5160
|
+
Date: Date | undefined;
|
|
4703
5161
|
/**
|
|
4704
|
-
* <p>The
|
|
5162
|
+
* <p>The target value that you want to meet for the provided date.</p>
|
|
4705
5163
|
* @public
|
|
4706
5164
|
*/
|
|
4707
|
-
|
|
5165
|
+
Value: number | undefined;
|
|
5166
|
+
}
|
|
5167
|
+
/**
|
|
5168
|
+
* <p>Provides the forecast to meet the target for a particular date range.</p>
|
|
5169
|
+
* @public
|
|
5170
|
+
*/
|
|
5171
|
+
export interface WhatIfRangeScenario {
|
|
4708
5172
|
/**
|
|
4709
|
-
* <p>The
|
|
5173
|
+
* <p>The start date in the date range that you need the forecast results for.</p>
|
|
4710
5174
|
* @public
|
|
4711
5175
|
*/
|
|
4712
|
-
|
|
5176
|
+
StartDate: Date | undefined;
|
|
4713
5177
|
/**
|
|
4714
|
-
* <p>The
|
|
5178
|
+
* <p>The end date in the date range that you need the forecast results for.</p>
|
|
4715
5179
|
* @public
|
|
4716
5180
|
*/
|
|
4717
|
-
|
|
5181
|
+
EndDate: Date | undefined;
|
|
4718
5182
|
/**
|
|
4719
|
-
* <p>The
|
|
5183
|
+
* <p>The target value that you want to meet for the provided date range.</p>
|
|
4720
5184
|
* @public
|
|
4721
5185
|
*/
|
|
4722
|
-
|
|
5186
|
+
Value: number | undefined;
|
|
4723
5187
|
}
|
|
4724
5188
|
/**
|
|
4725
|
-
*
|
|
4726
|
-
* @enum
|
|
4727
|
-
*/
|
|
4728
|
-
export declare const PivotTableFieldCollapseState: {
|
|
4729
|
-
readonly COLLAPSED: "COLLAPSED";
|
|
4730
|
-
readonly EXPANDED: "EXPANDED";
|
|
4731
|
-
};
|
|
4732
|
-
/**
|
|
4733
|
-
* @public
|
|
4734
|
-
*/
|
|
4735
|
-
export type PivotTableFieldCollapseState = (typeof PivotTableFieldCollapseState)[keyof typeof PivotTableFieldCollapseState];
|
|
4736
|
-
/**
|
|
4737
|
-
* <p>The target of a pivot table field collapse state.</p>
|
|
5189
|
+
* <p>The forecast scenario of a forecast in the line chart.</p>
|
|
4738
5190
|
* @public
|
|
4739
5191
|
*/
|
|
4740
|
-
export interface
|
|
5192
|
+
export interface ForecastScenario {
|
|
4741
5193
|
/**
|
|
4742
|
-
* <p>The
|
|
5194
|
+
* <p>The what-if analysis forecast setup with the target date.</p>
|
|
4743
5195
|
* @public
|
|
4744
5196
|
*/
|
|
4745
|
-
|
|
5197
|
+
WhatIfPointScenario?: WhatIfPointScenario | undefined;
|
|
4746
5198
|
/**
|
|
4747
|
-
* <p>The
|
|
5199
|
+
* <p>The what-if analysis forecast setup with the date range.</p>
|
|
4748
5200
|
* @public
|
|
4749
5201
|
*/
|
|
4750
|
-
|
|
5202
|
+
WhatIfRangeScenario?: WhatIfRangeScenario | undefined;
|
|
4751
5203
|
}
|
|
4752
5204
|
/**
|
|
4753
|
-
* <p>The
|
|
5205
|
+
* <p>The forecast configuration that is used in a line chart's display properties.</p>
|
|
4754
5206
|
* @public
|
|
4755
5207
|
*/
|
|
4756
|
-
export interface
|
|
4757
|
-
/**
|
|
4758
|
-
* <p>A tagged-union object that sets the collapse state.</p>
|
|
4759
|
-
* @public
|
|
4760
|
-
*/
|
|
4761
|
-
Target: PivotTableFieldCollapseStateTarget | undefined;
|
|
5208
|
+
export interface ForecastConfiguration {
|
|
4762
5209
|
/**
|
|
4763
|
-
* <p>The
|
|
4764
|
-
*
|
|
4765
|
-
*
|
|
4766
|
-
|
|
4767
|
-
|
|
4768
|
-
* </p>
|
|
4769
|
-
* </li>
|
|
4770
|
-
* <li>
|
|
4771
|
-
* <p>
|
|
4772
|
-
* <code>EXPANDED</code>
|
|
4773
|
-
* </p>
|
|
4774
|
-
* </li>
|
|
4775
|
-
* </ul>
|
|
4776
|
-
* @public
|
|
4777
|
-
*/
|
|
4778
|
-
State?: PivotTableFieldCollapseState | undefined;
|
|
4779
|
-
}
|
|
4780
|
-
/**
|
|
4781
|
-
* <p>The data path options for the pivot table field options.</p>
|
|
4782
|
-
* @public
|
|
4783
|
-
*/
|
|
4784
|
-
export interface PivotTableDataPathOption {
|
|
4785
|
-
/**
|
|
4786
|
-
* <p>The list of data path values for the data path options.</p>
|
|
4787
|
-
* @public
|
|
4788
|
-
*/
|
|
4789
|
-
DataPathList: DataPathValue[] | undefined;
|
|
4790
|
-
/**
|
|
4791
|
-
* <p>The width of the data path option.</p>
|
|
4792
|
-
* @public
|
|
4793
|
-
*/
|
|
4794
|
-
Width?: string | undefined;
|
|
4795
|
-
}
|
|
4796
|
-
/**
|
|
4797
|
-
* <p>The selected field options for the pivot table field options.</p>
|
|
4798
|
-
* @public
|
|
4799
|
-
*/
|
|
4800
|
-
export interface PivotTableFieldOption {
|
|
4801
|
-
/**
|
|
4802
|
-
* <p>The field ID of the pivot table field.</p>
|
|
4803
|
-
* @public
|
|
4804
|
-
*/
|
|
4805
|
-
FieldId: string | undefined;
|
|
4806
|
-
/**
|
|
4807
|
-
* <p>The custom label of the pivot table field.</p>
|
|
4808
|
-
* @public
|
|
4809
|
-
*/
|
|
4810
|
-
CustomLabel?: string | undefined;
|
|
4811
|
-
/**
|
|
4812
|
-
* <p>The visibility of the pivot table field.</p>
|
|
4813
|
-
* @public
|
|
4814
|
-
*/
|
|
4815
|
-
Visibility?: Visibility | undefined;
|
|
4816
|
-
}
|
|
4817
|
-
/**
|
|
4818
|
-
* <p>The field options for a pivot table visual.</p>
|
|
4819
|
-
* @public
|
|
4820
|
-
*/
|
|
4821
|
-
export interface PivotTableFieldOptions {
|
|
4822
|
-
/**
|
|
4823
|
-
* <p>The selected field options for the pivot table field options.</p>
|
|
4824
|
-
* @public
|
|
4825
|
-
*/
|
|
4826
|
-
SelectedFieldOptions?: PivotTableFieldOption[] | undefined;
|
|
4827
|
-
/**
|
|
4828
|
-
* <p>The data path options for the pivot table field options.</p>
|
|
4829
|
-
* @public
|
|
4830
|
-
*/
|
|
4831
|
-
DataPathOptions?: PivotTableDataPathOption[] | undefined;
|
|
4832
|
-
/**
|
|
4833
|
-
* <p>The collapse state options for the pivot table field options.</p>
|
|
4834
|
-
* @public
|
|
4835
|
-
*/
|
|
4836
|
-
CollapseStateOptions?: PivotTableFieldCollapseStateOption[] | undefined;
|
|
4837
|
-
}
|
|
4838
|
-
/**
|
|
4839
|
-
* <p>The aggregated field well for the pivot table.</p>
|
|
4840
|
-
* @public
|
|
4841
|
-
*/
|
|
4842
|
-
export interface PivotTableAggregatedFieldWells {
|
|
4843
|
-
/**
|
|
4844
|
-
* <p>The rows field well for a pivot table. Values are grouped by rows fields.</p>
|
|
4845
|
-
* @public
|
|
4846
|
-
*/
|
|
4847
|
-
Rows?: DimensionField[] | undefined;
|
|
4848
|
-
/**
|
|
4849
|
-
* <p>The columns field well for a pivot table. Values are grouped by columns fields.</p>
|
|
4850
|
-
* @public
|
|
4851
|
-
*/
|
|
4852
|
-
Columns?: DimensionField[] | undefined;
|
|
4853
|
-
/**
|
|
4854
|
-
* <p>The values field well for a pivot table. Values are aggregated based on rows and columns fields.</p>
|
|
4855
|
-
* @public
|
|
4856
|
-
*/
|
|
4857
|
-
Values?: MeasureField[] | undefined;
|
|
4858
|
-
}
|
|
4859
|
-
/**
|
|
4860
|
-
* <p>The field wells for a pivot table visual.</p>
|
|
4861
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
4862
|
-
* @public
|
|
4863
|
-
*/
|
|
4864
|
-
export interface PivotTableFieldWells {
|
|
4865
|
-
/**
|
|
4866
|
-
* <p>The aggregated field well for the pivot table.</p>
|
|
4867
|
-
* @public
|
|
4868
|
-
*/
|
|
4869
|
-
PivotTableAggregatedFieldWells?: PivotTableAggregatedFieldWells | undefined;
|
|
4870
|
-
}
|
|
4871
|
-
/**
|
|
4872
|
-
* <p>The paginated report options for a pivot table visual.</p>
|
|
4873
|
-
* @public
|
|
4874
|
-
*/
|
|
4875
|
-
export interface PivotTablePaginatedReportOptions {
|
|
4876
|
-
/**
|
|
4877
|
-
* <p>The visibility of the printing table overflow across pages.</p>
|
|
4878
|
-
* @public
|
|
4879
|
-
*/
|
|
4880
|
-
VerticalOverflowVisibility?: Visibility | undefined;
|
|
4881
|
-
/**
|
|
4882
|
-
* <p>The visibility of the repeating header rows on each page.</p>
|
|
4883
|
-
* @public
|
|
4884
|
-
*/
|
|
4885
|
-
OverflowColumnHeaderVisibility?: Visibility | undefined;
|
|
4886
|
-
}
|
|
4887
|
-
/**
|
|
4888
|
-
* <p>Allows data paths to be sorted by a specific data value.</p>
|
|
4889
|
-
* @public
|
|
4890
|
-
*/
|
|
4891
|
-
export interface DataPathSort {
|
|
4892
|
-
/**
|
|
4893
|
-
* <p>Determines the sort direction.</p>
|
|
4894
|
-
* @public
|
|
4895
|
-
*/
|
|
4896
|
-
Direction: SortDirection | undefined;
|
|
4897
|
-
/**
|
|
4898
|
-
* <p>The list of data paths that need to be sorted.</p>
|
|
4899
|
-
* @public
|
|
4900
|
-
*/
|
|
4901
|
-
SortPaths: DataPathValue[] | undefined;
|
|
4902
|
-
}
|
|
4903
|
-
/**
|
|
4904
|
-
* <p>The sort by field for the field sort options.</p>
|
|
4905
|
-
* @public
|
|
4906
|
-
*/
|
|
4907
|
-
export interface PivotTableSortBy {
|
|
4908
|
-
/**
|
|
4909
|
-
* <p>The field sort (field id, direction) for the pivot table sort by options.</p>
|
|
4910
|
-
* @public
|
|
4911
|
-
*/
|
|
4912
|
-
Field?: FieldSort | undefined;
|
|
4913
|
-
/**
|
|
4914
|
-
* <p>The column sort (field id, direction) for the pivot table sort by options.</p>
|
|
4915
|
-
* @public
|
|
4916
|
-
*/
|
|
4917
|
-
Column?: ColumnSort | undefined;
|
|
4918
|
-
/**
|
|
4919
|
-
* <p>The data path sort (data path value, direction) for the pivot table sort by options.</p>
|
|
4920
|
-
* @public
|
|
4921
|
-
*/
|
|
4922
|
-
DataPath?: DataPathSort | undefined;
|
|
4923
|
-
}
|
|
4924
|
-
/**
|
|
4925
|
-
* <p>The field sort options for a pivot table sort configuration.</p>
|
|
4926
|
-
* @public
|
|
4927
|
-
*/
|
|
4928
|
-
export interface PivotFieldSortOptions {
|
|
4929
|
-
/**
|
|
4930
|
-
* <p>The field ID for the field sort options.</p>
|
|
4931
|
-
* @public
|
|
4932
|
-
*/
|
|
4933
|
-
FieldId: string | undefined;
|
|
4934
|
-
/**
|
|
4935
|
-
* <p>The sort by field for the field sort options.</p>
|
|
4936
|
-
* @public
|
|
4937
|
-
*/
|
|
4938
|
-
SortBy: PivotTableSortBy | undefined;
|
|
4939
|
-
}
|
|
4940
|
-
/**
|
|
4941
|
-
* <p>The sort configuration for a <code>PivotTableVisual</code>.</p>
|
|
4942
|
-
* @public
|
|
4943
|
-
*/
|
|
4944
|
-
export interface PivotTableSortConfiguration {
|
|
4945
|
-
/**
|
|
4946
|
-
* <p>The field sort options for a pivot table sort configuration.</p>
|
|
4947
|
-
* @public
|
|
4948
|
-
*/
|
|
4949
|
-
FieldSortOptions?: PivotFieldSortOptions[] | undefined;
|
|
4950
|
-
}
|
|
4951
|
-
/**
|
|
4952
|
-
* @public
|
|
4953
|
-
* @enum
|
|
4954
|
-
*/
|
|
4955
|
-
export declare const TableBorderStyle: {
|
|
4956
|
-
readonly NONE: "NONE";
|
|
4957
|
-
readonly SOLID: "SOLID";
|
|
4958
|
-
};
|
|
4959
|
-
/**
|
|
4960
|
-
* @public
|
|
4961
|
-
*/
|
|
4962
|
-
export type TableBorderStyle = (typeof TableBorderStyle)[keyof typeof TableBorderStyle];
|
|
4963
|
-
/**
|
|
4964
|
-
* <p>The border options for a table border.</p>
|
|
4965
|
-
* @public
|
|
4966
|
-
*/
|
|
4967
|
-
export interface TableBorderOptions {
|
|
4968
|
-
/**
|
|
4969
|
-
* <p>The color of a table border.</p>
|
|
4970
|
-
* @public
|
|
4971
|
-
*/
|
|
4972
|
-
Color?: string | undefined;
|
|
4973
|
-
/**
|
|
4974
|
-
* <p>The thickness of a table border.</p>
|
|
4975
|
-
* @public
|
|
4976
|
-
*/
|
|
4977
|
-
Thickness?: number | undefined;
|
|
4978
|
-
/**
|
|
4979
|
-
* <p>The style (none, solid) of a table border.</p>
|
|
4980
|
-
* @public
|
|
4981
|
-
*/
|
|
4982
|
-
Style?: TableBorderStyle | undefined;
|
|
4983
|
-
}
|
|
4984
|
-
/**
|
|
4985
|
-
* <p>The side border options for a table.</p>
|
|
4986
|
-
* @public
|
|
4987
|
-
*/
|
|
4988
|
-
export interface TableSideBorderOptions {
|
|
4989
|
-
/**
|
|
4990
|
-
* <p>The table border options of the inner vertical border.</p>
|
|
4991
|
-
* @public
|
|
4992
|
-
*/
|
|
4993
|
-
InnerVertical?: TableBorderOptions | undefined;
|
|
4994
|
-
/**
|
|
4995
|
-
* <p>The table border options of the inner horizontal border.</p>
|
|
4996
|
-
* @public
|
|
4997
|
-
*/
|
|
4998
|
-
InnerHorizontal?: TableBorderOptions | undefined;
|
|
4999
|
-
/**
|
|
5000
|
-
* <p>The table border options of the left border.</p>
|
|
5001
|
-
* @public
|
|
5002
|
-
*/
|
|
5003
|
-
Left?: TableBorderOptions | undefined;
|
|
5004
|
-
/**
|
|
5005
|
-
* <p>The table border options of the right border.</p>
|
|
5006
|
-
* @public
|
|
5007
|
-
*/
|
|
5008
|
-
Right?: TableBorderOptions | undefined;
|
|
5009
|
-
/**
|
|
5010
|
-
* <p>The table border options of the top border.</p>
|
|
5011
|
-
* @public
|
|
5012
|
-
*/
|
|
5013
|
-
Top?: TableBorderOptions | undefined;
|
|
5014
|
-
/**
|
|
5015
|
-
* <p>The table border options of the bottom border.</p>
|
|
5016
|
-
* @public
|
|
5017
|
-
*/
|
|
5018
|
-
Bottom?: TableBorderOptions | undefined;
|
|
5019
|
-
}
|
|
5020
|
-
/**
|
|
5021
|
-
* <p>Determines the border options for a table visual.</p>
|
|
5022
|
-
* @public
|
|
5023
|
-
*/
|
|
5024
|
-
export interface GlobalTableBorderOptions {
|
|
5025
|
-
/**
|
|
5026
|
-
* <p>Determines the options for uniform border.</p>
|
|
5027
|
-
* @public
|
|
5028
|
-
*/
|
|
5029
|
-
UniformBorder?: TableBorderOptions | undefined;
|
|
5030
|
-
/**
|
|
5031
|
-
* <p>Determines the options for side specific border.</p>
|
|
5032
|
-
* @public
|
|
5033
|
-
*/
|
|
5034
|
-
SideSpecificBorder?: TableSideBorderOptions | undefined;
|
|
5035
|
-
}
|
|
5036
|
-
/**
|
|
5037
|
-
* @public
|
|
5038
|
-
* @enum
|
|
5039
|
-
*/
|
|
5040
|
-
export declare const TextWrap: {
|
|
5041
|
-
readonly NONE: "NONE";
|
|
5042
|
-
readonly WRAP: "WRAP";
|
|
5043
|
-
};
|
|
5044
|
-
/**
|
|
5045
|
-
* @public
|
|
5046
|
-
*/
|
|
5047
|
-
export type TextWrap = (typeof TextWrap)[keyof typeof TextWrap];
|
|
5048
|
-
/**
|
|
5049
|
-
* @public
|
|
5050
|
-
* @enum
|
|
5051
|
-
*/
|
|
5052
|
-
export declare const VerticalTextAlignment: {
|
|
5053
|
-
readonly AUTO: "AUTO";
|
|
5054
|
-
readonly BOTTOM: "BOTTOM";
|
|
5055
|
-
readonly MIDDLE: "MIDDLE";
|
|
5056
|
-
readonly TOP: "TOP";
|
|
5057
|
-
};
|
|
5058
|
-
/**
|
|
5059
|
-
* @public
|
|
5060
|
-
*/
|
|
5061
|
-
export type VerticalTextAlignment = (typeof VerticalTextAlignment)[keyof typeof VerticalTextAlignment];
|
|
5062
|
-
/**
|
|
5063
|
-
* <p>The table cell style for a cell in pivot table or table visual.</p>
|
|
5064
|
-
* @public
|
|
5065
|
-
*/
|
|
5066
|
-
export interface TableCellStyle {
|
|
5067
|
-
/**
|
|
5068
|
-
* <p>The visibility of the table cells.</p>
|
|
5069
|
-
* @public
|
|
5070
|
-
*/
|
|
5071
|
-
Visibility?: Visibility | undefined;
|
|
5072
|
-
/**
|
|
5073
|
-
* <p>The font configuration of the table cells.</p>
|
|
5074
|
-
* @public
|
|
5075
|
-
*/
|
|
5076
|
-
FontConfiguration?: FontConfiguration | undefined;
|
|
5077
|
-
/**
|
|
5078
|
-
* <p>The text wrap (none, wrap) for the table cells.</p>
|
|
5079
|
-
* @public
|
|
5080
|
-
*/
|
|
5081
|
-
TextWrap?: TextWrap | undefined;
|
|
5082
|
-
/**
|
|
5083
|
-
* <p>The horizontal text alignment (left, center, right, auto) for the table cells.</p>
|
|
5084
|
-
* @public
|
|
5085
|
-
*/
|
|
5086
|
-
HorizontalTextAlignment?: HorizontalTextAlignment | undefined;
|
|
5087
|
-
/**
|
|
5088
|
-
* <p>The vertical text alignment (top, middle, bottom) for the table cells.</p>
|
|
5089
|
-
* @public
|
|
5090
|
-
*/
|
|
5091
|
-
VerticalTextAlignment?: VerticalTextAlignment | undefined;
|
|
5092
|
-
/**
|
|
5093
|
-
* <p>The background color for the table cells.</p>
|
|
5094
|
-
* @public
|
|
5095
|
-
*/
|
|
5096
|
-
BackgroundColor?: string | undefined;
|
|
5097
|
-
/**
|
|
5098
|
-
* <p>The height color for the table cells.</p>
|
|
5099
|
-
* @public
|
|
5100
|
-
*/
|
|
5101
|
-
Height?: number | undefined;
|
|
5102
|
-
/**
|
|
5103
|
-
* <p>The borders for the table cells.</p>
|
|
5104
|
-
* @public
|
|
5105
|
-
*/
|
|
5106
|
-
Border?: GlobalTableBorderOptions | undefined;
|
|
5107
|
-
}
|
|
5108
|
-
/**
|
|
5109
|
-
* @public
|
|
5110
|
-
* @enum
|
|
5111
|
-
*/
|
|
5112
|
-
export declare const PivotTableMetricPlacement: {
|
|
5113
|
-
readonly COLUMN: "COLUMN";
|
|
5114
|
-
readonly ROW: "ROW";
|
|
5115
|
-
};
|
|
5116
|
-
/**
|
|
5117
|
-
* @public
|
|
5118
|
-
*/
|
|
5119
|
-
export type PivotTableMetricPlacement = (typeof PivotTableMetricPlacement)[keyof typeof PivotTableMetricPlacement];
|
|
5120
|
-
/**
|
|
5121
|
-
* <p>Determines the row alternate color options.</p>
|
|
5122
|
-
* @public
|
|
5123
|
-
*/
|
|
5124
|
-
export interface RowAlternateColorOptions {
|
|
5125
|
-
/**
|
|
5126
|
-
* <p>Determines the widget status.</p>
|
|
5127
|
-
* @public
|
|
5128
|
-
*/
|
|
5129
|
-
Status?: WidgetStatus | undefined;
|
|
5130
|
-
/**
|
|
5131
|
-
* <p>Determines the list of row alternate colors.</p>
|
|
5132
|
-
* @public
|
|
5133
|
-
*/
|
|
5134
|
-
RowAlternateColors?: string[] | undefined;
|
|
5135
|
-
/**
|
|
5136
|
-
* <p>The primary background color options for alternate rows.</p>
|
|
5137
|
-
* @public
|
|
5138
|
-
*/
|
|
5139
|
-
UsePrimaryBackgroundColor?: WidgetStatus | undefined;
|
|
5140
|
-
}
|
|
5141
|
-
/**
|
|
5142
|
-
* <p>The options for the label thta is located above the row headers. This option is only applicable when <code>RowsLayout</code> is set to <code>HIERARCHY</code>.</p>
|
|
5143
|
-
* @public
|
|
5144
|
-
*/
|
|
5145
|
-
export interface PivotTableRowsLabelOptions {
|
|
5146
|
-
/**
|
|
5147
|
-
* <p>The visibility of the rows label.</p>
|
|
5148
|
-
* @public
|
|
5149
|
-
*/
|
|
5150
|
-
Visibility?: Visibility | undefined;
|
|
5151
|
-
/**
|
|
5152
|
-
* <p>The custom label string for the rows label.</p>
|
|
5153
|
-
* @public
|
|
5154
|
-
*/
|
|
5155
|
-
CustomLabel?: string | undefined;
|
|
5156
|
-
}
|
|
5157
|
-
/**
|
|
5158
|
-
* @public
|
|
5159
|
-
* @enum
|
|
5160
|
-
*/
|
|
5161
|
-
export declare const PivotTableRowsLayout: {
|
|
5162
|
-
readonly HIERARCHY: "HIERARCHY";
|
|
5163
|
-
readonly TABULAR: "TABULAR";
|
|
5164
|
-
};
|
|
5165
|
-
/**
|
|
5166
|
-
* @public
|
|
5167
|
-
*/
|
|
5168
|
-
export type PivotTableRowsLayout = (typeof PivotTableRowsLayout)[keyof typeof PivotTableRowsLayout];
|
|
5169
|
-
/**
|
|
5170
|
-
* <p>The table options for a pivot table visual.</p>
|
|
5171
|
-
* @public
|
|
5172
|
-
*/
|
|
5173
|
-
export interface PivotTableOptions {
|
|
5174
|
-
/**
|
|
5175
|
-
* <p>The metric placement (row, column) options.</p>
|
|
5176
|
-
* @public
|
|
5177
|
-
*/
|
|
5178
|
-
MetricPlacement?: PivotTableMetricPlacement | undefined;
|
|
5179
|
-
/**
|
|
5180
|
-
* <p>The visibility of the single metric options.</p>
|
|
5181
|
-
* @public
|
|
5182
|
-
*/
|
|
5183
|
-
SingleMetricVisibility?: Visibility | undefined;
|
|
5184
|
-
/**
|
|
5185
|
-
* <p>The visibility of the column names.</p>
|
|
5186
|
-
* @public
|
|
5187
|
-
*/
|
|
5188
|
-
ColumnNamesVisibility?: Visibility | undefined;
|
|
5189
|
-
/**
|
|
5190
|
-
* <p>Determines the visibility of the pivot table.</p>
|
|
5191
|
-
* @public
|
|
5192
|
-
*/
|
|
5193
|
-
ToggleButtonsVisibility?: Visibility | undefined;
|
|
5194
|
-
/**
|
|
5195
|
-
* <p>The table cell style of the column header.</p>
|
|
5196
|
-
* @public
|
|
5197
|
-
*/
|
|
5198
|
-
ColumnHeaderStyle?: TableCellStyle | undefined;
|
|
5199
|
-
/**
|
|
5200
|
-
* <p>The table cell style of the row headers.</p>
|
|
5201
|
-
* @public
|
|
5202
|
-
*/
|
|
5203
|
-
RowHeaderStyle?: TableCellStyle | undefined;
|
|
5204
|
-
/**
|
|
5205
|
-
* <p>The table cell style of cells.</p>
|
|
5206
|
-
* @public
|
|
5207
|
-
*/
|
|
5208
|
-
CellStyle?: TableCellStyle | undefined;
|
|
5209
|
-
/**
|
|
5210
|
-
* <p>The table cell style of row field names.</p>
|
|
5211
|
-
* @public
|
|
5212
|
-
*/
|
|
5213
|
-
RowFieldNamesStyle?: TableCellStyle | undefined;
|
|
5214
|
-
/**
|
|
5215
|
-
* <p>The row alternate color options (widget status, row alternate colors).</p>
|
|
5216
|
-
* @public
|
|
5217
|
-
*/
|
|
5218
|
-
RowAlternateColorOptions?: RowAlternateColorOptions | undefined;
|
|
5219
|
-
/**
|
|
5220
|
-
* <p>The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is <code>HIDDEN</code>, all collapsed columns in a pivot table are automatically hidden. The default value is <code>VISIBLE</code>.</p>
|
|
5221
|
-
* @public
|
|
5222
|
-
*/
|
|
5223
|
-
CollapsedRowDimensionsVisibility?: Visibility | undefined;
|
|
5224
|
-
/**
|
|
5225
|
-
* <p>The layout for the row dimension headers of a pivot table. Choose one of the following options.</p>
|
|
5226
|
-
* <ul>
|
|
5227
|
-
* <li>
|
|
5228
|
-
* <p>
|
|
5229
|
-
* <code>TABULAR</code>: (Default) Each row field is displayed in a separate column.</p>
|
|
5230
|
-
* </li>
|
|
5231
|
-
* <li>
|
|
5232
|
-
* <p>
|
|
5233
|
-
* <code>HIERARCHY</code>: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.</p>
|
|
5234
|
-
* </li>
|
|
5235
|
-
* </ul>
|
|
5236
|
-
* @public
|
|
5237
|
-
*/
|
|
5238
|
-
RowsLayout?: PivotTableRowsLayout | undefined;
|
|
5239
|
-
/**
|
|
5240
|
-
* <p>The options for the label that is located above the row headers. This option is only applicable when <code>RowsLayout</code> is set to <code>HIERARCHY</code>.</p>
|
|
5241
|
-
* @public
|
|
5242
|
-
*/
|
|
5243
|
-
RowsLabelOptions?: PivotTableRowsLabelOptions | undefined;
|
|
5244
|
-
/**
|
|
5245
|
-
* <p>The default cell width of the pivot table.</p>
|
|
5246
|
-
* @public
|
|
5247
|
-
*/
|
|
5248
|
-
DefaultCellWidth?: string | undefined;
|
|
5249
|
-
}
|
|
5250
|
-
/**
|
|
5251
|
-
* @public
|
|
5252
|
-
* @enum
|
|
5253
|
-
*/
|
|
5254
|
-
export declare const PivotTableSubtotalLevel: {
|
|
5255
|
-
readonly ALL: "ALL";
|
|
5256
|
-
readonly CUSTOM: "CUSTOM";
|
|
5257
|
-
readonly LAST: "LAST";
|
|
5258
|
-
};
|
|
5259
|
-
/**
|
|
5260
|
-
* @public
|
|
5261
|
-
*/
|
|
5262
|
-
export type PivotTableSubtotalLevel = (typeof PivotTableSubtotalLevel)[keyof typeof PivotTableSubtotalLevel];
|
|
5263
|
-
/**
|
|
5264
|
-
* <p>The optional configuration of subtotals cells.</p>
|
|
5265
|
-
* @public
|
|
5266
|
-
*/
|
|
5267
|
-
export interface PivotTableFieldSubtotalOptions {
|
|
5210
|
+
* <p>The forecast properties setup of a forecast in the line
|
|
5211
|
+
* chart.</p>
|
|
5212
|
+
* @public
|
|
5213
|
+
*/
|
|
5214
|
+
ForecastProperties?: TimeBasedForecastProperties | undefined;
|
|
5268
5215
|
/**
|
|
5269
|
-
* <p>The
|
|
5216
|
+
* <p>The forecast scenario of a forecast in the line chart.</p>
|
|
5270
5217
|
* @public
|
|
5271
5218
|
*/
|
|
5272
|
-
|
|
5219
|
+
Scenario?: ForecastScenario | undefined;
|
|
5273
5220
|
}
|
|
5274
5221
|
/**
|
|
5275
5222
|
* @public
|
|
5276
5223
|
* @enum
|
|
5277
5224
|
*/
|
|
5278
|
-
export declare const
|
|
5279
|
-
readonly
|
|
5280
|
-
readonly
|
|
5281
|
-
readonly
|
|
5225
|
+
export declare const MissingDataTreatmentOption: {
|
|
5226
|
+
readonly INTERPOLATE: "INTERPOLATE";
|
|
5227
|
+
readonly SHOW_AS_BLANK: "SHOW_AS_BLANK";
|
|
5228
|
+
readonly SHOW_AS_ZERO: "SHOW_AS_ZERO";
|
|
5282
5229
|
};
|
|
5283
5230
|
/**
|
|
5284
5231
|
* @public
|
|
5285
5232
|
*/
|
|
5286
|
-
export type
|
|
5233
|
+
export type MissingDataTreatmentOption = (typeof MissingDataTreatmentOption)[keyof typeof MissingDataTreatmentOption];
|
|
5287
5234
|
/**
|
|
5288
|
-
* <p>The
|
|
5235
|
+
* <p>The configuration options that determine how missing data is treated during the rendering of a line chart.</p>
|
|
5289
5236
|
* @public
|
|
5290
5237
|
*/
|
|
5291
|
-
export interface
|
|
5238
|
+
export interface MissingDataConfiguration {
|
|
5292
5239
|
/**
|
|
5293
|
-
* <p>The
|
|
5240
|
+
* <p>The treatment option that determines how missing data should be rendered. Choose
|
|
5241
|
+
* from the following options:</p>
|
|
5242
|
+
* <ul>
|
|
5243
|
+
* <li>
|
|
5244
|
+
* <p>
|
|
5245
|
+
* <code>INTERPOLATE</code>: Interpolate missing values between the prior and the next known value.</p>
|
|
5246
|
+
* </li>
|
|
5247
|
+
* <li>
|
|
5248
|
+
* <p>
|
|
5249
|
+
* <code>SHOW_AS_ZERO</code>: Show missing values as the value <code>0</code>.</p>
|
|
5250
|
+
* </li>
|
|
5251
|
+
* <li>
|
|
5252
|
+
* <p>
|
|
5253
|
+
* <code>SHOW_AS_BLANK</code>: Display a blank space when rendering missing data.</p>
|
|
5254
|
+
* </li>
|
|
5255
|
+
* </ul>
|
|
5294
5256
|
* @public
|
|
5295
5257
|
*/
|
|
5296
|
-
|
|
5258
|
+
TreatmentOption?: MissingDataTreatmentOption | undefined;
|
|
5297
5259
|
}
|
|
5298
5260
|
/**
|
|
5299
|
-
* <p>The
|
|
5261
|
+
* <p>The series axis configuration of a line chart.</p>
|
|
5300
5262
|
* @public
|
|
5301
5263
|
*/
|
|
5302
|
-
export interface
|
|
5264
|
+
export interface LineSeriesAxisDisplayOptions {
|
|
5303
5265
|
/**
|
|
5304
|
-
* <p>The
|
|
5266
|
+
* <p>The options that determine the presentation of the line series axis.</p>
|
|
5305
5267
|
* @public
|
|
5306
5268
|
*/
|
|
5307
|
-
|
|
5269
|
+
AxisOptions?: AxisDisplayOptions | undefined;
|
|
5308
5270
|
/**
|
|
5309
|
-
* <p>The
|
|
5271
|
+
* <p>The configuration options that determine how missing data is treated during the rendering of a line chart.</p>
|
|
5310
5272
|
* @public
|
|
5311
5273
|
*/
|
|
5312
|
-
|
|
5274
|
+
MissingDataConfigurations?: MissingDataConfiguration[] | undefined;
|
|
5275
|
+
}
|
|
5276
|
+
/**
|
|
5277
|
+
* <p>The options that determine the presentation of a line series in the visual</p>
|
|
5278
|
+
* @public
|
|
5279
|
+
*/
|
|
5280
|
+
export interface LineChartSeriesSettings {
|
|
5313
5281
|
/**
|
|
5314
|
-
* <p>
|
|
5282
|
+
* <p>Line styles options for a line series in <code>LineChartVisual</code>.</p>
|
|
5315
5283
|
* @public
|
|
5316
5284
|
*/
|
|
5317
|
-
|
|
5285
|
+
LineStyleSettings?: LineChartLineStyleSettings | undefined;
|
|
5318
5286
|
/**
|
|
5319
|
-
* <p>
|
|
5287
|
+
* <p>Marker styles options for a line series in <code>LineChartVisual</code>.</p>
|
|
5320
5288
|
* @public
|
|
5321
5289
|
*/
|
|
5322
|
-
|
|
5290
|
+
MarkerStyleSettings?: LineChartMarkerStyleSettings | undefined;
|
|
5291
|
+
}
|
|
5292
|
+
/**
|
|
5293
|
+
* <p>The data field series item configuration of a line chart.</p>
|
|
5294
|
+
* @public
|
|
5295
|
+
*/
|
|
5296
|
+
export interface DataFieldSeriesItem {
|
|
5323
5297
|
/**
|
|
5324
|
-
* <p>The
|
|
5298
|
+
* <p>The field ID of the field that you are setting the axis binding to.</p>
|
|
5325
5299
|
* @public
|
|
5326
5300
|
*/
|
|
5327
|
-
|
|
5301
|
+
FieldId: string | undefined;
|
|
5328
5302
|
/**
|
|
5329
|
-
* <p>The
|
|
5303
|
+
* <p>The field value of the field that you are setting the axis binding to.</p>
|
|
5330
5304
|
* @public
|
|
5331
5305
|
*/
|
|
5332
|
-
|
|
5306
|
+
FieldValue?: string | undefined;
|
|
5333
5307
|
/**
|
|
5334
|
-
* <p>The
|
|
5308
|
+
* <p>The axis that you are binding the field to.</p>
|
|
5335
5309
|
* @public
|
|
5336
5310
|
*/
|
|
5337
|
-
|
|
5311
|
+
AxisBinding: AxisBinding | undefined;
|
|
5338
5312
|
/**
|
|
5339
|
-
* <p>The
|
|
5313
|
+
* <p>The options that determine the presentation of line series associated to the field.</p>
|
|
5340
5314
|
* @public
|
|
5341
5315
|
*/
|
|
5342
|
-
|
|
5316
|
+
Settings?: LineChartSeriesSettings | undefined;
|
|
5343
5317
|
}
|
|
5344
5318
|
/**
|
|
5345
|
-
*
|
|
5346
|
-
* @enum
|
|
5347
|
-
*/
|
|
5348
|
-
export declare const TableTotalsPlacement: {
|
|
5349
|
-
readonly AUTO: "AUTO";
|
|
5350
|
-
readonly END: "END";
|
|
5351
|
-
readonly START: "START";
|
|
5352
|
-
};
|
|
5353
|
-
/**
|
|
5354
|
-
* @public
|
|
5355
|
-
*/
|
|
5356
|
-
export type TableTotalsPlacement = (typeof TableTotalsPlacement)[keyof typeof TableTotalsPlacement];
|
|
5357
|
-
/**
|
|
5358
|
-
* @public
|
|
5359
|
-
* @enum
|
|
5360
|
-
*/
|
|
5361
|
-
export declare const TableTotalsScrollStatus: {
|
|
5362
|
-
readonly PINNED: "PINNED";
|
|
5363
|
-
readonly SCROLLED: "SCROLLED";
|
|
5364
|
-
};
|
|
5365
|
-
/**
|
|
5366
|
-
* @public
|
|
5367
|
-
*/
|
|
5368
|
-
export type TableTotalsScrollStatus = (typeof TableTotalsScrollStatus)[keyof typeof TableTotalsScrollStatus];
|
|
5369
|
-
/**
|
|
5370
|
-
* @public
|
|
5371
|
-
* @enum
|
|
5372
|
-
*/
|
|
5373
|
-
export declare const SimpleTotalAggregationFunction: {
|
|
5374
|
-
readonly AVERAGE: "AVERAGE";
|
|
5375
|
-
readonly DEFAULT: "DEFAULT";
|
|
5376
|
-
readonly MAX: "MAX";
|
|
5377
|
-
readonly MIN: "MIN";
|
|
5378
|
-
readonly NONE: "NONE";
|
|
5379
|
-
readonly SUM: "SUM";
|
|
5380
|
-
};
|
|
5381
|
-
/**
|
|
5382
|
-
* @public
|
|
5383
|
-
*/
|
|
5384
|
-
export type SimpleTotalAggregationFunction = (typeof SimpleTotalAggregationFunction)[keyof typeof SimpleTotalAggregationFunction];
|
|
5385
|
-
/**
|
|
5386
|
-
* <p>An aggregation function that aggregates the total values of a measure.</p>
|
|
5319
|
+
* <p>The field series item configuration of a line chart.</p>
|
|
5387
5320
|
* @public
|
|
5388
5321
|
*/
|
|
5389
|
-
export interface
|
|
5322
|
+
export interface FieldSeriesItem {
|
|
5390
5323
|
/**
|
|
5391
|
-
* <p>
|
|
5324
|
+
* <p>The field ID of the field for which you are setting the axis binding.</p>
|
|
5392
5325
|
* @public
|
|
5393
5326
|
*/
|
|
5394
|
-
|
|
5395
|
-
}
|
|
5396
|
-
/**
|
|
5397
|
-
* <p>The total aggregation settings map of a field id.</p>
|
|
5398
|
-
* @public
|
|
5399
|
-
*/
|
|
5400
|
-
export interface TotalAggregationOption {
|
|
5327
|
+
FieldId: string | undefined;
|
|
5401
5328
|
/**
|
|
5402
|
-
* <p>The
|
|
5329
|
+
* <p>The axis that you are binding the field to.</p>
|
|
5403
5330
|
* @public
|
|
5404
5331
|
*/
|
|
5405
|
-
|
|
5332
|
+
AxisBinding: AxisBinding | undefined;
|
|
5406
5333
|
/**
|
|
5407
|
-
* <p>The
|
|
5334
|
+
* <p>The options that determine the presentation of line series associated to the field.</p>
|
|
5408
5335
|
* @public
|
|
5409
5336
|
*/
|
|
5410
|
-
|
|
5337
|
+
Settings?: LineChartSeriesSettings | undefined;
|
|
5411
5338
|
}
|
|
5412
5339
|
/**
|
|
5413
|
-
* <p>The
|
|
5340
|
+
* <p>The series item configuration of a line chart.</p>
|
|
5341
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
5414
5342
|
* @public
|
|
5415
5343
|
*/
|
|
5416
|
-
export interface
|
|
5417
|
-
/**
|
|
5418
|
-
* <p>The visibility configuration for the total cells.</p>
|
|
5419
|
-
* @public
|
|
5420
|
-
*/
|
|
5421
|
-
TotalsVisibility?: Visibility | undefined;
|
|
5344
|
+
export interface SeriesItem {
|
|
5422
5345
|
/**
|
|
5423
|
-
* <p>The
|
|
5346
|
+
* <p>The field series item configuration of a line chart.</p>
|
|
5424
5347
|
* @public
|
|
5425
5348
|
*/
|
|
5426
|
-
|
|
5349
|
+
FieldSeriesItem?: FieldSeriesItem | undefined;
|
|
5427
5350
|
/**
|
|
5428
|
-
* <p>The
|
|
5351
|
+
* <p>The data field series item configuration of a line chart.</p>
|
|
5429
5352
|
* @public
|
|
5430
5353
|
*/
|
|
5431
|
-
|
|
5354
|
+
DataFieldSeriesItem?: DataFieldSeriesItem | undefined;
|
|
5355
|
+
}
|
|
5356
|
+
/**
|
|
5357
|
+
* <p>The sort configuration of a line chart.</p>
|
|
5358
|
+
* @public
|
|
5359
|
+
*/
|
|
5360
|
+
export interface LineChartSortConfiguration {
|
|
5432
5361
|
/**
|
|
5433
|
-
* <p>The
|
|
5362
|
+
* <p>The sort configuration of the category fields.</p>
|
|
5434
5363
|
* @public
|
|
5435
5364
|
*/
|
|
5436
|
-
|
|
5365
|
+
CategorySort?: FieldSortOptions[] | undefined;
|
|
5437
5366
|
/**
|
|
5438
|
-
* <p>The
|
|
5367
|
+
* <p>The limit on the number of categories that are displayed in a line chart.</p>
|
|
5439
5368
|
* @public
|
|
5440
5369
|
*/
|
|
5441
|
-
|
|
5370
|
+
CategoryItemsLimitConfiguration?: ItemsLimitConfiguration | undefined;
|
|
5442
5371
|
/**
|
|
5443
|
-
* <p>The
|
|
5372
|
+
* <p>The limit on the number of lines that are displayed in a line chart.</p>
|
|
5444
5373
|
* @public
|
|
5445
5374
|
*/
|
|
5446
|
-
|
|
5375
|
+
ColorItemsLimitConfiguration?: ItemsLimitConfiguration | undefined;
|
|
5447
5376
|
/**
|
|
5448
|
-
* <p>The
|
|
5377
|
+
* <p>The sort configuration of the small multiples field.</p>
|
|
5449
5378
|
* @public
|
|
5450
5379
|
*/
|
|
5451
|
-
|
|
5380
|
+
SmallMultiplesSort?: FieldSortOptions[] | undefined;
|
|
5452
5381
|
/**
|
|
5453
|
-
* <p>The
|
|
5382
|
+
* <p>The limit on the number of small multiples panels that are displayed.</p>
|
|
5454
5383
|
* @public
|
|
5455
5384
|
*/
|
|
5456
|
-
|
|
5385
|
+
SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration | undefined;
|
|
5457
5386
|
}
|
|
5458
5387
|
/**
|
|
5459
|
-
* <p>The total options for a pivot table visual.</p>
|
|
5460
5388
|
* @public
|
|
5389
|
+
* @enum
|
|
5461
5390
|
*/
|
|
5462
|
-
export
|
|
5391
|
+
export declare const LineChartType: {
|
|
5392
|
+
readonly AREA: "AREA";
|
|
5393
|
+
readonly LINE: "LINE";
|
|
5394
|
+
readonly STACKED_AREA: "STACKED_AREA";
|
|
5395
|
+
};
|
|
5396
|
+
/**
|
|
5397
|
+
* @public
|
|
5398
|
+
*/
|
|
5399
|
+
export type LineChartType = (typeof LineChartType)[keyof typeof LineChartType];
|
|
5400
|
+
/**
|
|
5401
|
+
* <p>The configuration of a line chart.</p>
|
|
5402
|
+
* @public
|
|
5403
|
+
*/
|
|
5404
|
+
export interface LineChartConfiguration {
|
|
5463
5405
|
/**
|
|
5464
|
-
* <p>The
|
|
5406
|
+
* <p>The field well configuration of a line chart.</p>
|
|
5465
5407
|
* @public
|
|
5466
5408
|
*/
|
|
5467
|
-
|
|
5409
|
+
FieldWells?: LineChartFieldWells | undefined;
|
|
5468
5410
|
/**
|
|
5469
|
-
* <p>The
|
|
5411
|
+
* <p>The sort configuration of a line chart.</p>
|
|
5470
5412
|
* @public
|
|
5471
5413
|
*/
|
|
5472
|
-
|
|
5414
|
+
SortConfiguration?: LineChartSortConfiguration | undefined;
|
|
5473
5415
|
/**
|
|
5474
|
-
* <p>The
|
|
5416
|
+
* <p>The forecast configuration of a line chart.</p>
|
|
5475
5417
|
* @public
|
|
5476
5418
|
*/
|
|
5477
|
-
|
|
5419
|
+
ForecastConfigurations?: ForecastConfiguration[] | undefined;
|
|
5478
5420
|
/**
|
|
5479
|
-
* <p>
|
|
5421
|
+
* <p>Determines the type of the line chart.</p>
|
|
5480
5422
|
* @public
|
|
5481
5423
|
*/
|
|
5482
|
-
|
|
5483
|
-
}
|
|
5484
|
-
/**
|
|
5485
|
-
* <p>The configuration for a <code>PivotTableVisual</code>.</p>
|
|
5486
|
-
* @public
|
|
5487
|
-
*/
|
|
5488
|
-
export interface PivotTableConfiguration {
|
|
5424
|
+
Type?: LineChartType | undefined;
|
|
5489
5425
|
/**
|
|
5490
|
-
* <p>The
|
|
5426
|
+
* <p>The small multiples setup for the visual.</p>
|
|
5491
5427
|
* @public
|
|
5492
5428
|
*/
|
|
5493
|
-
|
|
5429
|
+
SmallMultiplesOptions?: SmallMultiplesOptions | undefined;
|
|
5494
5430
|
/**
|
|
5495
|
-
* <p>The
|
|
5431
|
+
* <p>The options that determine the presentation of the x-axis.</p>
|
|
5496
5432
|
* @public
|
|
5497
5433
|
*/
|
|
5498
|
-
|
|
5434
|
+
XAxisDisplayOptions?: AxisDisplayOptions | undefined;
|
|
5499
5435
|
/**
|
|
5500
|
-
* <p>The
|
|
5436
|
+
* <p>The options that determine the presentation of the x-axis label.</p>
|
|
5501
5437
|
* @public
|
|
5502
5438
|
*/
|
|
5503
|
-
|
|
5439
|
+
XAxisLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
5504
5440
|
/**
|
|
5505
|
-
* <p>The
|
|
5441
|
+
* <p>The series axis configuration of a line chart.</p>
|
|
5506
5442
|
* @public
|
|
5507
5443
|
*/
|
|
5508
|
-
|
|
5444
|
+
PrimaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions | undefined;
|
|
5509
5445
|
/**
|
|
5510
|
-
* <p>The
|
|
5446
|
+
* <p>The options that determine the presentation of the y-axis label.</p>
|
|
5511
5447
|
* @public
|
|
5512
5448
|
*/
|
|
5513
|
-
|
|
5449
|
+
PrimaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
5514
5450
|
/**
|
|
5515
|
-
* <p>The
|
|
5451
|
+
* <p>The series axis configuration of a line chart.</p>
|
|
5516
5452
|
* @public
|
|
5517
5453
|
*/
|
|
5518
|
-
|
|
5454
|
+
SecondaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions | undefined;
|
|
5519
5455
|
/**
|
|
5520
|
-
* <p>The
|
|
5456
|
+
* <p>The options that determine the presentation of the secondary y-axis label.</p>
|
|
5521
5457
|
* @public
|
|
5522
5458
|
*/
|
|
5523
|
-
|
|
5524
|
-
}
|
|
5525
|
-
/**
|
|
5526
|
-
* @public
|
|
5527
|
-
* @enum
|
|
5528
|
-
*/
|
|
5529
|
-
export declare const PivotTableConditionalFormattingScopeRole: {
|
|
5530
|
-
readonly FIELD: "FIELD";
|
|
5531
|
-
readonly FIELD_TOTAL: "FIELD_TOTAL";
|
|
5532
|
-
readonly GRAND_TOTAL: "GRAND_TOTAL";
|
|
5533
|
-
};
|
|
5534
|
-
/**
|
|
5535
|
-
* @public
|
|
5536
|
-
*/
|
|
5537
|
-
export type PivotTableConditionalFormattingScopeRole = (typeof PivotTableConditionalFormattingScopeRole)[keyof typeof PivotTableConditionalFormattingScopeRole];
|
|
5538
|
-
/**
|
|
5539
|
-
* <p>The scope of the cell for conditional formatting.</p>
|
|
5540
|
-
* @public
|
|
5541
|
-
*/
|
|
5542
|
-
export interface PivotTableConditionalFormattingScope {
|
|
5459
|
+
SecondaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
5543
5460
|
/**
|
|
5544
|
-
* <p>The
|
|
5461
|
+
* <p>The settings of a chart's single axis configuration.</p>
|
|
5545
5462
|
* @public
|
|
5546
5463
|
*/
|
|
5547
|
-
|
|
5548
|
-
}
|
|
5549
|
-
/**
|
|
5550
|
-
* <p>The conditional formatting for the text.</p>
|
|
5551
|
-
* @public
|
|
5552
|
-
*/
|
|
5553
|
-
export interface TextConditionalFormat {
|
|
5464
|
+
SingleAxisOptions?: SingleAxisOptions | undefined;
|
|
5554
5465
|
/**
|
|
5555
|
-
* <p>The
|
|
5466
|
+
* <p>The options that determine the default presentation of all line series in <code>LineChartVisual</code>.</p>
|
|
5556
5467
|
* @public
|
|
5557
5468
|
*/
|
|
5558
|
-
|
|
5469
|
+
DefaultSeriesSettings?: LineChartDefaultSeriesSettings | undefined;
|
|
5559
5470
|
/**
|
|
5560
|
-
* <p>The
|
|
5471
|
+
* <p>The series item configuration of a line chart.</p>
|
|
5561
5472
|
* @public
|
|
5562
5473
|
*/
|
|
5563
|
-
|
|
5474
|
+
Series?: SeriesItem[] | undefined;
|
|
5564
5475
|
/**
|
|
5565
|
-
* <p>The
|
|
5476
|
+
* <p>The legend configuration of a line chart.</p>
|
|
5566
5477
|
* @public
|
|
5567
5478
|
*/
|
|
5568
|
-
|
|
5569
|
-
}
|
|
5570
|
-
/**
|
|
5571
|
-
* <p>The cell conditional formatting option for a pivot table.</p>
|
|
5572
|
-
* @public
|
|
5573
|
-
*/
|
|
5574
|
-
export interface PivotTableCellConditionalFormatting {
|
|
5479
|
+
Legend?: LegendOptions | undefined;
|
|
5575
5480
|
/**
|
|
5576
|
-
* <p>The
|
|
5481
|
+
* <p>The data label configuration of a line chart.</p>
|
|
5577
5482
|
* @public
|
|
5578
5483
|
*/
|
|
5579
|
-
|
|
5484
|
+
DataLabels?: DataLabelOptions | undefined;
|
|
5580
5485
|
/**
|
|
5581
|
-
* <p>The
|
|
5486
|
+
* <p>The reference lines configuration of a line chart.</p>
|
|
5582
5487
|
* @public
|
|
5583
5488
|
*/
|
|
5584
|
-
|
|
5489
|
+
ReferenceLines?: ReferenceLine[] | undefined;
|
|
5585
5490
|
/**
|
|
5586
|
-
* <p>The
|
|
5491
|
+
* <p>The tooltip configuration of a line chart.</p>
|
|
5587
5492
|
* @public
|
|
5588
5493
|
*/
|
|
5589
|
-
|
|
5494
|
+
Tooltip?: TooltipOptions | undefined;
|
|
5590
5495
|
/**
|
|
5591
|
-
* <p>
|
|
5496
|
+
* <p>The default configuration of a line chart's contribution analysis.</p>
|
|
5592
5497
|
* @public
|
|
5593
5498
|
*/
|
|
5594
|
-
|
|
5595
|
-
}
|
|
5596
|
-
/**
|
|
5597
|
-
* <p>Conditional formatting options for a <code>PivotTableVisual</code>.</p>
|
|
5598
|
-
* @public
|
|
5599
|
-
*/
|
|
5600
|
-
export interface PivotTableConditionalFormattingOption {
|
|
5499
|
+
ContributionAnalysisDefaults?: ContributionAnalysisDefault[] | undefined;
|
|
5601
5500
|
/**
|
|
5602
|
-
* <p>The
|
|
5501
|
+
* <p>The visual palette configuration of a line chart.</p>
|
|
5603
5502
|
* @public
|
|
5604
5503
|
*/
|
|
5605
|
-
|
|
5606
|
-
}
|
|
5607
|
-
/**
|
|
5608
|
-
* <p>The conditional formatting for a <code>PivotTableVisual</code>.</p>
|
|
5609
|
-
* @public
|
|
5610
|
-
*/
|
|
5611
|
-
export interface PivotTableConditionalFormatting {
|
|
5504
|
+
VisualPalette?: VisualPalette | undefined;
|
|
5612
5505
|
/**
|
|
5613
|
-
* <p>
|
|
5506
|
+
* <p>The general visual interactions setup for a visual.</p>
|
|
5614
5507
|
* @public
|
|
5615
5508
|
*/
|
|
5616
|
-
|
|
5509
|
+
Interactions?: VisualInteractionOptions | undefined;
|
|
5617
5510
|
}
|
|
5618
5511
|
/**
|
|
5619
|
-
* <p>A
|
|
5620
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/
|
|
5512
|
+
* <p>A line chart.</p>
|
|
5513
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html">Using line charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
5621
5514
|
* @public
|
|
5622
5515
|
*/
|
|
5623
|
-
export interface
|
|
5516
|
+
export interface LineChartVisual {
|
|
5624
5517
|
/**
|
|
5625
|
-
* <p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers
|
|
5518
|
+
* <p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>
|
|
5626
5519
|
* @public
|
|
5627
5520
|
*/
|
|
5628
5521
|
VisualId: string | undefined;
|
|
@@ -5637,206 +5530,215 @@ export interface PivotTableVisual {
|
|
|
5637
5530
|
*/
|
|
5638
5531
|
Subtitle?: VisualSubtitleLabelOptions | undefined;
|
|
5639
5532
|
/**
|
|
5640
|
-
* <p>The configuration
|
|
5533
|
+
* <p>The configuration of a line chart.</p>
|
|
5641
5534
|
* @public
|
|
5642
5535
|
*/
|
|
5643
|
-
ChartConfiguration?:
|
|
5536
|
+
ChartConfiguration?: LineChartConfiguration | undefined;
|
|
5644
5537
|
/**
|
|
5645
|
-
* <p>The
|
|
5538
|
+
* <p>The list of custom actions that are configured for a visual.</p>
|
|
5646
5539
|
* @public
|
|
5647
5540
|
*/
|
|
5648
|
-
|
|
5541
|
+
Actions?: VisualCustomAction[] | undefined;
|
|
5649
5542
|
/**
|
|
5650
|
-
* <p>The
|
|
5543
|
+
* <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
|
|
5651
5544
|
* @public
|
|
5652
5545
|
*/
|
|
5653
|
-
|
|
5546
|
+
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
5547
|
+
/**
|
|
5548
|
+
* <p>The alt text for the visual.</p>
|
|
5549
|
+
* @public
|
|
5550
|
+
*/
|
|
5551
|
+
VisualContentAltText?: string | undefined;
|
|
5654
5552
|
}
|
|
5655
5553
|
/**
|
|
5656
5554
|
* @public
|
|
5657
5555
|
* @enum
|
|
5658
5556
|
*/
|
|
5659
|
-
export declare const
|
|
5660
|
-
readonly
|
|
5661
|
-
readonly
|
|
5662
|
-
readonly
|
|
5557
|
+
export declare const ArcThickness: {
|
|
5558
|
+
readonly LARGE: "LARGE";
|
|
5559
|
+
readonly MEDIUM: "MEDIUM";
|
|
5560
|
+
readonly SMALL: "SMALL";
|
|
5561
|
+
readonly WHOLE: "WHOLE";
|
|
5663
5562
|
};
|
|
5664
5563
|
/**
|
|
5665
5564
|
* @public
|
|
5666
5565
|
*/
|
|
5667
|
-
export type
|
|
5566
|
+
export type ArcThickness = (typeof ArcThickness)[keyof typeof ArcThickness];
|
|
5668
5567
|
/**
|
|
5669
|
-
* <p>The
|
|
5568
|
+
* <p>The options that determine the arc thickness of a <code>GaugeChartVisual</code>.</p>
|
|
5670
5569
|
* @public
|
|
5671
5570
|
*/
|
|
5672
|
-
export interface
|
|
5571
|
+
export interface ArcOptions {
|
|
5673
5572
|
/**
|
|
5674
|
-
* <p>The
|
|
5573
|
+
* <p>The arc thickness of a <code>GaugeChartVisual</code>.</p>
|
|
5675
5574
|
* @public
|
|
5676
5575
|
*/
|
|
5677
|
-
|
|
5576
|
+
ArcThickness?: ArcThickness | undefined;
|
|
5577
|
+
}
|
|
5578
|
+
/**
|
|
5579
|
+
* <p>The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.</p>
|
|
5580
|
+
* @public
|
|
5581
|
+
*/
|
|
5582
|
+
export interface DonutCenterOptions {
|
|
5583
|
+
/**
|
|
5584
|
+
* <p>Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called <code>'Show total'</code>.</p>
|
|
5585
|
+
* @public
|
|
5586
|
+
*/
|
|
5587
|
+
LabelVisibility?: Visibility | undefined;
|
|
5678
5588
|
}
|
|
5679
5589
|
/**
|
|
5680
|
-
* <p>The
|
|
5590
|
+
* <p>The options for configuring a donut chart or pie chart.</p>
|
|
5681
5591
|
* @public
|
|
5682
5592
|
*/
|
|
5683
|
-
export interface
|
|
5593
|
+
export interface DonutOptions {
|
|
5594
|
+
/**
|
|
5595
|
+
* <p>The option for define the arc of the chart shape. Valid values are as follows:</p>
|
|
5596
|
+
* <ul>
|
|
5597
|
+
* <li>
|
|
5598
|
+
* <p>
|
|
5599
|
+
* <code>WHOLE</code> - A pie chart</p>
|
|
5600
|
+
* </li>
|
|
5601
|
+
* <li>
|
|
5602
|
+
* <p>
|
|
5603
|
+
* <code>SMALL</code>- A small-sized donut chart</p>
|
|
5604
|
+
* </li>
|
|
5605
|
+
* <li>
|
|
5606
|
+
* <p>
|
|
5607
|
+
* <code>MEDIUM</code>- A medium-sized donut chart</p>
|
|
5608
|
+
* </li>
|
|
5609
|
+
* <li>
|
|
5610
|
+
* <p>
|
|
5611
|
+
* <code>LARGE</code>- A large-sized donut chart</p>
|
|
5612
|
+
* </li>
|
|
5613
|
+
* </ul>
|
|
5614
|
+
* @public
|
|
5615
|
+
*/
|
|
5616
|
+
ArcOptions?: ArcOptions | undefined;
|
|
5684
5617
|
/**
|
|
5685
|
-
* <p>The
|
|
5618
|
+
* <p>The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.</p>
|
|
5686
5619
|
* @public
|
|
5687
5620
|
*/
|
|
5688
|
-
|
|
5621
|
+
DonutCenterOptions?: DonutCenterOptions | undefined;
|
|
5689
5622
|
}
|
|
5690
5623
|
/**
|
|
5691
|
-
* <p>The
|
|
5624
|
+
* <p>The field well configuration of a pie chart.</p>
|
|
5692
5625
|
* @public
|
|
5693
5626
|
*/
|
|
5694
|
-
export interface
|
|
5627
|
+
export interface PieChartAggregatedFieldWells {
|
|
5695
5628
|
/**
|
|
5696
|
-
* <p>The
|
|
5629
|
+
* <p>The category (group/color) field wells of a pie chart.</p>
|
|
5697
5630
|
* @public
|
|
5698
5631
|
*/
|
|
5699
5632
|
Category?: DimensionField[] | undefined;
|
|
5700
5633
|
/**
|
|
5701
|
-
* <p>The
|
|
5634
|
+
* <p>The value field wells of a pie chart. Values are aggregated based on categories.</p>
|
|
5702
5635
|
* @public
|
|
5703
5636
|
*/
|
|
5704
|
-
|
|
5637
|
+
Values?: MeasureField[] | undefined;
|
|
5705
5638
|
/**
|
|
5706
|
-
* <p>The
|
|
5639
|
+
* <p>The small multiples field well of a pie chart.</p>
|
|
5707
5640
|
* @public
|
|
5708
5641
|
*/
|
|
5709
|
-
|
|
5642
|
+
SmallMultiples?: DimensionField[] | undefined;
|
|
5710
5643
|
}
|
|
5711
5644
|
/**
|
|
5712
|
-
* <p>The field
|
|
5645
|
+
* <p>The field well configuration of a pie chart.</p>
|
|
5646
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
5713
5647
|
* @public
|
|
5714
5648
|
*/
|
|
5715
|
-
export interface
|
|
5649
|
+
export interface PieChartFieldWells {
|
|
5716
5650
|
/**
|
|
5717
|
-
* <p>The
|
|
5651
|
+
* <p>The field well configuration of a pie chart.</p>
|
|
5718
5652
|
* @public
|
|
5719
5653
|
*/
|
|
5720
|
-
|
|
5654
|
+
PieChartAggregatedFieldWells?: PieChartAggregatedFieldWells | undefined;
|
|
5721
5655
|
}
|
|
5722
5656
|
/**
|
|
5723
|
-
*
|
|
5724
|
-
* @enum
|
|
5725
|
-
*/
|
|
5726
|
-
export declare const RadarChartShape: {
|
|
5727
|
-
readonly CIRCLE: "CIRCLE";
|
|
5728
|
-
readonly POLYGON: "POLYGON";
|
|
5729
|
-
};
|
|
5730
|
-
/**
|
|
5731
|
-
* @public
|
|
5732
|
-
*/
|
|
5733
|
-
export type RadarChartShape = (typeof RadarChartShape)[keyof typeof RadarChartShape];
|
|
5734
|
-
/**
|
|
5735
|
-
* <p>The sort configuration of a <code>RadarChartVisual</code>.</p>
|
|
5657
|
+
* <p>The sort configuration of a pie chart.</p>
|
|
5736
5658
|
* @public
|
|
5737
5659
|
*/
|
|
5738
|
-
export interface
|
|
5660
|
+
export interface PieChartSortConfiguration {
|
|
5739
5661
|
/**
|
|
5740
|
-
* <p>The
|
|
5662
|
+
* <p>The sort configuration of the category fields.</p>
|
|
5741
5663
|
* @public
|
|
5742
5664
|
*/
|
|
5743
5665
|
CategorySort?: FieldSortOptions[] | undefined;
|
|
5744
5666
|
/**
|
|
5745
|
-
* <p>The
|
|
5667
|
+
* <p>The limit on the number of categories that are displayed in a pie chart.</p>
|
|
5746
5668
|
* @public
|
|
5747
5669
|
*/
|
|
5748
5670
|
CategoryItemsLimit?: ItemsLimitConfiguration | undefined;
|
|
5749
5671
|
/**
|
|
5750
|
-
* <p>The
|
|
5672
|
+
* <p>The sort configuration of the small multiples field.</p>
|
|
5751
5673
|
* @public
|
|
5752
5674
|
*/
|
|
5753
|
-
|
|
5675
|
+
SmallMultiplesSort?: FieldSortOptions[] | undefined;
|
|
5754
5676
|
/**
|
|
5755
|
-
* <p>The
|
|
5677
|
+
* <p>The limit on the number of small multiples panels that are displayed.</p>
|
|
5756
5678
|
* @public
|
|
5757
5679
|
*/
|
|
5758
|
-
|
|
5680
|
+
SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration | undefined;
|
|
5759
5681
|
}
|
|
5760
5682
|
/**
|
|
5761
|
-
* <p>The configuration of a
|
|
5683
|
+
* <p>The configuration of a pie chart.</p>
|
|
5762
5684
|
* @public
|
|
5763
5685
|
*/
|
|
5764
|
-
export interface
|
|
5765
|
-
/**
|
|
5766
|
-
* <p>The field well configuration of a <code>RadarChartVisual</code>.</p>
|
|
5767
|
-
* @public
|
|
5768
|
-
*/
|
|
5769
|
-
FieldWells?: RadarChartFieldWells | undefined;
|
|
5770
|
-
/**
|
|
5771
|
-
* <p>The sort configuration of a <code>RadarChartVisual</code>.</p>
|
|
5772
|
-
* @public
|
|
5773
|
-
*/
|
|
5774
|
-
SortConfiguration?: RadarChartSortConfiguration | undefined;
|
|
5775
|
-
/**
|
|
5776
|
-
* <p>The shape of the radar chart.</p>
|
|
5777
|
-
* @public
|
|
5778
|
-
*/
|
|
5779
|
-
Shape?: RadarChartShape | undefined;
|
|
5780
|
-
/**
|
|
5781
|
-
* <p>The base sreies settings of a radar chart.</p>
|
|
5782
|
-
* @public
|
|
5783
|
-
*/
|
|
5784
|
-
BaseSeriesSettings?: RadarChartSeriesSettings | undefined;
|
|
5686
|
+
export interface PieChartConfiguration {
|
|
5785
5687
|
/**
|
|
5786
|
-
* <p>The
|
|
5688
|
+
* <p>The field wells of the visual.</p>
|
|
5787
5689
|
* @public
|
|
5788
5690
|
*/
|
|
5789
|
-
|
|
5691
|
+
FieldWells?: PieChartFieldWells | undefined;
|
|
5790
5692
|
/**
|
|
5791
|
-
* <p>The
|
|
5693
|
+
* <p>The sort configuration of a pie chart.</p>
|
|
5792
5694
|
* @public
|
|
5793
5695
|
*/
|
|
5794
|
-
|
|
5696
|
+
SortConfiguration?: PieChartSortConfiguration | undefined;
|
|
5795
5697
|
/**
|
|
5796
|
-
* <p>
|
|
5698
|
+
* <p>The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.</p>
|
|
5797
5699
|
* @public
|
|
5798
5700
|
*/
|
|
5799
|
-
|
|
5701
|
+
DonutOptions?: DonutOptions | undefined;
|
|
5800
5702
|
/**
|
|
5801
|
-
* <p>The
|
|
5703
|
+
* <p>The small multiples setup for the visual.</p>
|
|
5802
5704
|
* @public
|
|
5803
5705
|
*/
|
|
5804
|
-
|
|
5706
|
+
SmallMultiplesOptions?: SmallMultiplesOptions | undefined;
|
|
5805
5707
|
/**
|
|
5806
|
-
* <p>The
|
|
5708
|
+
* <p>The label options of the group/color that is displayed in a pie chart.</p>
|
|
5807
5709
|
* @public
|
|
5808
5710
|
*/
|
|
5809
|
-
|
|
5711
|
+
CategoryLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
5810
5712
|
/**
|
|
5811
|
-
* <p>The
|
|
5713
|
+
* <p>The label options for the value that is displayed in a pie chart.</p>
|
|
5812
5714
|
* @public
|
|
5813
5715
|
*/
|
|
5814
|
-
|
|
5716
|
+
ValueLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
5815
5717
|
/**
|
|
5816
|
-
* <p>The
|
|
5718
|
+
* <p>The legend display setup of the visual.</p>
|
|
5817
5719
|
* @public
|
|
5818
5720
|
*/
|
|
5819
|
-
|
|
5721
|
+
Legend?: LegendOptions | undefined;
|
|
5820
5722
|
/**
|
|
5821
|
-
* <p>The
|
|
5723
|
+
* <p>The options that determine if visual data labels are displayed.</p>
|
|
5822
5724
|
* @public
|
|
5823
5725
|
*/
|
|
5824
|
-
|
|
5726
|
+
DataLabels?: DataLabelOptions | undefined;
|
|
5825
5727
|
/**
|
|
5826
|
-
* <p>The
|
|
5728
|
+
* <p>The tooltip display setup of the visual.</p>
|
|
5827
5729
|
* @public
|
|
5828
5730
|
*/
|
|
5829
|
-
|
|
5731
|
+
Tooltip?: TooltipOptions | undefined;
|
|
5830
5732
|
/**
|
|
5831
|
-
* <p>The
|
|
5733
|
+
* <p>The palette (chart color) display setup of the visual.</p>
|
|
5832
5734
|
* @public
|
|
5833
5735
|
*/
|
|
5834
|
-
|
|
5736
|
+
VisualPalette?: VisualPalette | undefined;
|
|
5835
5737
|
/**
|
|
5836
|
-
* <p>The
|
|
5738
|
+
* <p>The contribution analysis (anomaly configuration) setup of the visual.</p>
|
|
5837
5739
|
* @public
|
|
5838
5740
|
*/
|
|
5839
|
-
|
|
5741
|
+
ContributionAnalysisDefaults?: ContributionAnalysisDefault[] | undefined;
|
|
5840
5742
|
/**
|
|
5841
5743
|
* <p>The general visual interactions setup for a visual.</p>
|
|
5842
5744
|
* @public
|
|
@@ -5844,10 +5746,22 @@ export interface RadarChartConfiguration {
|
|
|
5844
5746
|
Interactions?: VisualInteractionOptions | undefined;
|
|
5845
5747
|
}
|
|
5846
5748
|
/**
|
|
5847
|
-
* <p>A
|
|
5749
|
+
* <p>A pie or donut chart.</p>
|
|
5750
|
+
* <p>The <code>PieChartVisual</code> structure describes a visual that is a member of the pie chart family.</p>
|
|
5751
|
+
* <p>The following charts can be described by using this structure:</p>
|
|
5752
|
+
* <ul>
|
|
5753
|
+
* <li>
|
|
5754
|
+
* <p>Pie charts</p>
|
|
5755
|
+
* </li>
|
|
5756
|
+
* <li>
|
|
5757
|
+
* <p>Donut charts</p>
|
|
5758
|
+
* </li>
|
|
5759
|
+
* </ul>
|
|
5760
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html">Using pie charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
5761
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html">Using donut charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
5848
5762
|
* @public
|
|
5849
5763
|
*/
|
|
5850
|
-
export interface
|
|
5764
|
+
export interface PieChartVisual {
|
|
5851
5765
|
/**
|
|
5852
5766
|
* <p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>
|
|
5853
5767
|
* @public
|
|
@@ -5864,10 +5778,10 @@ export interface RadarChartVisual {
|
|
|
5864
5778
|
*/
|
|
5865
5779
|
Subtitle?: VisualSubtitleLabelOptions | undefined;
|
|
5866
5780
|
/**
|
|
5867
|
-
* <p>The configuration
|
|
5781
|
+
* <p>The configuration of a pie chart.</p>
|
|
5868
5782
|
* @public
|
|
5869
5783
|
*/
|
|
5870
|
-
ChartConfiguration?:
|
|
5784
|
+
ChartConfiguration?: PieChartConfiguration | undefined;
|
|
5871
5785
|
/**
|
|
5872
5786
|
* <p>The list of custom actions that are configured for a visual.</p>
|
|
5873
5787
|
* @public
|
|
@@ -5878,667 +5792,705 @@ export interface RadarChartVisual {
|
|
|
5878
5792
|
* @public
|
|
5879
5793
|
*/
|
|
5880
5794
|
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
5795
|
+
/**
|
|
5796
|
+
* <p>The alt text for the visual.</p>
|
|
5797
|
+
* @public
|
|
5798
|
+
*/
|
|
5799
|
+
VisualContentAltText?: string | undefined;
|
|
5881
5800
|
}
|
|
5882
5801
|
/**
|
|
5883
|
-
* <p>The field well configuration of a sankey diagram.</p>
|
|
5884
5802
|
* @public
|
|
5803
|
+
* @enum
|
|
5885
5804
|
*/
|
|
5886
|
-
export
|
|
5887
|
-
|
|
5888
|
-
|
|
5889
|
-
|
|
5890
|
-
|
|
5891
|
-
|
|
5805
|
+
export declare const PivotTableFieldCollapseState: {
|
|
5806
|
+
readonly COLLAPSED: "COLLAPSED";
|
|
5807
|
+
readonly EXPANDED: "EXPANDED";
|
|
5808
|
+
};
|
|
5809
|
+
/**
|
|
5810
|
+
* @public
|
|
5811
|
+
*/
|
|
5812
|
+
export type PivotTableFieldCollapseState = (typeof PivotTableFieldCollapseState)[keyof typeof PivotTableFieldCollapseState];
|
|
5813
|
+
/**
|
|
5814
|
+
* <p>The target of a pivot table field collapse state.</p>
|
|
5815
|
+
* @public
|
|
5816
|
+
*/
|
|
5817
|
+
export interface PivotTableFieldCollapseStateTarget {
|
|
5892
5818
|
/**
|
|
5893
|
-
* <p>The
|
|
5819
|
+
* <p>The field ID of the pivot table that the collapse state needs to be set to.</p>
|
|
5894
5820
|
* @public
|
|
5895
5821
|
*/
|
|
5896
|
-
|
|
5822
|
+
FieldId?: string | undefined;
|
|
5897
5823
|
/**
|
|
5898
|
-
* <p>The
|
|
5824
|
+
* <p>The data path of the pivot table's header. Used to set the collapse state.</p>
|
|
5899
5825
|
* @public
|
|
5900
5826
|
*/
|
|
5901
|
-
|
|
5827
|
+
FieldDataPathValues?: DataPathValue[] | undefined;
|
|
5902
5828
|
}
|
|
5903
5829
|
/**
|
|
5904
|
-
* <p>The
|
|
5830
|
+
* <p>The collapse state options for the pivot table field options.</p>
|
|
5905
5831
|
* @public
|
|
5906
5832
|
*/
|
|
5907
|
-
export interface
|
|
5833
|
+
export interface PivotTableFieldCollapseStateOption {
|
|
5834
|
+
/**
|
|
5835
|
+
* <p>A tagged-union object that sets the collapse state.</p>
|
|
5836
|
+
* @public
|
|
5837
|
+
*/
|
|
5838
|
+
Target: PivotTableFieldCollapseStateTarget | undefined;
|
|
5908
5839
|
/**
|
|
5909
|
-
* <p>The field
|
|
5840
|
+
* <p>The state of the field target of a pivot table. Choose one of the following options:</p>
|
|
5841
|
+
* <ul>
|
|
5842
|
+
* <li>
|
|
5843
|
+
* <p>
|
|
5844
|
+
* <code>COLLAPSED</code>
|
|
5845
|
+
* </p>
|
|
5846
|
+
* </li>
|
|
5847
|
+
* <li>
|
|
5848
|
+
* <p>
|
|
5849
|
+
* <code>EXPANDED</code>
|
|
5850
|
+
* </p>
|
|
5851
|
+
* </li>
|
|
5852
|
+
* </ul>
|
|
5910
5853
|
* @public
|
|
5911
5854
|
*/
|
|
5912
|
-
|
|
5855
|
+
State?: PivotTableFieldCollapseState | undefined;
|
|
5913
5856
|
}
|
|
5914
5857
|
/**
|
|
5915
|
-
* <p>The
|
|
5858
|
+
* <p>The data path options for the pivot table field options.</p>
|
|
5916
5859
|
* @public
|
|
5917
5860
|
*/
|
|
5918
|
-
export interface
|
|
5919
|
-
/**
|
|
5920
|
-
* <p>The sort configuration of the weight fields.</p>
|
|
5921
|
-
* @public
|
|
5922
|
-
*/
|
|
5923
|
-
WeightSort?: FieldSortOptions[] | undefined;
|
|
5861
|
+
export interface PivotTableDataPathOption {
|
|
5924
5862
|
/**
|
|
5925
|
-
* <p>The
|
|
5863
|
+
* <p>The list of data path values for the data path options.</p>
|
|
5926
5864
|
* @public
|
|
5927
5865
|
*/
|
|
5928
|
-
|
|
5866
|
+
DataPathList: DataPathValue[] | undefined;
|
|
5929
5867
|
/**
|
|
5930
|
-
* <p>The
|
|
5868
|
+
* <p>The width of the data path option.</p>
|
|
5931
5869
|
* @public
|
|
5932
5870
|
*/
|
|
5933
|
-
|
|
5871
|
+
Width?: string | undefined;
|
|
5934
5872
|
}
|
|
5935
5873
|
/**
|
|
5936
|
-
* <p>The
|
|
5874
|
+
* <p>The selected field options for the pivot table field options.</p>
|
|
5937
5875
|
* @public
|
|
5938
5876
|
*/
|
|
5939
|
-
export interface
|
|
5940
|
-
/**
|
|
5941
|
-
* <p>The field well configuration of a sankey diagram.</p>
|
|
5942
|
-
* @public
|
|
5943
|
-
*/
|
|
5944
|
-
FieldWells?: SankeyDiagramFieldWells | undefined;
|
|
5877
|
+
export interface PivotTableFieldOption {
|
|
5945
5878
|
/**
|
|
5946
|
-
* <p>The
|
|
5879
|
+
* <p>The field ID of the pivot table field.</p>
|
|
5947
5880
|
* @public
|
|
5948
5881
|
*/
|
|
5949
|
-
|
|
5882
|
+
FieldId: string | undefined;
|
|
5950
5883
|
/**
|
|
5951
|
-
* <p>The
|
|
5884
|
+
* <p>The custom label of the pivot table field.</p>
|
|
5952
5885
|
* @public
|
|
5953
5886
|
*/
|
|
5954
|
-
|
|
5887
|
+
CustomLabel?: string | undefined;
|
|
5955
5888
|
/**
|
|
5956
|
-
* <p>The
|
|
5889
|
+
* <p>The visibility of the pivot table field.</p>
|
|
5957
5890
|
* @public
|
|
5958
5891
|
*/
|
|
5959
|
-
|
|
5892
|
+
Visibility?: Visibility | undefined;
|
|
5960
5893
|
}
|
|
5961
5894
|
/**
|
|
5962
|
-
* <p>
|
|
5963
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html">Using Sankey diagrams</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
5895
|
+
* <p>The field options for a pivot table visual.</p>
|
|
5964
5896
|
* @public
|
|
5965
5897
|
*/
|
|
5966
|
-
export interface
|
|
5967
|
-
/**
|
|
5968
|
-
* <p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>
|
|
5969
|
-
* @public
|
|
5970
|
-
*/
|
|
5971
|
-
VisualId: string | undefined;
|
|
5972
|
-
/**
|
|
5973
|
-
* <p>The title that is displayed on the visual.</p>
|
|
5974
|
-
* @public
|
|
5975
|
-
*/
|
|
5976
|
-
Title?: VisualTitleLabelOptions | undefined;
|
|
5898
|
+
export interface PivotTableFieldOptions {
|
|
5977
5899
|
/**
|
|
5978
|
-
* <p>The
|
|
5900
|
+
* <p>The selected field options for the pivot table field options.</p>
|
|
5979
5901
|
* @public
|
|
5980
5902
|
*/
|
|
5981
|
-
|
|
5903
|
+
SelectedFieldOptions?: PivotTableFieldOption[] | undefined;
|
|
5982
5904
|
/**
|
|
5983
|
-
* <p>The
|
|
5905
|
+
* <p>The data path options for the pivot table field options.</p>
|
|
5984
5906
|
* @public
|
|
5985
5907
|
*/
|
|
5986
|
-
|
|
5908
|
+
DataPathOptions?: PivotTableDataPathOption[] | undefined;
|
|
5987
5909
|
/**
|
|
5988
|
-
* <p>The
|
|
5910
|
+
* <p>The collapse state options for the pivot table field options.</p>
|
|
5989
5911
|
* @public
|
|
5990
5912
|
*/
|
|
5991
|
-
|
|
5913
|
+
CollapseStateOptions?: PivotTableFieldCollapseStateOption[] | undefined;
|
|
5992
5914
|
}
|
|
5993
5915
|
/**
|
|
5994
|
-
* <p>The aggregated field well
|
|
5916
|
+
* <p>The aggregated field well for the pivot table.</p>
|
|
5995
5917
|
* @public
|
|
5996
5918
|
*/
|
|
5997
|
-
export interface
|
|
5919
|
+
export interface PivotTableAggregatedFieldWells {
|
|
5920
|
+
/**
|
|
5921
|
+
* <p>The rows field well for a pivot table. Values are grouped by rows fields.</p>
|
|
5922
|
+
* @public
|
|
5923
|
+
*/
|
|
5924
|
+
Rows?: DimensionField[] | undefined;
|
|
5998
5925
|
/**
|
|
5999
|
-
* <p>The
|
|
6000
|
-
* <p>The x-axis is aggregated by category.</p>
|
|
5926
|
+
* <p>The columns field well for a pivot table. Values are grouped by columns fields.</p>
|
|
6001
5927
|
* @public
|
|
6002
5928
|
*/
|
|
6003
|
-
|
|
5929
|
+
Columns?: DimensionField[] | undefined;
|
|
6004
5930
|
/**
|
|
6005
|
-
* <p>The
|
|
6006
|
-
* <p>The y-axis is aggregated by category.</p>
|
|
5931
|
+
* <p>The values field well for a pivot table. Values are aggregated based on rows and columns fields.</p>
|
|
6007
5932
|
* @public
|
|
6008
5933
|
*/
|
|
6009
|
-
|
|
5934
|
+
Values?: MeasureField[] | undefined;
|
|
5935
|
+
}
|
|
5936
|
+
/**
|
|
5937
|
+
* <p>The field wells for a pivot table visual.</p>
|
|
5938
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
5939
|
+
* @public
|
|
5940
|
+
*/
|
|
5941
|
+
export interface PivotTableFieldWells {
|
|
6010
5942
|
/**
|
|
6011
|
-
* <p>The
|
|
5943
|
+
* <p>The aggregated field well for the pivot table.</p>
|
|
6012
5944
|
* @public
|
|
6013
5945
|
*/
|
|
6014
|
-
|
|
5946
|
+
PivotTableAggregatedFieldWells?: PivotTableAggregatedFieldWells | undefined;
|
|
5947
|
+
}
|
|
5948
|
+
/**
|
|
5949
|
+
* <p>The paginated report options for a pivot table visual.</p>
|
|
5950
|
+
* @public
|
|
5951
|
+
*/
|
|
5952
|
+
export interface PivotTablePaginatedReportOptions {
|
|
6015
5953
|
/**
|
|
6016
|
-
* <p>The
|
|
5954
|
+
* <p>The visibility of the printing table overflow across pages.</p>
|
|
6017
5955
|
* @public
|
|
6018
5956
|
*/
|
|
6019
|
-
|
|
5957
|
+
VerticalOverflowVisibility?: Visibility | undefined;
|
|
6020
5958
|
/**
|
|
6021
|
-
* <p>The
|
|
5959
|
+
* <p>The visibility of the repeating header rows on each page.</p>
|
|
6022
5960
|
* @public
|
|
6023
5961
|
*/
|
|
6024
|
-
|
|
5962
|
+
OverflowColumnHeaderVisibility?: Visibility | undefined;
|
|
6025
5963
|
}
|
|
6026
5964
|
/**
|
|
6027
|
-
* <p>
|
|
5965
|
+
* <p>Allows data paths to be sorted by a specific data value.</p>
|
|
6028
5966
|
* @public
|
|
6029
5967
|
*/
|
|
6030
|
-
export interface
|
|
5968
|
+
export interface DataPathSort {
|
|
6031
5969
|
/**
|
|
6032
|
-
* <p>
|
|
6033
|
-
* <p>The x-axis is a dimension field and cannot be aggregated.</p>
|
|
5970
|
+
* <p>Determines the sort direction.</p>
|
|
6034
5971
|
* @public
|
|
6035
5972
|
*/
|
|
6036
|
-
|
|
5973
|
+
Direction: SortDirection | undefined;
|
|
6037
5974
|
/**
|
|
6038
|
-
* <p>The
|
|
6039
|
-
* <p>The y-axis is a dimension field and cannot be aggregated.</p>
|
|
5975
|
+
* <p>The list of data paths that need to be sorted.</p>
|
|
6040
5976
|
* @public
|
|
6041
5977
|
*/
|
|
6042
|
-
|
|
5978
|
+
SortPaths: DataPathValue[] | undefined;
|
|
5979
|
+
}
|
|
5980
|
+
/**
|
|
5981
|
+
* <p>The sort by field for the field sort options.</p>
|
|
5982
|
+
* @public
|
|
5983
|
+
*/
|
|
5984
|
+
export interface PivotTableSortBy {
|
|
6043
5985
|
/**
|
|
6044
|
-
* <p>The
|
|
5986
|
+
* <p>The field sort (field id, direction) for the pivot table sort by options.</p>
|
|
6045
5987
|
* @public
|
|
6046
5988
|
*/
|
|
6047
|
-
|
|
5989
|
+
Field?: FieldSort | undefined;
|
|
6048
5990
|
/**
|
|
6049
|
-
* <p>The
|
|
5991
|
+
* <p>The column sort (field id, direction) for the pivot table sort by options.</p>
|
|
6050
5992
|
* @public
|
|
6051
5993
|
*/
|
|
6052
|
-
|
|
5994
|
+
Column?: ColumnSort | undefined;
|
|
6053
5995
|
/**
|
|
6054
|
-
* <p>The
|
|
5996
|
+
* <p>The data path sort (data path value, direction) for the pivot table sort by options.</p>
|
|
6055
5997
|
* @public
|
|
6056
5998
|
*/
|
|
6057
|
-
|
|
5999
|
+
DataPath?: DataPathSort | undefined;
|
|
6058
6000
|
}
|
|
6059
6001
|
/**
|
|
6060
|
-
* <p>The field
|
|
6061
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
6002
|
+
* <p>The field sort options for a pivot table sort configuration.</p>
|
|
6062
6003
|
* @public
|
|
6063
6004
|
*/
|
|
6064
|
-
export interface
|
|
6005
|
+
export interface PivotFieldSortOptions {
|
|
6065
6006
|
/**
|
|
6066
|
-
* <p>The
|
|
6007
|
+
* <p>The field ID for the field sort options.</p>
|
|
6067
6008
|
* @public
|
|
6068
6009
|
*/
|
|
6069
|
-
|
|
6010
|
+
FieldId: string | undefined;
|
|
6070
6011
|
/**
|
|
6071
|
-
* <p>The
|
|
6072
|
-
* unaggregated.</p>
|
|
6012
|
+
* <p>The sort by field for the field sort options.</p>
|
|
6073
6013
|
* @public
|
|
6074
6014
|
*/
|
|
6075
|
-
|
|
6015
|
+
SortBy: PivotTableSortBy | undefined;
|
|
6076
6016
|
}
|
|
6077
6017
|
/**
|
|
6078
|
-
* <p>The sort configuration
|
|
6018
|
+
* <p>The sort configuration for a <code>PivotTableVisual</code>.</p>
|
|
6079
6019
|
* @public
|
|
6080
6020
|
*/
|
|
6081
|
-
export interface
|
|
6021
|
+
export interface PivotTableSortConfiguration {
|
|
6082
6022
|
/**
|
|
6083
|
-
* <p>The
|
|
6023
|
+
* <p>The field sort options for a pivot table sort configuration.</p>
|
|
6084
6024
|
* @public
|
|
6085
6025
|
*/
|
|
6086
|
-
|
|
6026
|
+
FieldSortOptions?: PivotFieldSortOptions[] | undefined;
|
|
6087
6027
|
}
|
|
6088
6028
|
/**
|
|
6089
|
-
*
|
|
6029
|
+
* @public
|
|
6030
|
+
* @enum
|
|
6031
|
+
*/
|
|
6032
|
+
export declare const TableBorderStyle: {
|
|
6033
|
+
readonly NONE: "NONE";
|
|
6034
|
+
readonly SOLID: "SOLID";
|
|
6035
|
+
};
|
|
6036
|
+
/**
|
|
6037
|
+
* @public
|
|
6038
|
+
*/
|
|
6039
|
+
export type TableBorderStyle = (typeof TableBorderStyle)[keyof typeof TableBorderStyle];
|
|
6040
|
+
/**
|
|
6041
|
+
* <p>The border options for a table border.</p>
|
|
6090
6042
|
* @public
|
|
6091
6043
|
*/
|
|
6092
|
-
export interface
|
|
6044
|
+
export interface TableBorderOptions {
|
|
6093
6045
|
/**
|
|
6094
|
-
* <p>The
|
|
6046
|
+
* <p>The color of a table border.</p>
|
|
6095
6047
|
* @public
|
|
6096
6048
|
*/
|
|
6097
|
-
|
|
6049
|
+
Color?: string | undefined;
|
|
6098
6050
|
/**
|
|
6099
|
-
* <p>The
|
|
6051
|
+
* <p>The thickness of a table border.</p>
|
|
6100
6052
|
* @public
|
|
6101
6053
|
*/
|
|
6102
|
-
|
|
6054
|
+
Thickness?: number | undefined;
|
|
6103
6055
|
/**
|
|
6104
|
-
* <p>The
|
|
6056
|
+
* <p>The style (none, solid) of a table border.</p>
|
|
6105
6057
|
* @public
|
|
6106
6058
|
*/
|
|
6107
|
-
|
|
6059
|
+
Style?: TableBorderStyle | undefined;
|
|
6060
|
+
}
|
|
6061
|
+
/**
|
|
6062
|
+
* <p>The side border options for a table.</p>
|
|
6063
|
+
* @public
|
|
6064
|
+
*/
|
|
6065
|
+
export interface TableSideBorderOptions {
|
|
6108
6066
|
/**
|
|
6109
|
-
* <p>The
|
|
6067
|
+
* <p>The table border options of the inner vertical border.</p>
|
|
6110
6068
|
* @public
|
|
6111
6069
|
*/
|
|
6112
|
-
|
|
6070
|
+
InnerVertical?: TableBorderOptions | undefined;
|
|
6113
6071
|
/**
|
|
6114
|
-
* <p>The
|
|
6072
|
+
* <p>The table border options of the inner horizontal border.</p>
|
|
6115
6073
|
* @public
|
|
6116
6074
|
*/
|
|
6117
|
-
|
|
6075
|
+
InnerHorizontal?: TableBorderOptions | undefined;
|
|
6118
6076
|
/**
|
|
6119
|
-
* <p>The
|
|
6077
|
+
* <p>The table border options of the left border.</p>
|
|
6120
6078
|
* @public
|
|
6121
6079
|
*/
|
|
6122
|
-
|
|
6080
|
+
Left?: TableBorderOptions | undefined;
|
|
6123
6081
|
/**
|
|
6124
|
-
* <p>The
|
|
6082
|
+
* <p>The table border options of the right border.</p>
|
|
6125
6083
|
* @public
|
|
6126
6084
|
*/
|
|
6127
|
-
|
|
6085
|
+
Right?: TableBorderOptions | undefined;
|
|
6128
6086
|
/**
|
|
6129
|
-
* <p>The
|
|
6087
|
+
* <p>The table border options of the top border.</p>
|
|
6130
6088
|
* @public
|
|
6131
6089
|
*/
|
|
6132
|
-
|
|
6090
|
+
Top?: TableBorderOptions | undefined;
|
|
6133
6091
|
/**
|
|
6134
|
-
* <p>The
|
|
6092
|
+
* <p>The table border options of the bottom border.</p>
|
|
6135
6093
|
* @public
|
|
6136
6094
|
*/
|
|
6137
|
-
|
|
6095
|
+
Bottom?: TableBorderOptions | undefined;
|
|
6096
|
+
}
|
|
6097
|
+
/**
|
|
6098
|
+
* <p>Determines the border options for a table visual.</p>
|
|
6099
|
+
* @public
|
|
6100
|
+
*/
|
|
6101
|
+
export interface GlobalTableBorderOptions {
|
|
6138
6102
|
/**
|
|
6139
|
-
* <p>
|
|
6103
|
+
* <p>Determines the options for uniform border.</p>
|
|
6140
6104
|
* @public
|
|
6141
6105
|
*/
|
|
6142
|
-
|
|
6106
|
+
UniformBorder?: TableBorderOptions | undefined;
|
|
6143
6107
|
/**
|
|
6144
|
-
* <p>
|
|
6108
|
+
* <p>Determines the options for side specific border.</p>
|
|
6145
6109
|
* @public
|
|
6146
6110
|
*/
|
|
6147
|
-
|
|
6111
|
+
SideSpecificBorder?: TableSideBorderOptions | undefined;
|
|
6148
6112
|
}
|
|
6149
6113
|
/**
|
|
6150
|
-
* <p>A scatter plot.</p>
|
|
6151
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html">Using scatter plots</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6152
6114
|
* @public
|
|
6115
|
+
* @enum
|
|
6153
6116
|
*/
|
|
6154
|
-
export
|
|
6155
|
-
|
|
6156
|
-
|
|
6157
|
-
|
|
6158
|
-
|
|
6159
|
-
|
|
6117
|
+
export declare const TextWrap: {
|
|
6118
|
+
readonly NONE: "NONE";
|
|
6119
|
+
readonly WRAP: "WRAP";
|
|
6120
|
+
};
|
|
6121
|
+
/**
|
|
6122
|
+
* @public
|
|
6123
|
+
*/
|
|
6124
|
+
export type TextWrap = (typeof TextWrap)[keyof typeof TextWrap];
|
|
6125
|
+
/**
|
|
6126
|
+
* @public
|
|
6127
|
+
* @enum
|
|
6128
|
+
*/
|
|
6129
|
+
export declare const VerticalTextAlignment: {
|
|
6130
|
+
readonly AUTO: "AUTO";
|
|
6131
|
+
readonly BOTTOM: "BOTTOM";
|
|
6132
|
+
readonly MIDDLE: "MIDDLE";
|
|
6133
|
+
readonly TOP: "TOP";
|
|
6134
|
+
};
|
|
6135
|
+
/**
|
|
6136
|
+
* @public
|
|
6137
|
+
*/
|
|
6138
|
+
export type VerticalTextAlignment = (typeof VerticalTextAlignment)[keyof typeof VerticalTextAlignment];
|
|
6139
|
+
/**
|
|
6140
|
+
* <p>The table cell style for a cell in pivot table or table visual.</p>
|
|
6141
|
+
* @public
|
|
6142
|
+
*/
|
|
6143
|
+
export interface TableCellStyle {
|
|
6160
6144
|
/**
|
|
6161
|
-
* <p>The
|
|
6145
|
+
* <p>The visibility of the table cells.</p>
|
|
6162
6146
|
* @public
|
|
6163
6147
|
*/
|
|
6164
|
-
|
|
6148
|
+
Visibility?: Visibility | undefined;
|
|
6165
6149
|
/**
|
|
6166
|
-
* <p>The
|
|
6150
|
+
* <p>The font configuration of the table cells.</p>
|
|
6167
6151
|
* @public
|
|
6168
6152
|
*/
|
|
6169
|
-
|
|
6153
|
+
FontConfiguration?: FontConfiguration | undefined;
|
|
6170
6154
|
/**
|
|
6171
|
-
* <p>The
|
|
6155
|
+
* <p>The text wrap (none, wrap) for the table cells.</p>
|
|
6172
6156
|
* @public
|
|
6173
6157
|
*/
|
|
6174
|
-
|
|
6158
|
+
TextWrap?: TextWrap | undefined;
|
|
6175
6159
|
/**
|
|
6176
|
-
* <p>The
|
|
6160
|
+
* <p>The horizontal text alignment (left, center, right, auto) for the table cells.</p>
|
|
6177
6161
|
* @public
|
|
6178
6162
|
*/
|
|
6179
|
-
|
|
6163
|
+
HorizontalTextAlignment?: HorizontalTextAlignment | undefined;
|
|
6180
6164
|
/**
|
|
6181
|
-
* <p>The
|
|
6165
|
+
* <p>The vertical text alignment (top, middle, bottom) for the table cells.</p>
|
|
6182
6166
|
* @public
|
|
6183
6167
|
*/
|
|
6184
|
-
|
|
6185
|
-
}
|
|
6186
|
-
/**
|
|
6187
|
-
* <p>The settings for the pinned columns of a table visual.</p>
|
|
6188
|
-
* @public
|
|
6189
|
-
*/
|
|
6190
|
-
export interface TablePinnedFieldOptions {
|
|
6168
|
+
VerticalTextAlignment?: VerticalTextAlignment | undefined;
|
|
6191
6169
|
/**
|
|
6192
|
-
* <p>
|
|
6170
|
+
* <p>The background color for the table cells.</p>
|
|
6193
6171
|
* @public
|
|
6194
6172
|
*/
|
|
6195
|
-
|
|
6196
|
-
}
|
|
6197
|
-
/**
|
|
6198
|
-
* @public
|
|
6199
|
-
* @enum
|
|
6200
|
-
*/
|
|
6201
|
-
export declare const TableCellImageScalingConfiguration: {
|
|
6202
|
-
readonly DO_NOT_SCALE: "DO_NOT_SCALE";
|
|
6203
|
-
readonly FIT_TO_CELL_HEIGHT: "FIT_TO_CELL_HEIGHT";
|
|
6204
|
-
readonly FIT_TO_CELL_WIDTH: "FIT_TO_CELL_WIDTH";
|
|
6205
|
-
};
|
|
6206
|
-
/**
|
|
6207
|
-
* @public
|
|
6208
|
-
*/
|
|
6209
|
-
export type TableCellImageScalingConfiguration = (typeof TableCellImageScalingConfiguration)[keyof typeof TableCellImageScalingConfiguration];
|
|
6210
|
-
/**
|
|
6211
|
-
* <p>The sizing options for the table image configuration.</p>
|
|
6212
|
-
* @public
|
|
6213
|
-
*/
|
|
6214
|
-
export interface TableCellImageSizingConfiguration {
|
|
6173
|
+
BackgroundColor?: string | undefined;
|
|
6215
6174
|
/**
|
|
6216
|
-
* <p>The
|
|
6175
|
+
* <p>The height color for the table cells.</p>
|
|
6217
6176
|
* @public
|
|
6218
6177
|
*/
|
|
6219
|
-
|
|
6220
|
-
}
|
|
6221
|
-
/**
|
|
6222
|
-
* <p>The image configuration of a table field URL.</p>
|
|
6223
|
-
* @public
|
|
6224
|
-
*/
|
|
6225
|
-
export interface TableFieldImageConfiguration {
|
|
6178
|
+
Height?: number | undefined;
|
|
6226
6179
|
/**
|
|
6227
|
-
* <p>The
|
|
6180
|
+
* <p>The borders for the table cells.</p>
|
|
6228
6181
|
* @public
|
|
6229
6182
|
*/
|
|
6230
|
-
|
|
6183
|
+
Border?: GlobalTableBorderOptions | undefined;
|
|
6231
6184
|
}
|
|
6232
6185
|
/**
|
|
6233
6186
|
* @public
|
|
6234
6187
|
* @enum
|
|
6235
6188
|
*/
|
|
6236
|
-
export declare const
|
|
6237
|
-
readonly
|
|
6189
|
+
export declare const PivotTableMetricPlacement: {
|
|
6190
|
+
readonly COLUMN: "COLUMN";
|
|
6191
|
+
readonly ROW: "ROW";
|
|
6238
6192
|
};
|
|
6239
6193
|
/**
|
|
6240
6194
|
* @public
|
|
6241
6195
|
*/
|
|
6242
|
-
export type
|
|
6196
|
+
export type PivotTableMetricPlacement = (typeof PivotTableMetricPlacement)[keyof typeof PivotTableMetricPlacement];
|
|
6243
6197
|
/**
|
|
6244
|
-
* <p>
|
|
6198
|
+
* <p>Determines the row alternate color options.</p>
|
|
6245
6199
|
* @public
|
|
6246
6200
|
*/
|
|
6247
|
-
export interface
|
|
6201
|
+
export interface RowAlternateColorOptions {
|
|
6248
6202
|
/**
|
|
6249
|
-
* <p>
|
|
6203
|
+
* <p>Determines the widget status.</p>
|
|
6250
6204
|
* @public
|
|
6251
6205
|
*/
|
|
6252
|
-
|
|
6253
|
-
}
|
|
6254
|
-
/**
|
|
6255
|
-
* <p>The custom text content (value, font configuration) for the table link content configuration.</p>
|
|
6256
|
-
* @public
|
|
6257
|
-
*/
|
|
6258
|
-
export interface TableFieldCustomTextContent {
|
|
6206
|
+
Status?: WidgetStatus | undefined;
|
|
6259
6207
|
/**
|
|
6260
|
-
* <p>
|
|
6208
|
+
* <p>Determines the list of row alternate colors.</p>
|
|
6261
6209
|
* @public
|
|
6262
6210
|
*/
|
|
6263
|
-
|
|
6211
|
+
RowAlternateColors?: string[] | undefined;
|
|
6264
6212
|
/**
|
|
6265
|
-
* <p>The
|
|
6213
|
+
* <p>The primary background color options for alternate rows.</p>
|
|
6266
6214
|
* @public
|
|
6267
6215
|
*/
|
|
6268
|
-
|
|
6216
|
+
UsePrimaryBackgroundColor?: WidgetStatus | undefined;
|
|
6269
6217
|
}
|
|
6270
6218
|
/**
|
|
6271
|
-
* <p>The
|
|
6219
|
+
* <p>The options for the label thta is located above the row headers. This option is only applicable when <code>RowsLayout</code> is set to <code>HIERARCHY</code>.</p>
|
|
6272
6220
|
* @public
|
|
6273
6221
|
*/
|
|
6274
|
-
export interface
|
|
6222
|
+
export interface PivotTableRowsLabelOptions {
|
|
6275
6223
|
/**
|
|
6276
|
-
* <p>The
|
|
6224
|
+
* <p>The visibility of the rows label.</p>
|
|
6277
6225
|
* @public
|
|
6278
6226
|
*/
|
|
6279
|
-
|
|
6227
|
+
Visibility?: Visibility | undefined;
|
|
6280
6228
|
/**
|
|
6281
|
-
* <p>The custom
|
|
6229
|
+
* <p>The custom label string for the rows label.</p>
|
|
6282
6230
|
* @public
|
|
6283
6231
|
*/
|
|
6284
|
-
|
|
6232
|
+
CustomLabel?: string | undefined;
|
|
6285
6233
|
}
|
|
6286
6234
|
/**
|
|
6287
|
-
* <p>The link configuration of a table field URL.</p>
|
|
6288
6235
|
* @public
|
|
6236
|
+
* @enum
|
|
6289
6237
|
*/
|
|
6290
|
-
export
|
|
6291
|
-
|
|
6292
|
-
|
|
6293
|
-
|
|
6294
|
-
*/
|
|
6295
|
-
Target: URLTargetConfiguration | undefined;
|
|
6296
|
-
/**
|
|
6297
|
-
* <p>The URL content (text, icon) for the table link configuration.</p>
|
|
6298
|
-
* @public
|
|
6299
|
-
*/
|
|
6300
|
-
Content: TableFieldLinkContentConfiguration | undefined;
|
|
6301
|
-
}
|
|
6238
|
+
export declare const PivotTableRowsLayout: {
|
|
6239
|
+
readonly HIERARCHY: "HIERARCHY";
|
|
6240
|
+
readonly TABULAR: "TABULAR";
|
|
6241
|
+
};
|
|
6302
6242
|
/**
|
|
6303
|
-
* <p>The URL configuration for a table field.</p>
|
|
6304
6243
|
* @public
|
|
6305
6244
|
*/
|
|
6306
|
-
export
|
|
6307
|
-
/**
|
|
6308
|
-
* <p>The link configuration of a table field URL.</p>
|
|
6309
|
-
* @public
|
|
6310
|
-
*/
|
|
6311
|
-
LinkConfiguration?: TableFieldLinkConfiguration | undefined;
|
|
6312
|
-
/**
|
|
6313
|
-
* <p>The image configuration of a table field URL.</p>
|
|
6314
|
-
* @public
|
|
6315
|
-
*/
|
|
6316
|
-
ImageConfiguration?: TableFieldImageConfiguration | undefined;
|
|
6317
|
-
}
|
|
6245
|
+
export type PivotTableRowsLayout = (typeof PivotTableRowsLayout)[keyof typeof PivotTableRowsLayout];
|
|
6318
6246
|
/**
|
|
6319
|
-
* <p>The options for a table
|
|
6247
|
+
* <p>The table options for a pivot table visual.</p>
|
|
6320
6248
|
* @public
|
|
6321
6249
|
*/
|
|
6322
|
-
export interface
|
|
6250
|
+
export interface PivotTableOptions {
|
|
6323
6251
|
/**
|
|
6324
|
-
* <p>The
|
|
6252
|
+
* <p>The metric placement (row, column) options.</p>
|
|
6325
6253
|
* @public
|
|
6326
6254
|
*/
|
|
6327
|
-
|
|
6255
|
+
MetricPlacement?: PivotTableMetricPlacement | undefined;
|
|
6328
6256
|
/**
|
|
6329
|
-
* <p>The
|
|
6257
|
+
* <p>The visibility of the single metric options.</p>
|
|
6330
6258
|
* @public
|
|
6331
6259
|
*/
|
|
6332
|
-
|
|
6260
|
+
SingleMetricVisibility?: Visibility | undefined;
|
|
6333
6261
|
/**
|
|
6334
|
-
* <p>The
|
|
6262
|
+
* <p>The visibility of the column names.</p>
|
|
6335
6263
|
* @public
|
|
6336
6264
|
*/
|
|
6337
|
-
|
|
6265
|
+
ColumnNamesVisibility?: Visibility | undefined;
|
|
6338
6266
|
/**
|
|
6339
|
-
* <p>
|
|
6267
|
+
* <p>Determines the visibility of the pivot table.</p>
|
|
6340
6268
|
* @public
|
|
6341
6269
|
*/
|
|
6342
|
-
|
|
6270
|
+
ToggleButtonsVisibility?: Visibility | undefined;
|
|
6343
6271
|
/**
|
|
6344
|
-
* <p>The
|
|
6272
|
+
* <p>The table cell style of the column header.</p>
|
|
6345
6273
|
* @public
|
|
6346
6274
|
*/
|
|
6347
|
-
|
|
6348
|
-
}
|
|
6349
|
-
/**
|
|
6350
|
-
* <p>The field options of a table visual.</p>
|
|
6351
|
-
* @public
|
|
6352
|
-
*/
|
|
6353
|
-
export interface TableFieldOptions {
|
|
6275
|
+
ColumnHeaderStyle?: TableCellStyle | undefined;
|
|
6354
6276
|
/**
|
|
6355
|
-
* <p>The
|
|
6277
|
+
* <p>The table cell style of the row headers.</p>
|
|
6356
6278
|
* @public
|
|
6357
6279
|
*/
|
|
6358
|
-
|
|
6280
|
+
RowHeaderStyle?: TableCellStyle | undefined;
|
|
6359
6281
|
/**
|
|
6360
|
-
* <p>The
|
|
6282
|
+
* <p>The table cell style of cells.</p>
|
|
6361
6283
|
* @public
|
|
6362
6284
|
*/
|
|
6363
|
-
|
|
6285
|
+
CellStyle?: TableCellStyle | undefined;
|
|
6364
6286
|
/**
|
|
6365
|
-
* <p>The
|
|
6287
|
+
* <p>The table cell style of row field names.</p>
|
|
6366
6288
|
* @public
|
|
6367
6289
|
*/
|
|
6368
|
-
|
|
6369
|
-
}
|
|
6370
|
-
/**
|
|
6371
|
-
* <p>The aggregated field well for the table.</p>
|
|
6372
|
-
* @public
|
|
6373
|
-
*/
|
|
6374
|
-
export interface TableAggregatedFieldWells {
|
|
6290
|
+
RowFieldNamesStyle?: TableCellStyle | undefined;
|
|
6375
6291
|
/**
|
|
6376
|
-
* <p>The
|
|
6292
|
+
* <p>The row alternate color options (widget status, row alternate colors).</p>
|
|
6377
6293
|
* @public
|
|
6378
6294
|
*/
|
|
6379
|
-
|
|
6295
|
+
RowAlternateColorOptions?: RowAlternateColorOptions | undefined;
|
|
6380
6296
|
/**
|
|
6381
|
-
* <p>The
|
|
6297
|
+
* <p>The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is <code>HIDDEN</code>, all collapsed columns in a pivot table are automatically hidden. The default value is <code>VISIBLE</code>.</p>
|
|
6382
6298
|
* @public
|
|
6383
6299
|
*/
|
|
6384
|
-
|
|
6385
|
-
}
|
|
6386
|
-
/**
|
|
6387
|
-
* <p>The unaggregated field for a table.</p>
|
|
6388
|
-
* @public
|
|
6389
|
-
*/
|
|
6390
|
-
export interface UnaggregatedField {
|
|
6300
|
+
CollapsedRowDimensionsVisibility?: Visibility | undefined;
|
|
6391
6301
|
/**
|
|
6392
|
-
* <p>The
|
|
6302
|
+
* <p>The layout for the row dimension headers of a pivot table. Choose one of the following options.</p>
|
|
6303
|
+
* <ul>
|
|
6304
|
+
* <li>
|
|
6305
|
+
* <p>
|
|
6306
|
+
* <code>TABULAR</code>: (Default) Each row field is displayed in a separate column.</p>
|
|
6307
|
+
* </li>
|
|
6308
|
+
* <li>
|
|
6309
|
+
* <p>
|
|
6310
|
+
* <code>HIERARCHY</code>: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.</p>
|
|
6311
|
+
* </li>
|
|
6312
|
+
* </ul>
|
|
6393
6313
|
* @public
|
|
6394
6314
|
*/
|
|
6395
|
-
|
|
6315
|
+
RowsLayout?: PivotTableRowsLayout | undefined;
|
|
6396
6316
|
/**
|
|
6397
|
-
* <p>The
|
|
6317
|
+
* <p>The options for the label that is located above the row headers. This option is only applicable when <code>RowsLayout</code> is set to <code>HIERARCHY</code>.</p>
|
|
6398
6318
|
* @public
|
|
6399
6319
|
*/
|
|
6400
|
-
|
|
6320
|
+
RowsLabelOptions?: PivotTableRowsLabelOptions | undefined;
|
|
6401
6321
|
/**
|
|
6402
|
-
* <p>The
|
|
6322
|
+
* <p>The default cell width of the pivot table.</p>
|
|
6403
6323
|
* @public
|
|
6404
6324
|
*/
|
|
6405
|
-
|
|
6325
|
+
DefaultCellWidth?: string | undefined;
|
|
6406
6326
|
}
|
|
6407
6327
|
/**
|
|
6408
|
-
*
|
|
6328
|
+
* @public
|
|
6329
|
+
* @enum
|
|
6330
|
+
*/
|
|
6331
|
+
export declare const PivotTableSubtotalLevel: {
|
|
6332
|
+
readonly ALL: "ALL";
|
|
6333
|
+
readonly CUSTOM: "CUSTOM";
|
|
6334
|
+
readonly LAST: "LAST";
|
|
6335
|
+
};
|
|
6336
|
+
/**
|
|
6337
|
+
* @public
|
|
6338
|
+
*/
|
|
6339
|
+
export type PivotTableSubtotalLevel = (typeof PivotTableSubtotalLevel)[keyof typeof PivotTableSubtotalLevel];
|
|
6340
|
+
/**
|
|
6341
|
+
* <p>The optional configuration of subtotals cells.</p>
|
|
6409
6342
|
* @public
|
|
6410
6343
|
*/
|
|
6411
|
-
export interface
|
|
6344
|
+
export interface PivotTableFieldSubtotalOptions {
|
|
6412
6345
|
/**
|
|
6413
|
-
* <p>The
|
|
6346
|
+
* <p>The field ID of the subtotal options.</p>
|
|
6414
6347
|
* @public
|
|
6415
6348
|
*/
|
|
6416
|
-
|
|
6349
|
+
FieldId?: string | undefined;
|
|
6417
6350
|
}
|
|
6418
6351
|
/**
|
|
6419
|
-
* <p>The field wells for a table visual.</p>
|
|
6420
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
6421
6352
|
* @public
|
|
6353
|
+
* @enum
|
|
6422
6354
|
*/
|
|
6423
|
-
export
|
|
6424
|
-
|
|
6425
|
-
|
|
6426
|
-
|
|
6427
|
-
|
|
6428
|
-
|
|
6355
|
+
export declare const StyledCellType: {
|
|
6356
|
+
readonly METRIC_HEADER: "METRIC_HEADER";
|
|
6357
|
+
readonly TOTAL: "TOTAL";
|
|
6358
|
+
readonly VALUE: "VALUE";
|
|
6359
|
+
};
|
|
6360
|
+
/**
|
|
6361
|
+
* @public
|
|
6362
|
+
*/
|
|
6363
|
+
export type StyledCellType = (typeof StyledCellType)[keyof typeof StyledCellType];
|
|
6364
|
+
/**
|
|
6365
|
+
* <p>The table style target.</p>
|
|
6366
|
+
* @public
|
|
6367
|
+
*/
|
|
6368
|
+
export interface TableStyleTarget {
|
|
6429
6369
|
/**
|
|
6430
|
-
* <p>The
|
|
6370
|
+
* <p>The cell type of the table style target.</p>
|
|
6431
6371
|
* @public
|
|
6432
6372
|
*/
|
|
6433
|
-
|
|
6373
|
+
CellType: StyledCellType | undefined;
|
|
6434
6374
|
}
|
|
6435
6375
|
/**
|
|
6436
|
-
* <p>The
|
|
6376
|
+
* <p>The subtotal options.</p>
|
|
6437
6377
|
* @public
|
|
6438
6378
|
*/
|
|
6439
|
-
export interface
|
|
6379
|
+
export interface SubtotalOptions {
|
|
6440
6380
|
/**
|
|
6441
|
-
* <p>The visibility
|
|
6381
|
+
* <p>The visibility configuration for the subtotal cells.</p>
|
|
6442
6382
|
* @public
|
|
6443
6383
|
*/
|
|
6444
|
-
|
|
6384
|
+
TotalsVisibility?: Visibility | undefined;
|
|
6445
6385
|
/**
|
|
6446
|
-
* <p>The
|
|
6386
|
+
* <p>The custom label string for the subtotal cells.</p>
|
|
6447
6387
|
* @public
|
|
6448
6388
|
*/
|
|
6449
|
-
|
|
6450
|
-
}
|
|
6451
|
-
/**
|
|
6452
|
-
* <p>The sort configuration for a <code>TableVisual</code>.</p>
|
|
6453
|
-
* @public
|
|
6454
|
-
*/
|
|
6455
|
-
export interface TableSortConfiguration {
|
|
6389
|
+
CustomLabel?: string | undefined;
|
|
6456
6390
|
/**
|
|
6457
|
-
* <p>The field
|
|
6391
|
+
* <p>The field level (all, custom, last) for the subtotal cells.</p>
|
|
6458
6392
|
* @public
|
|
6459
6393
|
*/
|
|
6460
|
-
|
|
6394
|
+
FieldLevel?: PivotTableSubtotalLevel | undefined;
|
|
6461
6395
|
/**
|
|
6462
|
-
* <p>The
|
|
6396
|
+
* <p>The optional configuration of subtotal cells.</p>
|
|
6463
6397
|
* @public
|
|
6464
6398
|
*/
|
|
6465
|
-
|
|
6466
|
-
}
|
|
6467
|
-
/**
|
|
6468
|
-
* <p>The options for data bars.</p>
|
|
6469
|
-
* @public
|
|
6470
|
-
*/
|
|
6471
|
-
export interface DataBarsOptions {
|
|
6399
|
+
FieldLevelOptions?: PivotTableFieldSubtotalOptions[] | undefined;
|
|
6472
6400
|
/**
|
|
6473
|
-
* <p>The
|
|
6401
|
+
* <p>The cell styling options for the subtotal cells.</p>
|
|
6474
6402
|
* @public
|
|
6475
6403
|
*/
|
|
6476
|
-
|
|
6404
|
+
TotalCellStyle?: TableCellStyle | undefined;
|
|
6477
6405
|
/**
|
|
6478
|
-
* <p>The
|
|
6406
|
+
* <p>The cell styling options for the subtotals of value cells.</p>
|
|
6479
6407
|
* @public
|
|
6480
6408
|
*/
|
|
6481
|
-
|
|
6409
|
+
ValueCellStyle?: TableCellStyle | undefined;
|
|
6482
6410
|
/**
|
|
6483
|
-
* <p>The
|
|
6411
|
+
* <p>The cell styling options for the subtotals of header cells.</p>
|
|
6484
6412
|
* @public
|
|
6485
6413
|
*/
|
|
6486
|
-
|
|
6487
|
-
}
|
|
6488
|
-
/**
|
|
6489
|
-
* <p>The inline visualization of a specific type to display within a chart.</p>
|
|
6490
|
-
* @public
|
|
6491
|
-
*/
|
|
6492
|
-
export interface TableInlineVisualization {
|
|
6414
|
+
MetricHeaderCellStyle?: TableCellStyle | undefined;
|
|
6493
6415
|
/**
|
|
6494
|
-
* <p>The
|
|
6416
|
+
* <p>The style targets options for subtotals.</p>
|
|
6495
6417
|
* @public
|
|
6496
6418
|
*/
|
|
6497
|
-
|
|
6419
|
+
StyleTargets?: TableStyleTarget[] | undefined;
|
|
6498
6420
|
}
|
|
6499
6421
|
/**
|
|
6500
6422
|
* @public
|
|
6501
6423
|
* @enum
|
|
6502
6424
|
*/
|
|
6503
|
-
export declare const
|
|
6504
|
-
readonly
|
|
6505
|
-
readonly
|
|
6425
|
+
export declare const TableTotalsPlacement: {
|
|
6426
|
+
readonly AUTO: "AUTO";
|
|
6427
|
+
readonly END: "END";
|
|
6428
|
+
readonly START: "START";
|
|
6429
|
+
};
|
|
6430
|
+
/**
|
|
6431
|
+
* @public
|
|
6432
|
+
*/
|
|
6433
|
+
export type TableTotalsPlacement = (typeof TableTotalsPlacement)[keyof typeof TableTotalsPlacement];
|
|
6434
|
+
/**
|
|
6435
|
+
* @public
|
|
6436
|
+
* @enum
|
|
6437
|
+
*/
|
|
6438
|
+
export declare const TableTotalsScrollStatus: {
|
|
6439
|
+
readonly PINNED: "PINNED";
|
|
6440
|
+
readonly SCROLLED: "SCROLLED";
|
|
6506
6441
|
};
|
|
6507
6442
|
/**
|
|
6508
6443
|
* @public
|
|
6509
6444
|
*/
|
|
6510
|
-
export type
|
|
6445
|
+
export type TableTotalsScrollStatus = (typeof TableTotalsScrollStatus)[keyof typeof TableTotalsScrollStatus];
|
|
6511
6446
|
/**
|
|
6512
|
-
* <p>The table options for a table visual.</p>
|
|
6513
6447
|
* @public
|
|
6448
|
+
* @enum
|
|
6514
6449
|
*/
|
|
6515
|
-
export
|
|
6516
|
-
|
|
6517
|
-
|
|
6518
|
-
|
|
6519
|
-
|
|
6520
|
-
|
|
6450
|
+
export declare const SimpleTotalAggregationFunction: {
|
|
6451
|
+
readonly AVERAGE: "AVERAGE";
|
|
6452
|
+
readonly DEFAULT: "DEFAULT";
|
|
6453
|
+
readonly MAX: "MAX";
|
|
6454
|
+
readonly MIN: "MIN";
|
|
6455
|
+
readonly NONE: "NONE";
|
|
6456
|
+
readonly SUM: "SUM";
|
|
6457
|
+
};
|
|
6458
|
+
/**
|
|
6459
|
+
* @public
|
|
6460
|
+
*/
|
|
6461
|
+
export type SimpleTotalAggregationFunction = (typeof SimpleTotalAggregationFunction)[keyof typeof SimpleTotalAggregationFunction];
|
|
6462
|
+
/**
|
|
6463
|
+
* <p>An aggregation function that aggregates the total values of a measure.</p>
|
|
6464
|
+
* @public
|
|
6465
|
+
*/
|
|
6466
|
+
export interface TotalAggregationFunction {
|
|
6521
6467
|
/**
|
|
6522
|
-
* <p>
|
|
6468
|
+
* <p>A built in aggregation function for total values.</p>
|
|
6523
6469
|
* @public
|
|
6524
6470
|
*/
|
|
6525
|
-
|
|
6471
|
+
SimpleTotalAggregationFunction?: SimpleTotalAggregationFunction | undefined;
|
|
6472
|
+
}
|
|
6473
|
+
/**
|
|
6474
|
+
* <p>The total aggregation settings map of a field id.</p>
|
|
6475
|
+
* @public
|
|
6476
|
+
*/
|
|
6477
|
+
export interface TotalAggregationOption {
|
|
6526
6478
|
/**
|
|
6527
|
-
* <p>The
|
|
6479
|
+
* <p>The field id that's associated with the total aggregation option.</p>
|
|
6528
6480
|
* @public
|
|
6529
6481
|
*/
|
|
6530
|
-
|
|
6482
|
+
FieldId: string | undefined;
|
|
6531
6483
|
/**
|
|
6532
|
-
* <p>The
|
|
6484
|
+
* <p>The total aggregation function that you want to set for a specified field id.</p>
|
|
6533
6485
|
* @public
|
|
6534
6486
|
*/
|
|
6535
|
-
|
|
6487
|
+
TotalAggregationFunction: TotalAggregationFunction | undefined;
|
|
6536
6488
|
}
|
|
6537
6489
|
/**
|
|
6538
|
-
* <p>The
|
|
6490
|
+
* <p>The optional configuration of totals cells in a <code>PivotTableVisual</code>.</p>
|
|
6539
6491
|
* @public
|
|
6540
6492
|
*/
|
|
6541
|
-
export interface
|
|
6493
|
+
export interface PivotTotalOptions {
|
|
6542
6494
|
/**
|
|
6543
6495
|
* <p>The visibility configuration for the total cells.</p>
|
|
6544
6496
|
* @public
|
|
@@ -6560,56 +6512,87 @@ export interface TotalOptions {
|
|
|
6560
6512
|
*/
|
|
6561
6513
|
CustomLabel?: string | undefined;
|
|
6562
6514
|
/**
|
|
6563
|
-
* <p>
|
|
6515
|
+
* <p>The cell styling options for the total cells.</p>
|
|
6564
6516
|
* @public
|
|
6565
6517
|
*/
|
|
6566
6518
|
TotalCellStyle?: TableCellStyle | undefined;
|
|
6567
6519
|
/**
|
|
6568
|
-
* <p>The
|
|
6520
|
+
* <p>The cell styling options for the totals of value cells.</p>
|
|
6521
|
+
* @public
|
|
6522
|
+
*/
|
|
6523
|
+
ValueCellStyle?: TableCellStyle | undefined;
|
|
6524
|
+
/**
|
|
6525
|
+
* <p>The cell styling options for the total of header cells.</p>
|
|
6526
|
+
* @public
|
|
6527
|
+
*/
|
|
6528
|
+
MetricHeaderCellStyle?: TableCellStyle | undefined;
|
|
6529
|
+
/**
|
|
6530
|
+
* <p>The total aggregation options for each value field.</p>
|
|
6569
6531
|
* @public
|
|
6570
6532
|
*/
|
|
6571
6533
|
TotalAggregationOptions?: TotalAggregationOption[] | undefined;
|
|
6572
6534
|
}
|
|
6573
6535
|
/**
|
|
6574
|
-
* <p>The
|
|
6536
|
+
* <p>The total options for a pivot table visual.</p>
|
|
6575
6537
|
* @public
|
|
6576
6538
|
*/
|
|
6577
|
-
export interface
|
|
6539
|
+
export interface PivotTableTotalOptions {
|
|
6578
6540
|
/**
|
|
6579
|
-
* <p>The
|
|
6541
|
+
* <p>The row subtotal options.</p>
|
|
6580
6542
|
* @public
|
|
6581
6543
|
*/
|
|
6582
|
-
|
|
6544
|
+
RowSubtotalOptions?: SubtotalOptions | undefined;
|
|
6545
|
+
/**
|
|
6546
|
+
* <p>The column subtotal options.</p>
|
|
6547
|
+
* @public
|
|
6548
|
+
*/
|
|
6549
|
+
ColumnSubtotalOptions?: SubtotalOptions | undefined;
|
|
6550
|
+
/**
|
|
6551
|
+
* <p>The row total options.</p>
|
|
6552
|
+
* @public
|
|
6553
|
+
*/
|
|
6554
|
+
RowTotalOptions?: PivotTotalOptions | undefined;
|
|
6555
|
+
/**
|
|
6556
|
+
* <p>The column total options.</p>
|
|
6557
|
+
* @public
|
|
6558
|
+
*/
|
|
6559
|
+
ColumnTotalOptions?: PivotTotalOptions | undefined;
|
|
6560
|
+
}
|
|
6561
|
+
/**
|
|
6562
|
+
* <p>The configuration for a <code>PivotTableVisual</code>.</p>
|
|
6563
|
+
* @public
|
|
6564
|
+
*/
|
|
6565
|
+
export interface PivotTableConfiguration {
|
|
6583
6566
|
/**
|
|
6584
|
-
* <p>The
|
|
6567
|
+
* <p>The field wells of the visual.</p>
|
|
6585
6568
|
* @public
|
|
6586
6569
|
*/
|
|
6587
|
-
|
|
6570
|
+
FieldWells?: PivotTableFieldWells | undefined;
|
|
6588
6571
|
/**
|
|
6589
|
-
* <p>The
|
|
6572
|
+
* <p>The sort configuration for a <code>PivotTableVisual</code>.</p>
|
|
6590
6573
|
* @public
|
|
6591
6574
|
*/
|
|
6592
|
-
|
|
6575
|
+
SortConfiguration?: PivotTableSortConfiguration | undefined;
|
|
6593
6576
|
/**
|
|
6594
|
-
* <p>The
|
|
6577
|
+
* <p>The table options for a pivot table visual.</p>
|
|
6595
6578
|
* @public
|
|
6596
6579
|
*/
|
|
6597
|
-
|
|
6580
|
+
TableOptions?: PivotTableOptions | undefined;
|
|
6598
6581
|
/**
|
|
6599
|
-
* <p>The
|
|
6582
|
+
* <p>The total options for a pivot table visual.</p>
|
|
6600
6583
|
* @public
|
|
6601
6584
|
*/
|
|
6602
|
-
|
|
6585
|
+
TotalOptions?: PivotTableTotalOptions | undefined;
|
|
6603
6586
|
/**
|
|
6604
|
-
* <p>The
|
|
6587
|
+
* <p>The field options for a pivot table visual.</p>
|
|
6605
6588
|
* @public
|
|
6606
6589
|
*/
|
|
6607
|
-
|
|
6590
|
+
FieldOptions?: PivotTableFieldOptions | undefined;
|
|
6608
6591
|
/**
|
|
6609
|
-
* <p>
|
|
6592
|
+
* <p>The paginated report options for a pivot table visual.</p>
|
|
6610
6593
|
* @public
|
|
6611
6594
|
*/
|
|
6612
|
-
|
|
6595
|
+
PaginatedReportOptions?: PivotTablePaginatedReportOptions | undefined;
|
|
6613
6596
|
/**
|
|
6614
6597
|
* <p>The general visual interactions setup for a visual.</p>
|
|
6615
6598
|
* @public
|
|
@@ -6617,70 +6600,104 @@ export interface TableConfiguration {
|
|
|
6617
6600
|
Interactions?: VisualInteractionOptions | undefined;
|
|
6618
6601
|
}
|
|
6619
6602
|
/**
|
|
6620
|
-
* <p>The cell conditional formatting option for a table.</p>
|
|
6621
6603
|
* @public
|
|
6604
|
+
* @enum
|
|
6622
6605
|
*/
|
|
6623
|
-
export
|
|
6624
|
-
|
|
6625
|
-
|
|
6626
|
-
|
|
6627
|
-
|
|
6628
|
-
|
|
6606
|
+
export declare const PivotTableConditionalFormattingScopeRole: {
|
|
6607
|
+
readonly FIELD: "FIELD";
|
|
6608
|
+
readonly FIELD_TOTAL: "FIELD_TOTAL";
|
|
6609
|
+
readonly GRAND_TOTAL: "GRAND_TOTAL";
|
|
6610
|
+
};
|
|
6611
|
+
/**
|
|
6612
|
+
* @public
|
|
6613
|
+
*/
|
|
6614
|
+
export type PivotTableConditionalFormattingScopeRole = (typeof PivotTableConditionalFormattingScopeRole)[keyof typeof PivotTableConditionalFormattingScopeRole];
|
|
6615
|
+
/**
|
|
6616
|
+
* <p>The scope of the cell for conditional formatting.</p>
|
|
6617
|
+
* @public
|
|
6618
|
+
*/
|
|
6619
|
+
export interface PivotTableConditionalFormattingScope {
|
|
6629
6620
|
/**
|
|
6630
|
-
* <p>The
|
|
6621
|
+
* <p>The role (field, field total, grand total) of the cell for conditional formatting.</p>
|
|
6631
6622
|
* @public
|
|
6632
6623
|
*/
|
|
6633
|
-
|
|
6624
|
+
Role?: PivotTableConditionalFormattingScopeRole | undefined;
|
|
6634
6625
|
}
|
|
6635
6626
|
/**
|
|
6636
|
-
* <p>The conditional formatting
|
|
6627
|
+
* <p>The conditional formatting for the text.</p>
|
|
6637
6628
|
* @public
|
|
6638
6629
|
*/
|
|
6639
|
-
export interface
|
|
6630
|
+
export interface TextConditionalFormat {
|
|
6640
6631
|
/**
|
|
6641
|
-
* <p>The conditional formatting
|
|
6632
|
+
* <p>The conditional formatting for the text background color.</p>
|
|
6642
6633
|
* @public
|
|
6643
6634
|
*/
|
|
6644
6635
|
BackgroundColor?: ConditionalFormattingColor | undefined;
|
|
6645
6636
|
/**
|
|
6646
|
-
* <p>The conditional formatting
|
|
6637
|
+
* <p>The conditional formatting for the text color.</p>
|
|
6647
6638
|
* @public
|
|
6648
6639
|
*/
|
|
6649
6640
|
TextColor?: ConditionalFormattingColor | undefined;
|
|
6641
|
+
/**
|
|
6642
|
+
* <p>The conditional formatting for the icon.</p>
|
|
6643
|
+
* @public
|
|
6644
|
+
*/
|
|
6645
|
+
Icon?: ConditionalFormattingIcon | undefined;
|
|
6650
6646
|
}
|
|
6651
6647
|
/**
|
|
6652
|
-
* <p>
|
|
6648
|
+
* <p>The cell conditional formatting option for a pivot table.</p>
|
|
6653
6649
|
* @public
|
|
6654
6650
|
*/
|
|
6655
|
-
export interface
|
|
6651
|
+
export interface PivotTableCellConditionalFormatting {
|
|
6652
|
+
/**
|
|
6653
|
+
* <p>The field ID of the cell for conditional formatting.</p>
|
|
6654
|
+
* @public
|
|
6655
|
+
*/
|
|
6656
|
+
FieldId: string | undefined;
|
|
6657
|
+
/**
|
|
6658
|
+
* <p>The text format of the cell for conditional formatting.</p>
|
|
6659
|
+
* @public
|
|
6660
|
+
*/
|
|
6661
|
+
TextFormat?: TextConditionalFormat | undefined;
|
|
6656
6662
|
/**
|
|
6657
|
-
* <p>The
|
|
6663
|
+
* <p>The scope of the cell for conditional formatting.</p>
|
|
6664
|
+
* @public
|
|
6665
|
+
*/
|
|
6666
|
+
Scope?: PivotTableConditionalFormattingScope | undefined;
|
|
6667
|
+
/**
|
|
6668
|
+
* <p>A list of cell scopes for conditional formatting.</p>
|
|
6658
6669
|
* @public
|
|
6659
6670
|
*/
|
|
6660
|
-
|
|
6671
|
+
Scopes?: PivotTableConditionalFormattingScope[] | undefined;
|
|
6672
|
+
}
|
|
6673
|
+
/**
|
|
6674
|
+
* <p>Conditional formatting options for a <code>PivotTableVisual</code>.</p>
|
|
6675
|
+
* @public
|
|
6676
|
+
*/
|
|
6677
|
+
export interface PivotTableConditionalFormattingOption {
|
|
6661
6678
|
/**
|
|
6662
|
-
* <p>The
|
|
6679
|
+
* <p>The cell conditional formatting option for a pivot table.</p>
|
|
6663
6680
|
* @public
|
|
6664
6681
|
*/
|
|
6665
|
-
|
|
6682
|
+
Cell?: PivotTableCellConditionalFormatting | undefined;
|
|
6666
6683
|
}
|
|
6667
6684
|
/**
|
|
6668
6685
|
* <p>The conditional formatting for a <code>PivotTableVisual</code>.</p>
|
|
6669
6686
|
* @public
|
|
6670
6687
|
*/
|
|
6671
|
-
export interface
|
|
6688
|
+
export interface PivotTableConditionalFormatting {
|
|
6672
6689
|
/**
|
|
6673
6690
|
* <p>Conditional formatting options for a <code>PivotTableVisual</code>.</p>
|
|
6674
6691
|
* @public
|
|
6675
6692
|
*/
|
|
6676
|
-
ConditionalFormattingOptions?:
|
|
6693
|
+
ConditionalFormattingOptions?: PivotTableConditionalFormattingOption[] | undefined;
|
|
6677
6694
|
}
|
|
6678
6695
|
/**
|
|
6679
|
-
* <p>A table
|
|
6680
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/
|
|
6696
|
+
* <p>A pivot table.</p>
|
|
6697
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html">Using pivot tables</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6681
6698
|
* @public
|
|
6682
6699
|
*/
|
|
6683
|
-
export interface
|
|
6700
|
+
export interface PivotTableVisual {
|
|
6684
6701
|
/**
|
|
6685
6702
|
* <p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..</p>
|
|
6686
6703
|
* @public
|
|
@@ -6700,67 +6717,96 @@ export interface TableVisual {
|
|
|
6700
6717
|
* <p>The configuration settings of the visual.</p>
|
|
6701
6718
|
* @public
|
|
6702
6719
|
*/
|
|
6703
|
-
ChartConfiguration?:
|
|
6720
|
+
ChartConfiguration?: PivotTableConfiguration | undefined;
|
|
6704
6721
|
/**
|
|
6705
6722
|
* <p>The conditional formatting for a <code>PivotTableVisual</code>.</p>
|
|
6706
6723
|
* @public
|
|
6707
6724
|
*/
|
|
6708
|
-
ConditionalFormatting?:
|
|
6725
|
+
ConditionalFormatting?: PivotTableConditionalFormatting | undefined;
|
|
6709
6726
|
/**
|
|
6710
6727
|
* <p>The list of custom actions that are configured for a visual.</p>
|
|
6711
6728
|
* @public
|
|
6712
6729
|
*/
|
|
6713
6730
|
Actions?: VisualCustomAction[] | undefined;
|
|
6731
|
+
/**
|
|
6732
|
+
* <p>The alt text for the visual.</p>
|
|
6733
|
+
* @public
|
|
6734
|
+
*/
|
|
6735
|
+
VisualContentAltText?: string | undefined;
|
|
6714
6736
|
}
|
|
6715
6737
|
/**
|
|
6716
|
-
*
|
|
6738
|
+
* @public
|
|
6739
|
+
* @enum
|
|
6740
|
+
*/
|
|
6741
|
+
export declare const PluginVisualAxisName: {
|
|
6742
|
+
readonly GROUP_BY: "GROUP_BY";
|
|
6743
|
+
readonly VALUE: "VALUE";
|
|
6744
|
+
};
|
|
6745
|
+
/**
|
|
6746
|
+
* @public
|
|
6747
|
+
*/
|
|
6748
|
+
export type PluginVisualAxisName = (typeof PluginVisualAxisName)[keyof typeof PluginVisualAxisName];
|
|
6749
|
+
/**
|
|
6750
|
+
* <p>A collection of field wells for a plugin visual.</p>
|
|
6717
6751
|
* @public
|
|
6718
6752
|
*/
|
|
6719
|
-
export interface
|
|
6753
|
+
export interface PluginVisualFieldWell {
|
|
6754
|
+
/**
|
|
6755
|
+
* <p>The semantic axis name for the field well.</p>
|
|
6756
|
+
* @public
|
|
6757
|
+
*/
|
|
6758
|
+
AxisName?: PluginVisualAxisName | undefined;
|
|
6720
6759
|
/**
|
|
6721
|
-
* <p>
|
|
6760
|
+
* <p>A list of dimensions for the field well.</p>
|
|
6722
6761
|
* @public
|
|
6723
6762
|
*/
|
|
6724
|
-
|
|
6763
|
+
Dimensions?: DimensionField[] | undefined;
|
|
6725
6764
|
/**
|
|
6726
|
-
* <p>
|
|
6765
|
+
* <p>A list of measures that exist in the field well.</p>
|
|
6727
6766
|
* @public
|
|
6728
6767
|
*/
|
|
6729
|
-
|
|
6768
|
+
Measures?: MeasureField[] | undefined;
|
|
6730
6769
|
/**
|
|
6731
|
-
* <p>
|
|
6770
|
+
* <p>A list of unaggregated fields that exist in the field well.</p>
|
|
6732
6771
|
* @public
|
|
6733
6772
|
*/
|
|
6734
|
-
|
|
6773
|
+
Unaggregated?: UnaggregatedField[] | undefined;
|
|
6735
6774
|
}
|
|
6736
6775
|
/**
|
|
6737
|
-
* <p>
|
|
6738
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
6776
|
+
* <p>A query limits configuration.</p>
|
|
6739
6777
|
* @public
|
|
6740
6778
|
*/
|
|
6741
|
-
export interface
|
|
6779
|
+
export interface PluginVisualItemsLimitConfiguration {
|
|
6742
6780
|
/**
|
|
6743
|
-
* <p>
|
|
6781
|
+
* <p>Determines how many values are be fetched at once.</p>
|
|
6744
6782
|
* @public
|
|
6745
6783
|
*/
|
|
6746
|
-
|
|
6784
|
+
ItemsLimit?: number | undefined;
|
|
6747
6785
|
}
|
|
6748
6786
|
/**
|
|
6749
|
-
* <p>The
|
|
6787
|
+
* <p>The table query sorting options for the plugin visual.</p>
|
|
6750
6788
|
* @public
|
|
6751
6789
|
*/
|
|
6752
|
-
export interface
|
|
6790
|
+
export interface PluginVisualTableQuerySort {
|
|
6753
6791
|
/**
|
|
6754
|
-
* <p>
|
|
6792
|
+
* <p>Determines how data is sorted in the response.</p>
|
|
6755
6793
|
* @public
|
|
6756
6794
|
*/
|
|
6757
|
-
|
|
6795
|
+
RowSort?: FieldSortOptions[] | undefined;
|
|
6758
6796
|
/**
|
|
6759
|
-
* <p>The
|
|
6797
|
+
* <p>The maximum amount of data to be returned by a query.</p>
|
|
6760
6798
|
* @public
|
|
6761
6799
|
*/
|
|
6762
|
-
|
|
6800
|
+
ItemsLimitConfiguration?: PluginVisualItemsLimitConfiguration | undefined;
|
|
6763
6801
|
}
|
|
6802
|
+
/**
|
|
6803
|
+
* @internal
|
|
6804
|
+
*/
|
|
6805
|
+
export declare const ReferenceLineLabelConfigurationFilterSensitiveLog: (obj: ReferenceLineLabelConfiguration) => any;
|
|
6806
|
+
/**
|
|
6807
|
+
* @internal
|
|
6808
|
+
*/
|
|
6809
|
+
export declare const ReferenceLineFilterSensitiveLog: (obj: ReferenceLine) => any;
|
|
6764
6810
|
/**
|
|
6765
6811
|
* @internal
|
|
6766
6812
|
*/
|
|
@@ -7073,6 +7119,38 @@ export declare const KPIConditionalFormattingFilterSensitiveLog: (obj: KPICondit
|
|
|
7073
7119
|
* @internal
|
|
7074
7120
|
*/
|
|
7075
7121
|
export declare const KPIVisualFilterSensitiveLog: (obj: KPIVisual) => any;
|
|
7122
|
+
/**
|
|
7123
|
+
* @internal
|
|
7124
|
+
*/
|
|
7125
|
+
export declare const LayerCustomActionOperationFilterSensitiveLog: (obj: LayerCustomActionOperation) => any;
|
|
7126
|
+
/**
|
|
7127
|
+
* @internal
|
|
7128
|
+
*/
|
|
7129
|
+
export declare const LayerCustomActionFilterSensitiveLog: (obj: LayerCustomAction) => any;
|
|
7130
|
+
/**
|
|
7131
|
+
* @internal
|
|
7132
|
+
*/
|
|
7133
|
+
export declare const GeospatialLayerColorFieldFilterSensitiveLog: (obj: GeospatialLayerColorField) => any;
|
|
7134
|
+
/**
|
|
7135
|
+
* @internal
|
|
7136
|
+
*/
|
|
7137
|
+
export declare const UnaggregatedFieldFilterSensitiveLog: (obj: UnaggregatedField) => any;
|
|
7138
|
+
/**
|
|
7139
|
+
* @internal
|
|
7140
|
+
*/
|
|
7141
|
+
export declare const GeospatialLayerJoinDefinitionFilterSensitiveLog: (obj: GeospatialLayerJoinDefinition) => any;
|
|
7142
|
+
/**
|
|
7143
|
+
* @internal
|
|
7144
|
+
*/
|
|
7145
|
+
export declare const GeospatialLayerItemFilterSensitiveLog: (obj: GeospatialLayerItem) => any;
|
|
7146
|
+
/**
|
|
7147
|
+
* @internal
|
|
7148
|
+
*/
|
|
7149
|
+
export declare const GeospatialLayerMapConfigurationFilterSensitiveLog: (obj: GeospatialLayerMapConfiguration) => any;
|
|
7150
|
+
/**
|
|
7151
|
+
* @internal
|
|
7152
|
+
*/
|
|
7153
|
+
export declare const LayerMapVisualFilterSensitiveLog: (obj: LayerMapVisual) => any;
|
|
7076
7154
|
/**
|
|
7077
7155
|
* @internal
|
|
7078
7156
|
*/
|
|
@@ -7180,100 +7258,4 @@ export declare const PivotTableVisualFilterSensitiveLog: (obj: PivotTableVisual)
|
|
|
7180
7258
|
/**
|
|
7181
7259
|
* @internal
|
|
7182
7260
|
*/
|
|
7183
|
-
export declare const
|
|
7184
|
-
/**
|
|
7185
|
-
* @internal
|
|
7186
|
-
*/
|
|
7187
|
-
export declare const RadarChartFieldWellsFilterSensitiveLog: (obj: RadarChartFieldWells) => any;
|
|
7188
|
-
/**
|
|
7189
|
-
* @internal
|
|
7190
|
-
*/
|
|
7191
|
-
export declare const RadarChartConfigurationFilterSensitiveLog: (obj: RadarChartConfiguration) => any;
|
|
7192
|
-
/**
|
|
7193
|
-
* @internal
|
|
7194
|
-
*/
|
|
7195
|
-
export declare const RadarChartVisualFilterSensitiveLog: (obj: RadarChartVisual) => any;
|
|
7196
|
-
/**
|
|
7197
|
-
* @internal
|
|
7198
|
-
*/
|
|
7199
|
-
export declare const SankeyDiagramAggregatedFieldWellsFilterSensitiveLog: (obj: SankeyDiagramAggregatedFieldWells) => any;
|
|
7200
|
-
/**
|
|
7201
|
-
* @internal
|
|
7202
|
-
*/
|
|
7203
|
-
export declare const SankeyDiagramFieldWellsFilterSensitiveLog: (obj: SankeyDiagramFieldWells) => any;
|
|
7204
|
-
/**
|
|
7205
|
-
* @internal
|
|
7206
|
-
*/
|
|
7207
|
-
export declare const SankeyDiagramChartConfigurationFilterSensitiveLog: (obj: SankeyDiagramChartConfiguration) => any;
|
|
7208
|
-
/**
|
|
7209
|
-
* @internal
|
|
7210
|
-
*/
|
|
7211
|
-
export declare const SankeyDiagramVisualFilterSensitiveLog: (obj: SankeyDiagramVisual) => any;
|
|
7212
|
-
/**
|
|
7213
|
-
* @internal
|
|
7214
|
-
*/
|
|
7215
|
-
export declare const ScatterPlotCategoricallyAggregatedFieldWellsFilterSensitiveLog: (obj: ScatterPlotCategoricallyAggregatedFieldWells) => any;
|
|
7216
|
-
/**
|
|
7217
|
-
* @internal
|
|
7218
|
-
*/
|
|
7219
|
-
export declare const ScatterPlotUnaggregatedFieldWellsFilterSensitiveLog: (obj: ScatterPlotUnaggregatedFieldWells) => any;
|
|
7220
|
-
/**
|
|
7221
|
-
* @internal
|
|
7222
|
-
*/
|
|
7223
|
-
export declare const ScatterPlotFieldWellsFilterSensitiveLog: (obj: ScatterPlotFieldWells) => any;
|
|
7224
|
-
/**
|
|
7225
|
-
* @internal
|
|
7226
|
-
*/
|
|
7227
|
-
export declare const ScatterPlotConfigurationFilterSensitiveLog: (obj: ScatterPlotConfiguration) => any;
|
|
7228
|
-
/**
|
|
7229
|
-
* @internal
|
|
7230
|
-
*/
|
|
7231
|
-
export declare const ScatterPlotVisualFilterSensitiveLog: (obj: ScatterPlotVisual) => any;
|
|
7232
|
-
/**
|
|
7233
|
-
* @internal
|
|
7234
|
-
*/
|
|
7235
|
-
export declare const TableAggregatedFieldWellsFilterSensitiveLog: (obj: TableAggregatedFieldWells) => any;
|
|
7236
|
-
/**
|
|
7237
|
-
* @internal
|
|
7238
|
-
*/
|
|
7239
|
-
export declare const UnaggregatedFieldFilterSensitiveLog: (obj: UnaggregatedField) => any;
|
|
7240
|
-
/**
|
|
7241
|
-
* @internal
|
|
7242
|
-
*/
|
|
7243
|
-
export declare const TableUnaggregatedFieldWellsFilterSensitiveLog: (obj: TableUnaggregatedFieldWells) => any;
|
|
7244
|
-
/**
|
|
7245
|
-
* @internal
|
|
7246
|
-
*/
|
|
7247
|
-
export declare const TableFieldWellsFilterSensitiveLog: (obj: TableFieldWells) => any;
|
|
7248
|
-
/**
|
|
7249
|
-
* @internal
|
|
7250
|
-
*/
|
|
7251
|
-
export declare const TableConfigurationFilterSensitiveLog: (obj: TableConfiguration) => any;
|
|
7252
|
-
/**
|
|
7253
|
-
* @internal
|
|
7254
|
-
*/
|
|
7255
|
-
export declare const TableCellConditionalFormattingFilterSensitiveLog: (obj: TableCellConditionalFormatting) => any;
|
|
7256
|
-
/**
|
|
7257
|
-
* @internal
|
|
7258
|
-
*/
|
|
7259
|
-
export declare const TableRowConditionalFormattingFilterSensitiveLog: (obj: TableRowConditionalFormatting) => any;
|
|
7260
|
-
/**
|
|
7261
|
-
* @internal
|
|
7262
|
-
*/
|
|
7263
|
-
export declare const TableConditionalFormattingOptionFilterSensitiveLog: (obj: TableConditionalFormattingOption) => any;
|
|
7264
|
-
/**
|
|
7265
|
-
* @internal
|
|
7266
|
-
*/
|
|
7267
|
-
export declare const TableConditionalFormattingFilterSensitiveLog: (obj: TableConditionalFormatting) => any;
|
|
7268
|
-
/**
|
|
7269
|
-
* @internal
|
|
7270
|
-
*/
|
|
7271
|
-
export declare const TableVisualFilterSensitiveLog: (obj: TableVisual) => any;
|
|
7272
|
-
/**
|
|
7273
|
-
* @internal
|
|
7274
|
-
*/
|
|
7275
|
-
export declare const TreeMapAggregatedFieldWellsFilterSensitiveLog: (obj: TreeMapAggregatedFieldWells) => any;
|
|
7276
|
-
/**
|
|
7277
|
-
* @internal
|
|
7278
|
-
*/
|
|
7279
|
-
export declare const TreeMapFieldWellsFilterSensitiveLog: (obj: TreeMapFieldWells) => any;
|
|
7261
|
+
export declare const PluginVisualFieldWellFilterSensitiveLog: (obj: PluginVisualFieldWell) => any;
|