@aws-sdk/client-quicksight 3.379.1 → 3.382.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.
|
@@ -12,6 +12,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
12
12
|
readonly $fault: "client";
|
|
13
13
|
Message?: string;
|
|
14
14
|
/**
|
|
15
|
+
* @public
|
|
15
16
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
16
17
|
*/
|
|
17
18
|
RequestId?: string;
|
|
@@ -26,10 +27,12 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
26
27
|
*/
|
|
27
28
|
export interface AccountCustomization {
|
|
28
29
|
/**
|
|
30
|
+
* @public
|
|
29
31
|
* <p>The default theme for this Amazon QuickSight subscription.</p>
|
|
30
32
|
*/
|
|
31
33
|
DefaultTheme?: string;
|
|
32
34
|
/**
|
|
35
|
+
* @public
|
|
33
36
|
* <p>The default email customization template.</p>
|
|
34
37
|
*/
|
|
35
38
|
DefaultEmailCustomizationTemplate?: string;
|
|
@@ -72,24 +75,29 @@ export type Edition = (typeof Edition)[keyof typeof Edition];
|
|
|
72
75
|
*/
|
|
73
76
|
export interface AccountInfo {
|
|
74
77
|
/**
|
|
78
|
+
* @public
|
|
75
79
|
* <p>The account name that you provided for the Amazon QuickSight subscription in your
|
|
76
80
|
* Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when
|
|
77
81
|
* users sign in.</p>
|
|
78
82
|
*/
|
|
79
83
|
AccountName?: string;
|
|
80
84
|
/**
|
|
85
|
+
* @public
|
|
81
86
|
* <p>The edition of your Amazon QuickSight account.</p>
|
|
82
87
|
*/
|
|
83
88
|
Edition?: Edition | string;
|
|
84
89
|
/**
|
|
90
|
+
* @public
|
|
85
91
|
* <p>The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.</p>
|
|
86
92
|
*/
|
|
87
93
|
NotificationEmail?: string;
|
|
88
94
|
/**
|
|
95
|
+
* @public
|
|
89
96
|
* <p>The way that your Amazon QuickSight account is authenticated.</p>
|
|
90
97
|
*/
|
|
91
98
|
AuthenticationType?: string;
|
|
92
99
|
/**
|
|
100
|
+
* @public
|
|
93
101
|
* <p>The status of your account subscription.</p>
|
|
94
102
|
*/
|
|
95
103
|
AccountSubscriptionStatus?: string;
|
|
@@ -100,29 +108,35 @@ export interface AccountInfo {
|
|
|
100
108
|
*/
|
|
101
109
|
export interface AccountSettings {
|
|
102
110
|
/**
|
|
111
|
+
* @public
|
|
103
112
|
* <p>The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account.
|
|
104
113
|
* You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and
|
|
105
114
|
* it appears only when users sign in.</p>
|
|
106
115
|
*/
|
|
107
116
|
AccountName?: string;
|
|
108
117
|
/**
|
|
118
|
+
* @public
|
|
109
119
|
* <p>The edition of Amazon QuickSight that you're currently subscribed to:
|
|
110
120
|
* Enterprise edition or Standard edition.</p>
|
|
111
121
|
*/
|
|
112
122
|
Edition?: Edition | string;
|
|
113
123
|
/**
|
|
124
|
+
* @public
|
|
114
125
|
* <p>The default Amazon QuickSight namespace for your Amazon Web Services account. </p>
|
|
115
126
|
*/
|
|
116
127
|
DefaultNamespace?: string;
|
|
117
128
|
/**
|
|
129
|
+
* @public
|
|
118
130
|
* <p>The main notification email for your Amazon QuickSight subscription.</p>
|
|
119
131
|
*/
|
|
120
132
|
NotificationEmail?: string;
|
|
121
133
|
/**
|
|
134
|
+
* @public
|
|
122
135
|
* <p>A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html">UpdatePublicSharingSettings</a>.</p>
|
|
123
136
|
*/
|
|
124
137
|
PublicSharingEnabled?: boolean;
|
|
125
138
|
/**
|
|
139
|
+
* @public
|
|
126
140
|
* <p>A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A <code>True</code> value doesn't allow the account to be deleted and results in an error message if a user tries to make a <code>DeleteAccountSubsctiption</code> request. A <code>False</code> value will allow the ccount to be deleted. </p>
|
|
127
141
|
*/
|
|
128
142
|
TerminationProtectionEnabled?: boolean;
|
|
@@ -133,10 +147,12 @@ export interface AccountSettings {
|
|
|
133
147
|
*/
|
|
134
148
|
export interface ActiveIAMPolicyAssignment {
|
|
135
149
|
/**
|
|
150
|
+
* @public
|
|
136
151
|
* <p>A name for the IAM policy assignment.</p>
|
|
137
152
|
*/
|
|
138
153
|
AssignmentName?: string;
|
|
139
154
|
/**
|
|
155
|
+
* @public
|
|
140
156
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
141
157
|
*/
|
|
142
158
|
PolicyArn?: string;
|
|
@@ -159,6 +175,7 @@ export type DashboardBehavior = (typeof DashboardBehavior)[keyof typeof Dashboar
|
|
|
159
175
|
*/
|
|
160
176
|
export interface AdHocFilteringOption {
|
|
161
177
|
/**
|
|
178
|
+
* @public
|
|
162
179
|
* <p>Availability status.</p>
|
|
163
180
|
*/
|
|
164
181
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
@@ -180,6 +197,7 @@ export type SimpleAttributeAggregationFunction = (typeof SimpleAttributeAggregat
|
|
|
180
197
|
*/
|
|
181
198
|
export interface AttributeAggregationFunction {
|
|
182
199
|
/**
|
|
200
|
+
* @public
|
|
183
201
|
* <p>The built-in aggregation functions for attributes.</p>
|
|
184
202
|
* <ul>
|
|
185
203
|
* <li>
|
|
@@ -190,6 +208,7 @@ export interface AttributeAggregationFunction {
|
|
|
190
208
|
*/
|
|
191
209
|
SimpleAttributeAggregation?: SimpleAttributeAggregationFunction | string;
|
|
192
210
|
/**
|
|
211
|
+
* @public
|
|
193
212
|
* <p>Used by the <code>UNIQUE_VALUE</code> aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'.</p>
|
|
194
213
|
*/
|
|
195
214
|
ValueForMultipleValues?: string;
|
|
@@ -226,6 +245,7 @@ export type DateAggregationFunction = (typeof DateAggregationFunction)[keyof typ
|
|
|
226
245
|
*/
|
|
227
246
|
export interface PercentileAggregation {
|
|
228
247
|
/**
|
|
248
|
+
* @public
|
|
229
249
|
* <p>The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.</p>
|
|
230
250
|
*/
|
|
231
251
|
PercentileValue?: number;
|
|
@@ -257,6 +277,7 @@ export type SimpleNumericalAggregationFunction = (typeof SimpleNumericalAggregat
|
|
|
257
277
|
*/
|
|
258
278
|
export interface NumericalAggregationFunction {
|
|
259
279
|
/**
|
|
280
|
+
* @public
|
|
260
281
|
* <p>Built-in aggregation functions for numerical values.</p>
|
|
261
282
|
* <ul>
|
|
262
283
|
* <li>
|
|
@@ -307,6 +328,7 @@ export interface NumericalAggregationFunction {
|
|
|
307
328
|
*/
|
|
308
329
|
SimpleNumericalAggregation?: SimpleNumericalAggregationFunction | string;
|
|
309
330
|
/**
|
|
331
|
+
* @public
|
|
310
332
|
* <p>An aggregation based on the percentile of values in a dimension or measure.</p>
|
|
311
333
|
*/
|
|
312
334
|
PercentileAggregation?: PercentileAggregation;
|
|
@@ -318,10 +340,12 @@ export interface NumericalAggregationFunction {
|
|
|
318
340
|
*/
|
|
319
341
|
export interface AggregationFunction {
|
|
320
342
|
/**
|
|
343
|
+
* @public
|
|
321
344
|
* <p>Aggregation for numerical values.</p>
|
|
322
345
|
*/
|
|
323
346
|
NumericalAggregationFunction?: NumericalAggregationFunction;
|
|
324
347
|
/**
|
|
348
|
+
* @public
|
|
325
349
|
* <p>Aggregation for categorical values.</p>
|
|
326
350
|
* <ul>
|
|
327
351
|
* <li>
|
|
@@ -336,6 +360,7 @@ export interface AggregationFunction {
|
|
|
336
360
|
*/
|
|
337
361
|
CategoricalAggregationFunction?: CategoricalAggregationFunction | string;
|
|
338
362
|
/**
|
|
363
|
+
* @public
|
|
339
364
|
* <p>Aggregation for date values.</p>
|
|
340
365
|
* <ul>
|
|
341
366
|
* <li>
|
|
@@ -358,6 +383,7 @@ export interface AggregationFunction {
|
|
|
358
383
|
*/
|
|
359
384
|
DateAggregationFunction?: DateAggregationFunction | string;
|
|
360
385
|
/**
|
|
386
|
+
* @public
|
|
361
387
|
* <p>Aggregation for attributes.</p>
|
|
362
388
|
*/
|
|
363
389
|
AttributeAggregationFunction?: AttributeAggregationFunction;
|
|
@@ -368,10 +394,12 @@ export interface AggregationFunction {
|
|
|
368
394
|
*/
|
|
369
395
|
export interface ColumnIdentifier {
|
|
370
396
|
/**
|
|
397
|
+
* @public
|
|
371
398
|
* <p>The data set that the column belongs to.</p>
|
|
372
399
|
*/
|
|
373
400
|
DataSetIdentifier: string | undefined;
|
|
374
401
|
/**
|
|
402
|
+
* @public
|
|
375
403
|
* <p>The name of the column.</p>
|
|
376
404
|
*/
|
|
377
405
|
ColumnName: string | undefined;
|
|
@@ -394,10 +422,12 @@ export type SortDirection = (typeof SortDirection)[keyof typeof SortDirection];
|
|
|
394
422
|
*/
|
|
395
423
|
export interface AggregationSortConfiguration {
|
|
396
424
|
/**
|
|
425
|
+
* @public
|
|
397
426
|
* <p>The column that determines the sort order of aggregated values.</p>
|
|
398
427
|
*/
|
|
399
428
|
Column: ColumnIdentifier | undefined;
|
|
400
429
|
/**
|
|
430
|
+
* @public
|
|
401
431
|
* <p>The sort direction of values.</p>
|
|
402
432
|
* <ul>
|
|
403
433
|
* <li>
|
|
@@ -412,6 +442,7 @@ export interface AggregationSortConfiguration {
|
|
|
412
442
|
*/
|
|
413
443
|
SortDirection: SortDirection | string | undefined;
|
|
414
444
|
/**
|
|
445
|
+
* @public
|
|
415
446
|
* <p>The function that aggregates the values in <code>Column</code>.</p>
|
|
416
447
|
*/
|
|
417
448
|
AggregationFunction?: AggregationFunction;
|
|
@@ -422,6 +453,7 @@ export interface AggregationSortConfiguration {
|
|
|
422
453
|
*/
|
|
423
454
|
export interface AmazonElasticsearchParameters {
|
|
424
455
|
/**
|
|
456
|
+
* @public
|
|
425
457
|
* <p>The OpenSearch domain.</p>
|
|
426
458
|
*/
|
|
427
459
|
Domain: string | undefined;
|
|
@@ -432,6 +464,7 @@ export interface AmazonElasticsearchParameters {
|
|
|
432
464
|
*/
|
|
433
465
|
export interface AmazonOpenSearchParameters {
|
|
434
466
|
/**
|
|
467
|
+
* @public
|
|
435
468
|
* <p>The OpenSearch domain.</p>
|
|
436
469
|
*/
|
|
437
470
|
Domain: string | undefined;
|
|
@@ -462,6 +495,7 @@ export type AnalysisErrorType = (typeof AnalysisErrorType)[keyof typeof Analysis
|
|
|
462
495
|
*/
|
|
463
496
|
export interface Entity {
|
|
464
497
|
/**
|
|
498
|
+
* @public
|
|
465
499
|
* <p>The hierarchical path of the entity within the analysis, template, or dashboard definition tree.</p>
|
|
466
500
|
*/
|
|
467
501
|
Path?: string;
|
|
@@ -472,14 +506,17 @@ export interface Entity {
|
|
|
472
506
|
*/
|
|
473
507
|
export interface AnalysisError {
|
|
474
508
|
/**
|
|
509
|
+
* @public
|
|
475
510
|
* <p>The type of the analysis error.</p>
|
|
476
511
|
*/
|
|
477
512
|
Type?: AnalysisErrorType | string;
|
|
478
513
|
/**
|
|
514
|
+
* @public
|
|
479
515
|
* <p>The message associated with the analysis error.</p>
|
|
480
516
|
*/
|
|
481
517
|
Message?: string;
|
|
482
518
|
/**
|
|
519
|
+
* @public
|
|
483
520
|
* <p>Lists the violated entities that caused the analysis error</p>
|
|
484
521
|
*/
|
|
485
522
|
ViolatedEntities?: Entity[];
|
|
@@ -494,10 +531,12 @@ export interface AnalysisError {
|
|
|
494
531
|
*/
|
|
495
532
|
export interface Sheet {
|
|
496
533
|
/**
|
|
534
|
+
* @public
|
|
497
535
|
* <p>The unique identifier associated with a sheet.</p>
|
|
498
536
|
*/
|
|
499
537
|
SheetId?: string;
|
|
500
538
|
/**
|
|
539
|
+
* @public
|
|
501
540
|
* <p>The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight
|
|
502
541
|
* console.</p>
|
|
503
542
|
*/
|
|
@@ -526,42 +565,52 @@ export type ResourceStatus = (typeof ResourceStatus)[keyof typeof ResourceStatus
|
|
|
526
565
|
*/
|
|
527
566
|
export interface Analysis {
|
|
528
567
|
/**
|
|
568
|
+
* @public
|
|
529
569
|
* <p>The ID of the analysis.</p>
|
|
530
570
|
*/
|
|
531
571
|
AnalysisId?: string;
|
|
532
572
|
/**
|
|
573
|
+
* @public
|
|
533
574
|
* <p>The Amazon Resource Name (ARN) of the analysis.</p>
|
|
534
575
|
*/
|
|
535
576
|
Arn?: string;
|
|
536
577
|
/**
|
|
578
|
+
* @public
|
|
537
579
|
* <p>The descriptive name of the analysis.</p>
|
|
538
580
|
*/
|
|
539
581
|
Name?: string;
|
|
540
582
|
/**
|
|
583
|
+
* @public
|
|
541
584
|
* <p>Status associated with the analysis.</p>
|
|
542
585
|
*/
|
|
543
586
|
Status?: ResourceStatus | string;
|
|
544
587
|
/**
|
|
588
|
+
* @public
|
|
545
589
|
* <p>Errors associated with the analysis.</p>
|
|
546
590
|
*/
|
|
547
591
|
Errors?: AnalysisError[];
|
|
548
592
|
/**
|
|
593
|
+
* @public
|
|
549
594
|
* <p>The ARNs of the datasets of the analysis.</p>
|
|
550
595
|
*/
|
|
551
596
|
DataSetArns?: string[];
|
|
552
597
|
/**
|
|
598
|
+
* @public
|
|
553
599
|
* <p>The ARN of the theme of the analysis.</p>
|
|
554
600
|
*/
|
|
555
601
|
ThemeArn?: string;
|
|
556
602
|
/**
|
|
603
|
+
* @public
|
|
557
604
|
* <p>The time that the analysis was created.</p>
|
|
558
605
|
*/
|
|
559
606
|
CreatedTime?: Date;
|
|
560
607
|
/**
|
|
608
|
+
* @public
|
|
561
609
|
* <p>The time that the analysis was last updated.</p>
|
|
562
610
|
*/
|
|
563
611
|
LastUpdatedTime?: Date;
|
|
564
612
|
/**
|
|
613
|
+
* @public
|
|
565
614
|
* <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
|
|
566
615
|
*/
|
|
567
616
|
Sheets?: Sheet[];
|
|
@@ -572,6 +621,7 @@ export interface Analysis {
|
|
|
572
621
|
*/
|
|
573
622
|
export interface FreeFormLayoutScreenCanvasSizeOptions {
|
|
574
623
|
/**
|
|
624
|
+
* @public
|
|
575
625
|
* <p>The width that the view port will be optimized for when the layout renders.</p>
|
|
576
626
|
*/
|
|
577
627
|
OptimizedViewPortWidth: string | undefined;
|
|
@@ -582,6 +632,7 @@ export interface FreeFormLayoutScreenCanvasSizeOptions {
|
|
|
582
632
|
*/
|
|
583
633
|
export interface FreeFormLayoutCanvasSizeOptions {
|
|
584
634
|
/**
|
|
635
|
+
* @public
|
|
585
636
|
* <p>The options that determine the sizing of the canvas used in a free-form layout.</p>
|
|
586
637
|
*/
|
|
587
638
|
ScreenCanvasSizeOptions?: FreeFormLayoutScreenCanvasSizeOptions;
|
|
@@ -592,6 +643,7 @@ export interface FreeFormLayoutCanvasSizeOptions {
|
|
|
592
643
|
*/
|
|
593
644
|
export interface DefaultFreeFormLayoutConfiguration {
|
|
594
645
|
/**
|
|
646
|
+
* @public
|
|
595
647
|
* <p>Determines the screen canvas size options for a free-form layout.</p>
|
|
596
648
|
*/
|
|
597
649
|
CanvasSizeOptions: FreeFormLayoutCanvasSizeOptions | undefined;
|
|
@@ -614,6 +666,7 @@ export type ResizeOption = (typeof ResizeOption)[keyof typeof ResizeOption];
|
|
|
614
666
|
*/
|
|
615
667
|
export interface GridLayoutScreenCanvasSizeOptions {
|
|
616
668
|
/**
|
|
669
|
+
* @public
|
|
617
670
|
* <p>This value determines the layout behavior when the viewport is resized.</p>
|
|
618
671
|
* <ul>
|
|
619
672
|
* <li>
|
|
@@ -630,6 +683,7 @@ export interface GridLayoutScreenCanvasSizeOptions {
|
|
|
630
683
|
*/
|
|
631
684
|
ResizeOption: ResizeOption | string | undefined;
|
|
632
685
|
/**
|
|
686
|
+
* @public
|
|
633
687
|
* <p>The width that the view port will be optimized for when the layout renders.</p>
|
|
634
688
|
*/
|
|
635
689
|
OptimizedViewPortWidth?: string;
|
|
@@ -640,6 +694,7 @@ export interface GridLayoutScreenCanvasSizeOptions {
|
|
|
640
694
|
*/
|
|
641
695
|
export interface GridLayoutCanvasSizeOptions {
|
|
642
696
|
/**
|
|
697
|
+
* @public
|
|
643
698
|
* <p>The options that determine the sizing of the canvas used in a grid layout.</p>
|
|
644
699
|
*/
|
|
645
700
|
ScreenCanvasSizeOptions?: GridLayoutScreenCanvasSizeOptions;
|
|
@@ -650,6 +705,7 @@ export interface GridLayoutCanvasSizeOptions {
|
|
|
650
705
|
*/
|
|
651
706
|
export interface DefaultGridLayoutConfiguration {
|
|
652
707
|
/**
|
|
708
|
+
* @public
|
|
653
709
|
* <p>Determines the screen canvas size options for a grid layout.</p>
|
|
654
710
|
*/
|
|
655
711
|
CanvasSizeOptions: GridLayoutCanvasSizeOptions | undefined;
|
|
@@ -660,10 +716,12 @@ export interface DefaultGridLayoutConfiguration {
|
|
|
660
716
|
*/
|
|
661
717
|
export interface DefaultInteractiveLayoutConfiguration {
|
|
662
718
|
/**
|
|
719
|
+
* @public
|
|
663
720
|
* <p>The options that determine the default settings for a grid layout configuration.</p>
|
|
664
721
|
*/
|
|
665
722
|
Grid?: DefaultGridLayoutConfiguration;
|
|
666
723
|
/**
|
|
724
|
+
* @public
|
|
667
725
|
* <p>The options that determine the default settings of a free-form layout configuration.</p>
|
|
668
726
|
*/
|
|
669
727
|
FreeForm?: DefaultFreeFormLayoutConfiguration;
|
|
@@ -674,18 +732,22 @@ export interface DefaultInteractiveLayoutConfiguration {
|
|
|
674
732
|
*/
|
|
675
733
|
export interface Spacing {
|
|
676
734
|
/**
|
|
735
|
+
* @public
|
|
677
736
|
* <p>Define the top spacing.</p>
|
|
678
737
|
*/
|
|
679
738
|
Top?: string;
|
|
680
739
|
/**
|
|
740
|
+
* @public
|
|
681
741
|
* <p>Define the bottom spacing.</p>
|
|
682
742
|
*/
|
|
683
743
|
Bottom?: string;
|
|
684
744
|
/**
|
|
745
|
+
* @public
|
|
685
746
|
* <p>Define the left spacing.</p>
|
|
686
747
|
*/
|
|
687
748
|
Left?: string;
|
|
688
749
|
/**
|
|
750
|
+
* @public
|
|
689
751
|
* <p>Define the right spacing.</p>
|
|
690
752
|
*/
|
|
691
753
|
Right?: string;
|
|
@@ -729,10 +791,12 @@ export type PaperSize = (typeof PaperSize)[keyof typeof PaperSize];
|
|
|
729
791
|
*/
|
|
730
792
|
export interface SectionBasedLayoutPaperCanvasSizeOptions {
|
|
731
793
|
/**
|
|
794
|
+
* @public
|
|
732
795
|
* <p>The paper size that is used to define canvas dimensions.</p>
|
|
733
796
|
*/
|
|
734
797
|
PaperSize?: PaperSize | string;
|
|
735
798
|
/**
|
|
799
|
+
* @public
|
|
736
800
|
* <p>The paper orientation that
|
|
737
801
|
* is used to define canvas dimensions. Choose one of the following
|
|
738
802
|
* options:</p>
|
|
@@ -747,6 +811,7 @@ export interface SectionBasedLayoutPaperCanvasSizeOptions {
|
|
|
747
811
|
*/
|
|
748
812
|
PaperOrientation?: PaperOrientation | string;
|
|
749
813
|
/**
|
|
814
|
+
* @public
|
|
750
815
|
* <p>Defines the spacing between the canvas content and the top, bottom, left, and right edges.</p>
|
|
751
816
|
*/
|
|
752
817
|
PaperMargin?: Spacing;
|
|
@@ -757,6 +822,7 @@ export interface SectionBasedLayoutPaperCanvasSizeOptions {
|
|
|
757
822
|
*/
|
|
758
823
|
export interface SectionBasedLayoutCanvasSizeOptions {
|
|
759
824
|
/**
|
|
825
|
+
* @public
|
|
760
826
|
* <p>The options for a paper canvas of a section-based layout.</p>
|
|
761
827
|
*/
|
|
762
828
|
PaperCanvasSizeOptions?: SectionBasedLayoutPaperCanvasSizeOptions;
|
|
@@ -767,6 +833,7 @@ export interface SectionBasedLayoutCanvasSizeOptions {
|
|
|
767
833
|
*/
|
|
768
834
|
export interface DefaultSectionBasedLayoutConfiguration {
|
|
769
835
|
/**
|
|
836
|
+
* @public
|
|
770
837
|
* <p>Determines the screen canvas size options for a section-based layout.</p>
|
|
771
838
|
*/
|
|
772
839
|
CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptions | undefined;
|
|
@@ -777,6 +844,7 @@ export interface DefaultSectionBasedLayoutConfiguration {
|
|
|
777
844
|
*/
|
|
778
845
|
export interface DefaultPaginatedLayoutConfiguration {
|
|
779
846
|
/**
|
|
847
|
+
* @public
|
|
780
848
|
* <p>The options that determine the default settings for a section-based layout configuration.</p>
|
|
781
849
|
*/
|
|
782
850
|
SectionBased?: DefaultSectionBasedLayoutConfiguration;
|
|
@@ -799,14 +867,17 @@ export type SheetContentType = (typeof SheetContentType)[keyof typeof SheetConte
|
|
|
799
867
|
*/
|
|
800
868
|
export interface DefaultNewSheetConfiguration {
|
|
801
869
|
/**
|
|
870
|
+
* @public
|
|
802
871
|
* <p>The options that determine the default settings for interactive layout configuration.</p>
|
|
803
872
|
*/
|
|
804
873
|
InteractiveLayoutConfiguration?: DefaultInteractiveLayoutConfiguration;
|
|
805
874
|
/**
|
|
875
|
+
* @public
|
|
806
876
|
* <p>The options that determine the default settings for a paginated layout configuration.</p>
|
|
807
877
|
*/
|
|
808
878
|
PaginatedLayoutConfiguration?: DefaultPaginatedLayoutConfiguration;
|
|
809
879
|
/**
|
|
880
|
+
* @public
|
|
810
881
|
* <p>The option that determines the sheet content type.</p>
|
|
811
882
|
*/
|
|
812
883
|
SheetContentType?: SheetContentType | string;
|
|
@@ -817,6 +888,7 @@ export interface DefaultNewSheetConfiguration {
|
|
|
817
888
|
*/
|
|
818
889
|
export interface AnalysisDefaults {
|
|
819
890
|
/**
|
|
891
|
+
* @public
|
|
820
892
|
* <p>The configuration for default new sheet settings.</p>
|
|
821
893
|
*/
|
|
822
894
|
DefaultNewSheetConfiguration: DefaultNewSheetConfiguration | undefined;
|
|
@@ -827,14 +899,17 @@ export interface AnalysisDefaults {
|
|
|
827
899
|
*/
|
|
828
900
|
export interface CalculatedField {
|
|
829
901
|
/**
|
|
902
|
+
* @public
|
|
830
903
|
* <p>The data set that is used in this calculated field.</p>
|
|
831
904
|
*/
|
|
832
905
|
DataSetIdentifier: string | undefined;
|
|
833
906
|
/**
|
|
907
|
+
* @public
|
|
834
908
|
* <p>The name of the calculated field.</p>
|
|
835
909
|
*/
|
|
836
910
|
Name: string | undefined;
|
|
837
911
|
/**
|
|
912
|
+
* @public
|
|
838
913
|
* <p>The expression of the calculated field.</p>
|
|
839
914
|
*/
|
|
840
915
|
Expression: string | undefined;
|
|
@@ -858,14 +933,17 @@ export type SpecialValue = (typeof SpecialValue)[keyof typeof SpecialValue];
|
|
|
858
933
|
*/
|
|
859
934
|
export interface CustomColor {
|
|
860
935
|
/**
|
|
936
|
+
* @public
|
|
861
937
|
* <p>The data value that the color is applied to.</p>
|
|
862
938
|
*/
|
|
863
939
|
FieldValue?: string;
|
|
864
940
|
/**
|
|
941
|
+
* @public
|
|
865
942
|
* <p>The color that is applied to the data value.</p>
|
|
866
943
|
*/
|
|
867
944
|
Color: string | undefined;
|
|
868
945
|
/**
|
|
946
|
+
* @public
|
|
869
947
|
* <p>The value of a special data value.</p>
|
|
870
948
|
*/
|
|
871
949
|
SpecialValue?: SpecialValue | string;
|
|
@@ -876,6 +954,7 @@ export interface CustomColor {
|
|
|
876
954
|
*/
|
|
877
955
|
export interface ColorsConfiguration {
|
|
878
956
|
/**
|
|
957
|
+
* @public
|
|
879
958
|
* <p>A list of up to 50 custom colors.</p>
|
|
880
959
|
*/
|
|
881
960
|
CustomColors?: CustomColor[];
|
|
@@ -886,6 +965,7 @@ export interface ColorsConfiguration {
|
|
|
886
965
|
*/
|
|
887
966
|
export interface NullValueFormatConfiguration {
|
|
888
967
|
/**
|
|
968
|
+
* @public
|
|
889
969
|
* <p>Determines the null string of null values.</p>
|
|
890
970
|
*/
|
|
891
971
|
NullString: string | undefined;
|
|
@@ -896,6 +976,7 @@ export interface NullValueFormatConfiguration {
|
|
|
896
976
|
*/
|
|
897
977
|
export interface DecimalPlacesConfiguration {
|
|
898
978
|
/**
|
|
979
|
+
* @public
|
|
899
980
|
* <p>The values of the decimal places.</p>
|
|
900
981
|
*/
|
|
901
982
|
DecimalPlaces: number | undefined;
|
|
@@ -918,6 +999,7 @@ export type NegativeValueDisplayMode = (typeof NegativeValueDisplayMode)[keyof t
|
|
|
918
999
|
*/
|
|
919
1000
|
export interface NegativeValueConfiguration {
|
|
920
1001
|
/**
|
|
1002
|
+
* @public
|
|
921
1003
|
* <p>Determines the display mode of the negative value configuration.</p>
|
|
922
1004
|
*/
|
|
923
1005
|
DisplayMode: NegativeValueDisplayMode | string | undefined;
|
|
@@ -969,10 +1051,12 @@ export type Visibility = (typeof Visibility)[keyof typeof Visibility];
|
|
|
969
1051
|
*/
|
|
970
1052
|
export interface ThousandSeparatorOptions {
|
|
971
1053
|
/**
|
|
1054
|
+
* @public
|
|
972
1055
|
* <p>Determines the thousands separator symbol.</p>
|
|
973
1056
|
*/
|
|
974
1057
|
Symbol?: NumericSeparatorSymbol | string;
|
|
975
1058
|
/**
|
|
1059
|
+
* @public
|
|
976
1060
|
* <p>Determines the visibility of the thousands separator.</p>
|
|
977
1061
|
*/
|
|
978
1062
|
Visibility?: Visibility | string;
|
|
@@ -983,10 +1067,12 @@ export interface ThousandSeparatorOptions {
|
|
|
983
1067
|
*/
|
|
984
1068
|
export interface NumericSeparatorConfiguration {
|
|
985
1069
|
/**
|
|
1070
|
+
* @public
|
|
986
1071
|
* <p>Determines the decimal separator.</p>
|
|
987
1072
|
*/
|
|
988
1073
|
DecimalSeparator?: NumericSeparatorSymbol | string;
|
|
989
1074
|
/**
|
|
1075
|
+
* @public
|
|
990
1076
|
* <p>The options that determine the thousands separator configuration.</p>
|
|
991
1077
|
*/
|
|
992
1078
|
ThousandsSeparator?: ThousandSeparatorOptions;
|
|
@@ -997,34 +1083,42 @@ export interface NumericSeparatorConfiguration {
|
|
|
997
1083
|
*/
|
|
998
1084
|
export interface CurrencyDisplayFormatConfiguration {
|
|
999
1085
|
/**
|
|
1086
|
+
* @public
|
|
1000
1087
|
* <p>Determines the prefix value of the currency format.</p>
|
|
1001
1088
|
*/
|
|
1002
1089
|
Prefix?: string;
|
|
1003
1090
|
/**
|
|
1091
|
+
* @public
|
|
1004
1092
|
* <p>Determines the suffix value of the currency format.</p>
|
|
1005
1093
|
*/
|
|
1006
1094
|
Suffix?: string;
|
|
1007
1095
|
/**
|
|
1096
|
+
* @public
|
|
1008
1097
|
* <p>The options that determine the numeric separator configuration.</p>
|
|
1009
1098
|
*/
|
|
1010
1099
|
SeparatorConfiguration?: NumericSeparatorConfiguration;
|
|
1011
1100
|
/**
|
|
1101
|
+
* @public
|
|
1012
1102
|
* <p>Determines the symbol for the currency format.</p>
|
|
1013
1103
|
*/
|
|
1014
1104
|
Symbol?: string;
|
|
1015
1105
|
/**
|
|
1106
|
+
* @public
|
|
1016
1107
|
* <p>The option that determines the decimal places configuration.</p>
|
|
1017
1108
|
*/
|
|
1018
1109
|
DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
|
|
1019
1110
|
/**
|
|
1111
|
+
* @public
|
|
1020
1112
|
* <p>Determines the number scale value for the currency format.</p>
|
|
1021
1113
|
*/
|
|
1022
1114
|
NumberScale?: NumberScale | string;
|
|
1023
1115
|
/**
|
|
1116
|
+
* @public
|
|
1024
1117
|
* <p>The options that determine the negative value configuration.</p>
|
|
1025
1118
|
*/
|
|
1026
1119
|
NegativeValueConfiguration?: NegativeValueConfiguration;
|
|
1027
1120
|
/**
|
|
1121
|
+
* @public
|
|
1028
1122
|
* <p>The options that determine the null value format configuration.</p>
|
|
1029
1123
|
*/
|
|
1030
1124
|
NullValueFormatConfiguration?: NullValueFormatConfiguration;
|
|
@@ -1035,30 +1129,37 @@ export interface CurrencyDisplayFormatConfiguration {
|
|
|
1035
1129
|
*/
|
|
1036
1130
|
export interface NumberDisplayFormatConfiguration {
|
|
1037
1131
|
/**
|
|
1132
|
+
* @public
|
|
1038
1133
|
* <p>Determines the prefix value of the number format.</p>
|
|
1039
1134
|
*/
|
|
1040
1135
|
Prefix?: string;
|
|
1041
1136
|
/**
|
|
1137
|
+
* @public
|
|
1042
1138
|
* <p>Determines the suffix value of the number format.</p>
|
|
1043
1139
|
*/
|
|
1044
1140
|
Suffix?: string;
|
|
1045
1141
|
/**
|
|
1142
|
+
* @public
|
|
1046
1143
|
* <p>The options that determine the numeric separator configuration.</p>
|
|
1047
1144
|
*/
|
|
1048
1145
|
SeparatorConfiguration?: NumericSeparatorConfiguration;
|
|
1049
1146
|
/**
|
|
1147
|
+
* @public
|
|
1050
1148
|
* <p>The option that determines the decimal places configuration.</p>
|
|
1051
1149
|
*/
|
|
1052
1150
|
DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
|
|
1053
1151
|
/**
|
|
1152
|
+
* @public
|
|
1054
1153
|
* <p>Determines the number scale value of the number format.</p>
|
|
1055
1154
|
*/
|
|
1056
1155
|
NumberScale?: NumberScale | string;
|
|
1057
1156
|
/**
|
|
1157
|
+
* @public
|
|
1058
1158
|
* <p>The options that determine the negative value configuration.</p>
|
|
1059
1159
|
*/
|
|
1060
1160
|
NegativeValueConfiguration?: NegativeValueConfiguration;
|
|
1061
1161
|
/**
|
|
1162
|
+
* @public
|
|
1062
1163
|
* <p>The options that determine the null value format configuration.</p>
|
|
1063
1164
|
*/
|
|
1064
1165
|
NullValueFormatConfiguration?: NullValueFormatConfiguration;
|
|
@@ -1069,26 +1170,32 @@ export interface NumberDisplayFormatConfiguration {
|
|
|
1069
1170
|
*/
|
|
1070
1171
|
export interface PercentageDisplayFormatConfiguration {
|
|
1071
1172
|
/**
|
|
1173
|
+
* @public
|
|
1072
1174
|
* <p>Determines the prefix value of the percentage format.</p>
|
|
1073
1175
|
*/
|
|
1074
1176
|
Prefix?: string;
|
|
1075
1177
|
/**
|
|
1178
|
+
* @public
|
|
1076
1179
|
* <p>Determines the suffix value of the percentage format.</p>
|
|
1077
1180
|
*/
|
|
1078
1181
|
Suffix?: string;
|
|
1079
1182
|
/**
|
|
1183
|
+
* @public
|
|
1080
1184
|
* <p>The options that determine the numeric separator configuration.</p>
|
|
1081
1185
|
*/
|
|
1082
1186
|
SeparatorConfiguration?: NumericSeparatorConfiguration;
|
|
1083
1187
|
/**
|
|
1188
|
+
* @public
|
|
1084
1189
|
* <p>The option that determines the decimal places configuration.</p>
|
|
1085
1190
|
*/
|
|
1086
1191
|
DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
|
|
1087
1192
|
/**
|
|
1193
|
+
* @public
|
|
1088
1194
|
* <p>The options that determine the negative value configuration.</p>
|
|
1089
1195
|
*/
|
|
1090
1196
|
NegativeValueConfiguration?: NegativeValueConfiguration;
|
|
1091
1197
|
/**
|
|
1198
|
+
* @public
|
|
1092
1199
|
* <p>The options that determine the null value format configuration.</p>
|
|
1093
1200
|
*/
|
|
1094
1201
|
NullValueFormatConfiguration?: NullValueFormatConfiguration;
|
|
@@ -1100,14 +1207,17 @@ export interface PercentageDisplayFormatConfiguration {
|
|
|
1100
1207
|
*/
|
|
1101
1208
|
export interface NumericFormatConfiguration {
|
|
1102
1209
|
/**
|
|
1210
|
+
* @public
|
|
1103
1211
|
* <p>The options that determine the number display format configuration.</p>
|
|
1104
1212
|
*/
|
|
1105
1213
|
NumberDisplayFormatConfiguration?: NumberDisplayFormatConfiguration;
|
|
1106
1214
|
/**
|
|
1215
|
+
* @public
|
|
1107
1216
|
* <p>The options that determine the currency display format configuration.</p>
|
|
1108
1217
|
*/
|
|
1109
1218
|
CurrencyDisplayFormatConfiguration?: CurrencyDisplayFormatConfiguration;
|
|
1110
1219
|
/**
|
|
1220
|
+
* @public
|
|
1111
1221
|
* <p>The options that determine the percentage display format configuration.</p>
|
|
1112
1222
|
*/
|
|
1113
1223
|
PercentageDisplayFormatConfiguration?: PercentageDisplayFormatConfiguration;
|
|
@@ -1118,14 +1228,17 @@ export interface NumericFormatConfiguration {
|
|
|
1118
1228
|
*/
|
|
1119
1229
|
export interface DateTimeFormatConfiguration {
|
|
1120
1230
|
/**
|
|
1231
|
+
* @public
|
|
1121
1232
|
* <p>Determines the <code>DateTime</code> format.</p>
|
|
1122
1233
|
*/
|
|
1123
1234
|
DateTimeFormat?: string;
|
|
1124
1235
|
/**
|
|
1236
|
+
* @public
|
|
1125
1237
|
* <p>The options that determine the null value format configuration.</p>
|
|
1126
1238
|
*/
|
|
1127
1239
|
NullValueFormatConfiguration?: NullValueFormatConfiguration;
|
|
1128
1240
|
/**
|
|
1241
|
+
* @public
|
|
1129
1242
|
* <p>The formatting configuration for numeric <code>DateTime</code> fields.</p>
|
|
1130
1243
|
*/
|
|
1131
1244
|
NumericFormatConfiguration?: NumericFormatConfiguration;
|
|
@@ -1136,6 +1249,7 @@ export interface DateTimeFormatConfiguration {
|
|
|
1136
1249
|
*/
|
|
1137
1250
|
export interface NumberFormatConfiguration {
|
|
1138
1251
|
/**
|
|
1252
|
+
* @public
|
|
1139
1253
|
* <p>The options that determine the numeric format configuration.</p>
|
|
1140
1254
|
*/
|
|
1141
1255
|
FormatConfiguration?: NumericFormatConfiguration;
|
|
@@ -1146,10 +1260,12 @@ export interface NumberFormatConfiguration {
|
|
|
1146
1260
|
*/
|
|
1147
1261
|
export interface StringFormatConfiguration {
|
|
1148
1262
|
/**
|
|
1263
|
+
* @public
|
|
1149
1264
|
* <p>The options that determine the null value format configuration.</p>
|
|
1150
1265
|
*/
|
|
1151
1266
|
NullValueFormatConfiguration?: NullValueFormatConfiguration;
|
|
1152
1267
|
/**
|
|
1268
|
+
* @public
|
|
1153
1269
|
* <p>The formatting configuration for numeric strings.</p>
|
|
1154
1270
|
*/
|
|
1155
1271
|
NumericFormatConfiguration?: NumericFormatConfiguration;
|
|
@@ -1160,14 +1276,17 @@ export interface StringFormatConfiguration {
|
|
|
1160
1276
|
*/
|
|
1161
1277
|
export interface FormatConfiguration {
|
|
1162
1278
|
/**
|
|
1279
|
+
* @public
|
|
1163
1280
|
* <p>Formatting configuration for string fields.</p>
|
|
1164
1281
|
*/
|
|
1165
1282
|
StringFormatConfiguration?: StringFormatConfiguration;
|
|
1166
1283
|
/**
|
|
1284
|
+
* @public
|
|
1167
1285
|
* <p>Formatting configuration for number fields.</p>
|
|
1168
1286
|
*/
|
|
1169
1287
|
NumberFormatConfiguration?: NumberFormatConfiguration;
|
|
1170
1288
|
/**
|
|
1289
|
+
* @public
|
|
1171
1290
|
* <p>Formatting configuration for <code>DateTime</code> fields.</p>
|
|
1172
1291
|
*/
|
|
1173
1292
|
DateTimeFormatConfiguration?: DateTimeFormatConfiguration;
|
|
@@ -1190,18 +1309,22 @@ export type ColumnRole = (typeof ColumnRole)[keyof typeof ColumnRole];
|
|
|
1190
1309
|
*/
|
|
1191
1310
|
export interface ColumnConfiguration {
|
|
1192
1311
|
/**
|
|
1312
|
+
* @public
|
|
1193
1313
|
* <p>The column.</p>
|
|
1194
1314
|
*/
|
|
1195
1315
|
Column: ColumnIdentifier | undefined;
|
|
1196
1316
|
/**
|
|
1317
|
+
* @public
|
|
1197
1318
|
* <p>The format configuration of a column.</p>
|
|
1198
1319
|
*/
|
|
1199
1320
|
FormatConfiguration?: FormatConfiguration;
|
|
1200
1321
|
/**
|
|
1322
|
+
* @public
|
|
1201
1323
|
* <p>The role of the column.</p>
|
|
1202
1324
|
*/
|
|
1203
1325
|
Role?: ColumnRole | string;
|
|
1204
1326
|
/**
|
|
1327
|
+
* @public
|
|
1205
1328
|
* <p>The color configurations of the column.</p>
|
|
1206
1329
|
*/
|
|
1207
1330
|
ColorsConfiguration?: ColorsConfiguration;
|
|
@@ -1212,10 +1335,12 @@ export interface ColumnConfiguration {
|
|
|
1212
1335
|
*/
|
|
1213
1336
|
export interface DataSetIdentifierDeclaration {
|
|
1214
1337
|
/**
|
|
1338
|
+
* @public
|
|
1215
1339
|
* <p>The identifier of the data set, typically the data set's name.</p>
|
|
1216
1340
|
*/
|
|
1217
1341
|
Identifier: string | undefined;
|
|
1218
1342
|
/**
|
|
1343
|
+
* @public
|
|
1219
1344
|
* <p>The Amazon Resource Name (ARN) of the data set.</p>
|
|
1220
1345
|
*/
|
|
1221
1346
|
DataSetArn: string | undefined;
|
|
@@ -1278,15 +1403,18 @@ export type CategoryFilterSelectAllOptions = (typeof CategoryFilterSelectAllOpti
|
|
|
1278
1403
|
*/
|
|
1279
1404
|
export interface CustomFilterConfiguration {
|
|
1280
1405
|
/**
|
|
1406
|
+
* @public
|
|
1281
1407
|
* <p>The match operator that is used to determine if a filter should be applied.</p>
|
|
1282
1408
|
*/
|
|
1283
1409
|
MatchOperator: CategoryFilterMatchOperator | string | undefined;
|
|
1284
1410
|
/**
|
|
1411
|
+
* @public
|
|
1285
1412
|
* <p>The category value for the filter.</p>
|
|
1286
1413
|
* <p>This field is mutually exclusive to <code>ParameterName</code>.</p>
|
|
1287
1414
|
*/
|
|
1288
1415
|
CategoryValue?: string;
|
|
1289
1416
|
/**
|
|
1417
|
+
* @public
|
|
1290
1418
|
* <p>Select all of the values. Null is not the assigned value of select all.</p>
|
|
1291
1419
|
* <ul>
|
|
1292
1420
|
* <li>
|
|
@@ -1298,11 +1426,13 @@ export interface CustomFilterConfiguration {
|
|
|
1298
1426
|
*/
|
|
1299
1427
|
SelectAllOptions?: CategoryFilterSelectAllOptions | string;
|
|
1300
1428
|
/**
|
|
1429
|
+
* @public
|
|
1301
1430
|
* <p>The parameter whose value should be used for the filter value.</p>
|
|
1302
1431
|
* <p>This field is mutually exclusive to <code>CategoryValue</code>.</p>
|
|
1303
1432
|
*/
|
|
1304
1433
|
ParameterName?: string;
|
|
1305
1434
|
/**
|
|
1435
|
+
* @public
|
|
1306
1436
|
* <p>This option determines how null values should be treated when filtering data.</p>
|
|
1307
1437
|
* <ul>
|
|
1308
1438
|
* <li>
|
|
@@ -1327,14 +1457,17 @@ export interface CustomFilterConfiguration {
|
|
|
1327
1457
|
*/
|
|
1328
1458
|
export interface CustomFilterListConfiguration {
|
|
1329
1459
|
/**
|
|
1460
|
+
* @public
|
|
1330
1461
|
* <p>The match operator that is used to determine if a filter should be applied.</p>
|
|
1331
1462
|
*/
|
|
1332
1463
|
MatchOperator: CategoryFilterMatchOperator | string | undefined;
|
|
1333
1464
|
/**
|
|
1465
|
+
* @public
|
|
1334
1466
|
* <p>The list of category values for the filter.</p>
|
|
1335
1467
|
*/
|
|
1336
1468
|
CategoryValues?: string[];
|
|
1337
1469
|
/**
|
|
1470
|
+
* @public
|
|
1338
1471
|
* <p>Select all of the values. Null is not the assigned value of select all.</p>
|
|
1339
1472
|
* <ul>
|
|
1340
1473
|
* <li>
|
|
@@ -1346,6 +1479,7 @@ export interface CustomFilterListConfiguration {
|
|
|
1346
1479
|
*/
|
|
1347
1480
|
SelectAllOptions?: CategoryFilterSelectAllOptions | string;
|
|
1348
1481
|
/**
|
|
1482
|
+
* @public
|
|
1349
1483
|
* <p>This option determines how null values should be treated when filtering data.</p>
|
|
1350
1484
|
* <ul>
|
|
1351
1485
|
* <li>
|
|
@@ -1370,14 +1504,17 @@ export interface CustomFilterListConfiguration {
|
|
|
1370
1504
|
*/
|
|
1371
1505
|
export interface FilterListConfiguration {
|
|
1372
1506
|
/**
|
|
1507
|
+
* @public
|
|
1373
1508
|
* <p>The match operator that is used to determine if a filter should be applied.</p>
|
|
1374
1509
|
*/
|
|
1375
1510
|
MatchOperator: CategoryFilterMatchOperator | string | undefined;
|
|
1376
1511
|
/**
|
|
1512
|
+
* @public
|
|
1377
1513
|
* <p>The list of category values for the filter.</p>
|
|
1378
1514
|
*/
|
|
1379
1515
|
CategoryValues?: string[];
|
|
1380
1516
|
/**
|
|
1517
|
+
* @public
|
|
1381
1518
|
* <p>Select all of the values. Null is not the assigned value of select all.</p>
|
|
1382
1519
|
* <ul>
|
|
1383
1520
|
* <li>
|
|
@@ -1396,14 +1533,17 @@ export interface FilterListConfiguration {
|
|
|
1396
1533
|
*/
|
|
1397
1534
|
export interface CategoryFilterConfiguration {
|
|
1398
1535
|
/**
|
|
1536
|
+
* @public
|
|
1399
1537
|
* <p>A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.</p>
|
|
1400
1538
|
*/
|
|
1401
1539
|
FilterListConfiguration?: FilterListConfiguration;
|
|
1402
1540
|
/**
|
|
1541
|
+
* @public
|
|
1403
1542
|
* <p>A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.</p>
|
|
1404
1543
|
*/
|
|
1405
1544
|
CustomFilterListConfiguration?: CustomFilterListConfiguration;
|
|
1406
1545
|
/**
|
|
1546
|
+
* @public
|
|
1407
1547
|
* <p>A custom filter that filters based on a single value. This filter can be partially matched.</p>
|
|
1408
1548
|
*/
|
|
1409
1549
|
CustomFilterConfiguration?: CustomFilterConfiguration;
|
|
@@ -1415,14 +1555,17 @@ export interface CategoryFilterConfiguration {
|
|
|
1415
1555
|
*/
|
|
1416
1556
|
export interface CategoryFilter {
|
|
1417
1557
|
/**
|
|
1558
|
+
* @public
|
|
1418
1559
|
* <p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>
|
|
1419
1560
|
*/
|
|
1420
1561
|
FilterId: string | undefined;
|
|
1421
1562
|
/**
|
|
1563
|
+
* @public
|
|
1422
1564
|
* <p>The column that the filter is applied to.</p>
|
|
1423
1565
|
*/
|
|
1424
1566
|
Column: ColumnIdentifier | undefined;
|
|
1425
1567
|
/**
|
|
1568
|
+
* @public
|
|
1426
1569
|
* <p>The configuration for a <code>CategoryFilter</code>.</p>
|
|
1427
1570
|
*/
|
|
1428
1571
|
Configuration: CategoryFilterConfiguration | undefined;
|
|
@@ -1456,18 +1599,22 @@ export type NumericFilterSelectAllOptions = (typeof NumericFilterSelectAllOption
|
|
|
1456
1599
|
*/
|
|
1457
1600
|
export interface NumericEqualityFilter {
|
|
1458
1601
|
/**
|
|
1602
|
+
* @public
|
|
1459
1603
|
* <p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>
|
|
1460
1604
|
*/
|
|
1461
1605
|
FilterId: string | undefined;
|
|
1462
1606
|
/**
|
|
1607
|
+
* @public
|
|
1463
1608
|
* <p>The column that the filter is applied to.</p>
|
|
1464
1609
|
*/
|
|
1465
1610
|
Column: ColumnIdentifier | undefined;
|
|
1466
1611
|
/**
|
|
1612
|
+
* @public
|
|
1467
1613
|
* <p>The input value.</p>
|
|
1468
1614
|
*/
|
|
1469
1615
|
Value?: number;
|
|
1470
1616
|
/**
|
|
1617
|
+
* @public
|
|
1471
1618
|
* <p>Select all of the values. Null is not the assigned value of select all.</p>
|
|
1472
1619
|
* <ul>
|
|
1473
1620
|
* <li>
|
|
@@ -1479,18 +1626,22 @@ export interface NumericEqualityFilter {
|
|
|
1479
1626
|
*/
|
|
1480
1627
|
SelectAllOptions?: NumericFilterSelectAllOptions | string;
|
|
1481
1628
|
/**
|
|
1629
|
+
* @public
|
|
1482
1630
|
* <p>The match operator that is used to determine if a filter should be applied.</p>
|
|
1483
1631
|
*/
|
|
1484
1632
|
MatchOperator: NumericEqualityMatchOperator | string | undefined;
|
|
1485
1633
|
/**
|
|
1634
|
+
* @public
|
|
1486
1635
|
* <p>The aggregation function of the filter.</p>
|
|
1487
1636
|
*/
|
|
1488
1637
|
AggregationFunction?: AggregationFunction;
|
|
1489
1638
|
/**
|
|
1639
|
+
* @public
|
|
1490
1640
|
* <p>The parameter whose value should be used for the filter value.</p>
|
|
1491
1641
|
*/
|
|
1492
1642
|
ParameterName?: string;
|
|
1493
1643
|
/**
|
|
1644
|
+
* @public
|
|
1494
1645
|
* <p>This option determines how null values should be treated when filtering data.</p>
|
|
1495
1646
|
* <ul>
|
|
1496
1647
|
* <li>
|
|
@@ -1515,10 +1666,12 @@ export interface NumericEqualityFilter {
|
|
|
1515
1666
|
*/
|
|
1516
1667
|
export interface NumericRangeFilterValue {
|
|
1517
1668
|
/**
|
|
1669
|
+
* @public
|
|
1518
1670
|
* <p>The static value of the numeric range filter.</p>
|
|
1519
1671
|
*/
|
|
1520
1672
|
StaticValue?: number;
|
|
1521
1673
|
/**
|
|
1674
|
+
* @public
|
|
1522
1675
|
* <p>The parameter that is used in the numeric range.</p>
|
|
1523
1676
|
*/
|
|
1524
1677
|
Parameter?: string;
|
|
@@ -1529,30 +1682,37 @@ export interface NumericRangeFilterValue {
|
|
|
1529
1682
|
*/
|
|
1530
1683
|
export interface NumericRangeFilter {
|
|
1531
1684
|
/**
|
|
1685
|
+
* @public
|
|
1532
1686
|
* <p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>
|
|
1533
1687
|
*/
|
|
1534
1688
|
FilterId: string | undefined;
|
|
1535
1689
|
/**
|
|
1690
|
+
* @public
|
|
1536
1691
|
* <p>The column that the filter is applied to.</p>
|
|
1537
1692
|
*/
|
|
1538
1693
|
Column: ColumnIdentifier | undefined;
|
|
1539
1694
|
/**
|
|
1695
|
+
* @public
|
|
1540
1696
|
* <p>Determines whether the minimum value in the filter value range should be included in the filtered results.</p>
|
|
1541
1697
|
*/
|
|
1542
1698
|
IncludeMinimum?: boolean;
|
|
1543
1699
|
/**
|
|
1700
|
+
* @public
|
|
1544
1701
|
* <p>Determines whether the maximum value in the filter value range should be included in the filtered results.</p>
|
|
1545
1702
|
*/
|
|
1546
1703
|
IncludeMaximum?: boolean;
|
|
1547
1704
|
/**
|
|
1705
|
+
* @public
|
|
1548
1706
|
* <p>The minimum value for the filter value range.</p>
|
|
1549
1707
|
*/
|
|
1550
1708
|
RangeMinimum?: NumericRangeFilterValue;
|
|
1551
1709
|
/**
|
|
1710
|
+
* @public
|
|
1552
1711
|
* <p>The maximum value for the filter value range.</p>
|
|
1553
1712
|
*/
|
|
1554
1713
|
RangeMaximum?: NumericRangeFilterValue;
|
|
1555
1714
|
/**
|
|
1715
|
+
* @public
|
|
1556
1716
|
* <p>Select all of the values. Null is not the assigned value of select all.</p>
|
|
1557
1717
|
* <ul>
|
|
1558
1718
|
* <li>
|
|
@@ -1564,10 +1724,12 @@ export interface NumericRangeFilter {
|
|
|
1564
1724
|
*/
|
|
1565
1725
|
SelectAllOptions?: NumericFilterSelectAllOptions | string;
|
|
1566
1726
|
/**
|
|
1727
|
+
* @public
|
|
1567
1728
|
* <p>The aggregation function of the filter.</p>
|
|
1568
1729
|
*/
|
|
1569
1730
|
AggregationFunction?: AggregationFunction;
|
|
1570
1731
|
/**
|
|
1732
|
+
* @public
|
|
1571
1733
|
* <p>This option determines how null values should be treated when filtering data.</p>
|
|
1572
1734
|
* <ul>
|
|
1573
1735
|
* <li>
|
|
@@ -1603,6 +1765,7 @@ export type AnchorOption = (typeof AnchorOption)[keyof typeof AnchorOption];
|
|
|
1603
1765
|
*/
|
|
1604
1766
|
export interface AnchorDateConfiguration {
|
|
1605
1767
|
/**
|
|
1768
|
+
* @public
|
|
1606
1769
|
* <p>The options for the date configuration. Choose one of the options below:</p>
|
|
1607
1770
|
* <ul>
|
|
1608
1771
|
* <li>
|
|
@@ -1614,6 +1777,7 @@ export interface AnchorDateConfiguration {
|
|
|
1614
1777
|
*/
|
|
1615
1778
|
AnchorOption?: AnchorOption | string;
|
|
1616
1779
|
/**
|
|
1780
|
+
* @public
|
|
1617
1781
|
* <p>The name of the parameter that is used for the anchor date configuration.</p>
|
|
1618
1782
|
*/
|
|
1619
1783
|
ParameterName?: string;
|
|
@@ -1655,14 +1819,17 @@ export type WidgetStatus = (typeof WidgetStatus)[keyof typeof WidgetStatus];
|
|
|
1655
1819
|
*/
|
|
1656
1820
|
export interface ExcludePeriodConfiguration {
|
|
1657
1821
|
/**
|
|
1822
|
+
* @public
|
|
1658
1823
|
* <p>The amount or number of the exclude period.</p>
|
|
1659
1824
|
*/
|
|
1660
1825
|
Amount: number | undefined;
|
|
1661
1826
|
/**
|
|
1827
|
+
* @public
|
|
1662
1828
|
* <p>The granularity or unit (day, month, year) of the exclude period.</p>
|
|
1663
1829
|
*/
|
|
1664
1830
|
Granularity: TimeGranularity | string | undefined;
|
|
1665
1831
|
/**
|
|
1832
|
+
* @public
|
|
1666
1833
|
* <p>The status of the exclude period. Choose from the following options:</p>
|
|
1667
1834
|
* <ul>
|
|
1668
1835
|
* <li>
|
|
@@ -1700,26 +1867,32 @@ export type RelativeDateType = (typeof RelativeDateType)[keyof typeof RelativeDa
|
|
|
1700
1867
|
*/
|
|
1701
1868
|
export interface RelativeDatesFilter {
|
|
1702
1869
|
/**
|
|
1870
|
+
* @public
|
|
1703
1871
|
* <p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>
|
|
1704
1872
|
*/
|
|
1705
1873
|
FilterId: string | undefined;
|
|
1706
1874
|
/**
|
|
1875
|
+
* @public
|
|
1707
1876
|
* <p>The column that the filter is applied to.</p>
|
|
1708
1877
|
*/
|
|
1709
1878
|
Column: ColumnIdentifier | undefined;
|
|
1710
1879
|
/**
|
|
1880
|
+
* @public
|
|
1711
1881
|
* <p>The date configuration of the filter.</p>
|
|
1712
1882
|
*/
|
|
1713
1883
|
AnchorDateConfiguration: AnchorDateConfiguration | undefined;
|
|
1714
1884
|
/**
|
|
1885
|
+
* @public
|
|
1715
1886
|
* <p>The minimum granularity (period granularity) of the relative dates filter.</p>
|
|
1716
1887
|
*/
|
|
1717
1888
|
MinimumGranularity?: TimeGranularity | string;
|
|
1718
1889
|
/**
|
|
1890
|
+
* @public
|
|
1719
1891
|
* <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
|
|
1720
1892
|
*/
|
|
1721
1893
|
TimeGranularity: TimeGranularity | string | undefined;
|
|
1722
1894
|
/**
|
|
1895
|
+
* @public
|
|
1723
1896
|
* <p>The range date type of the filter. Choose one of the options below:</p>
|
|
1724
1897
|
* <ul>
|
|
1725
1898
|
* <li>
|
|
@@ -1751,14 +1924,17 @@ export interface RelativeDatesFilter {
|
|
|
1751
1924
|
*/
|
|
1752
1925
|
RelativeDateType: RelativeDateType | string | undefined;
|
|
1753
1926
|
/**
|
|
1927
|
+
* @public
|
|
1754
1928
|
* <p>The date value of the filter.</p>
|
|
1755
1929
|
*/
|
|
1756
1930
|
RelativeDateValue?: number;
|
|
1757
1931
|
/**
|
|
1932
|
+
* @public
|
|
1758
1933
|
* <p>The parameter whose value should be used for the filter value.</p>
|
|
1759
1934
|
*/
|
|
1760
1935
|
ParameterName?: string;
|
|
1761
1936
|
/**
|
|
1937
|
+
* @public
|
|
1762
1938
|
* <p>This option determines how null values should be treated when filtering data.</p>
|
|
1763
1939
|
* <ul>
|
|
1764
1940
|
* <li>
|
|
@@ -1777,6 +1953,7 @@ export interface RelativeDatesFilter {
|
|
|
1777
1953
|
*/
|
|
1778
1954
|
NullOption: FilterNullOption | string | undefined;
|
|
1779
1955
|
/**
|
|
1956
|
+
* @public
|
|
1780
1957
|
* <p>The configuration for the exclude period of the filter.</p>
|
|
1781
1958
|
*/
|
|
1782
1959
|
ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
|
|
@@ -1787,24 +1964,29 @@ export interface RelativeDatesFilter {
|
|
|
1787
1964
|
*/
|
|
1788
1965
|
export interface TimeEqualityFilter {
|
|
1789
1966
|
/**
|
|
1967
|
+
* @public
|
|
1790
1968
|
* <p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>
|
|
1791
1969
|
*/
|
|
1792
1970
|
FilterId: string | undefined;
|
|
1793
1971
|
/**
|
|
1972
|
+
* @public
|
|
1794
1973
|
* <p>The column that the filter is applied to.</p>
|
|
1795
1974
|
*/
|
|
1796
1975
|
Column: ColumnIdentifier | undefined;
|
|
1797
1976
|
/**
|
|
1977
|
+
* @public
|
|
1798
1978
|
* <p>The value of a <code>TimeEquality</code> filter.</p>
|
|
1799
1979
|
* <p>This field is mutually exclusive to <code>ParameterName</code>.</p>
|
|
1800
1980
|
*/
|
|
1801
1981
|
Value?: Date;
|
|
1802
1982
|
/**
|
|
1983
|
+
* @public
|
|
1803
1984
|
* <p>The parameter whose value should be used for the filter value.</p>
|
|
1804
1985
|
* <p>This field is mutually exclusive to <code>Value</code>.</p>
|
|
1805
1986
|
*/
|
|
1806
1987
|
ParameterName?: string;
|
|
1807
1988
|
/**
|
|
1989
|
+
* @public
|
|
1808
1990
|
* <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
|
|
1809
1991
|
*/
|
|
1810
1992
|
TimeGranularity?: TimeGranularity | string;
|
|
@@ -1815,10 +1997,12 @@ export interface TimeEqualityFilter {
|
|
|
1815
1997
|
*/
|
|
1816
1998
|
export interface RollingDateConfiguration {
|
|
1817
1999
|
/**
|
|
2000
|
+
* @public
|
|
1818
2001
|
* <p>The data set that is used in the rolling date configuration.</p>
|
|
1819
2002
|
*/
|
|
1820
2003
|
DataSetIdentifier?: string;
|
|
1821
2004
|
/**
|
|
2005
|
+
* @public
|
|
1822
2006
|
* <p>The expression of the rolling date configuration.</p>
|
|
1823
2007
|
*/
|
|
1824
2008
|
Expression: string | undefined;
|
|
@@ -1830,14 +2014,17 @@ export interface RollingDateConfiguration {
|
|
|
1830
2014
|
*/
|
|
1831
2015
|
export interface TimeRangeFilterValue {
|
|
1832
2016
|
/**
|
|
2017
|
+
* @public
|
|
1833
2018
|
* <p>The static input value.</p>
|
|
1834
2019
|
*/
|
|
1835
2020
|
StaticValue?: Date;
|
|
1836
2021
|
/**
|
|
2022
|
+
* @public
|
|
1837
2023
|
* <p>The rolling date input value.</p>
|
|
1838
2024
|
*/
|
|
1839
2025
|
RollingDate?: RollingDateConfiguration;
|
|
1840
2026
|
/**
|
|
2027
|
+
* @public
|
|
1841
2028
|
* <p>The parameter type input value.</p>
|
|
1842
2029
|
*/
|
|
1843
2030
|
Parameter?: string;
|
|
@@ -1848,30 +2035,37 @@ export interface TimeRangeFilterValue {
|
|
|
1848
2035
|
*/
|
|
1849
2036
|
export interface TimeRangeFilter {
|
|
1850
2037
|
/**
|
|
2038
|
+
* @public
|
|
1851
2039
|
* <p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>
|
|
1852
2040
|
*/
|
|
1853
2041
|
FilterId: string | undefined;
|
|
1854
2042
|
/**
|
|
2043
|
+
* @public
|
|
1855
2044
|
* <p>The column that the filter is applied to.</p>
|
|
1856
2045
|
*/
|
|
1857
2046
|
Column: ColumnIdentifier | undefined;
|
|
1858
2047
|
/**
|
|
2048
|
+
* @public
|
|
1859
2049
|
* <p>Determines whether the minimum value in the filter value range should be included in the filtered results.</p>
|
|
1860
2050
|
*/
|
|
1861
2051
|
IncludeMinimum?: boolean;
|
|
1862
2052
|
/**
|
|
2053
|
+
* @public
|
|
1863
2054
|
* <p>Determines whether the maximum value in the filter value range should be included in the filtered results.</p>
|
|
1864
2055
|
*/
|
|
1865
2056
|
IncludeMaximum?: boolean;
|
|
1866
2057
|
/**
|
|
2058
|
+
* @public
|
|
1867
2059
|
* <p>The minimum value for the filter value range.</p>
|
|
1868
2060
|
*/
|
|
1869
2061
|
RangeMinimumValue?: TimeRangeFilterValue;
|
|
1870
2062
|
/**
|
|
2063
|
+
* @public
|
|
1871
2064
|
* <p>The maximum value for the filter value range.</p>
|
|
1872
2065
|
*/
|
|
1873
2066
|
RangeMaximumValue?: TimeRangeFilterValue;
|
|
1874
2067
|
/**
|
|
2068
|
+
* @public
|
|
1875
2069
|
* <p>This option determines how null values should be treated when filtering data.</p>
|
|
1876
2070
|
* <ul>
|
|
1877
2071
|
* <li>
|
|
@@ -1890,10 +2084,12 @@ export interface TimeRangeFilter {
|
|
|
1890
2084
|
*/
|
|
1891
2085
|
NullOption: FilterNullOption | string | undefined;
|
|
1892
2086
|
/**
|
|
2087
|
+
* @public
|
|
1893
2088
|
* <p>The exclude period of the time range filter.</p>
|
|
1894
2089
|
*/
|
|
1895
2090
|
ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
|
|
1896
2091
|
/**
|
|
2092
|
+
* @public
|
|
1897
2093
|
* <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
|
|
1898
2094
|
*/
|
|
1899
2095
|
TimeGranularity?: TimeGranularity | string;
|
|
@@ -1904,26 +2100,32 @@ export interface TimeRangeFilter {
|
|
|
1904
2100
|
*/
|
|
1905
2101
|
export interface TopBottomFilter {
|
|
1906
2102
|
/**
|
|
2103
|
+
* @public
|
|
1907
2104
|
* <p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>
|
|
1908
2105
|
*/
|
|
1909
2106
|
FilterId: string | undefined;
|
|
1910
2107
|
/**
|
|
2108
|
+
* @public
|
|
1911
2109
|
* <p>The column that the filter is applied to.</p>
|
|
1912
2110
|
*/
|
|
1913
2111
|
Column: ColumnIdentifier | undefined;
|
|
1914
2112
|
/**
|
|
2113
|
+
* @public
|
|
1915
2114
|
* <p>The number of items to include in the top bottom filter results.</p>
|
|
1916
2115
|
*/
|
|
1917
2116
|
Limit?: number;
|
|
1918
2117
|
/**
|
|
2118
|
+
* @public
|
|
1919
2119
|
* <p>The aggregation and sort configuration of the top bottom filter.</p>
|
|
1920
2120
|
*/
|
|
1921
2121
|
AggregationSortConfigurations: AggregationSortConfiguration[] | undefined;
|
|
1922
2122
|
/**
|
|
2123
|
+
* @public
|
|
1923
2124
|
* <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
|
|
1924
2125
|
*/
|
|
1925
2126
|
TimeGranularity?: TimeGranularity | string;
|
|
1926
2127
|
/**
|
|
2128
|
+
* @public
|
|
1927
2129
|
* <p>The parameter whose value should be used for the filter value.</p>
|
|
1928
2130
|
*/
|
|
1929
2131
|
ParameterName?: string;
|
|
@@ -1935,32 +2137,39 @@ export interface TopBottomFilter {
|
|
|
1935
2137
|
*/
|
|
1936
2138
|
export interface Filter {
|
|
1937
2139
|
/**
|
|
2140
|
+
* @public
|
|
1938
2141
|
* <p>A <code>CategoryFilter</code> filters text values.</p>
|
|
1939
2142
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html">Adding text filters</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
1940
2143
|
*/
|
|
1941
2144
|
CategoryFilter?: CategoryFilter;
|
|
1942
2145
|
/**
|
|
2146
|
+
* @public
|
|
1943
2147
|
* <p>A <code>NumericRangeFilter</code> filters numeric values that are either inside or outside a given numeric range.</p>
|
|
1944
2148
|
*/
|
|
1945
2149
|
NumericRangeFilter?: NumericRangeFilter;
|
|
1946
2150
|
/**
|
|
2151
|
+
* @public
|
|
1947
2152
|
* <p>A <code>NumericEqualityFilter</code> filters numeric values that equal or do not equal a given numeric value.</p>
|
|
1948
2153
|
*/
|
|
1949
2154
|
NumericEqualityFilter?: NumericEqualityFilter;
|
|
1950
2155
|
/**
|
|
2156
|
+
* @public
|
|
1951
2157
|
* <p>A <code>TimeEqualityFilter</code> filters date-time values that equal or do not equal
|
|
1952
2158
|
* a given date/time value.</p>
|
|
1953
2159
|
*/
|
|
1954
2160
|
TimeEqualityFilter?: TimeEqualityFilter;
|
|
1955
2161
|
/**
|
|
2162
|
+
* @public
|
|
1956
2163
|
* <p>A <code>TimeRangeFilter</code> filters date-time values that are either inside or outside a given date/time range.</p>
|
|
1957
2164
|
*/
|
|
1958
2165
|
TimeRangeFilter?: TimeRangeFilter;
|
|
1959
2166
|
/**
|
|
2167
|
+
* @public
|
|
1960
2168
|
* <p>A <code>RelativeDatesFilter</code> filters date values that are relative to a given date.</p>
|
|
1961
2169
|
*/
|
|
1962
2170
|
RelativeDatesFilter?: RelativeDatesFilter;
|
|
1963
2171
|
/**
|
|
2172
|
+
* @public
|
|
1964
2173
|
* <p>A <code>TopBottomFilter</code> filters data to the top or bottom values for a given column.</p>
|
|
1965
2174
|
*/
|
|
1966
2175
|
TopBottomFilter?: TopBottomFilter;
|
|
@@ -1983,10 +2192,12 @@ export type FilterVisualScope = (typeof FilterVisualScope)[keyof typeof FilterVi
|
|
|
1983
2192
|
*/
|
|
1984
2193
|
export interface SheetVisualScopingConfiguration {
|
|
1985
2194
|
/**
|
|
2195
|
+
* @public
|
|
1986
2196
|
* <p>The selected sheet that the filter is applied to.</p>
|
|
1987
2197
|
*/
|
|
1988
2198
|
SheetId: string | undefined;
|
|
1989
2199
|
/**
|
|
2200
|
+
* @public
|
|
1990
2201
|
* <p>The scope of the applied entities. Choose one of the following options:</p>
|
|
1991
2202
|
* <ul>
|
|
1992
2203
|
* <li>
|
|
@@ -2003,6 +2214,7 @@ export interface SheetVisualScopingConfiguration {
|
|
|
2003
2214
|
*/
|
|
2004
2215
|
Scope: FilterVisualScope | string | undefined;
|
|
2005
2216
|
/**
|
|
2217
|
+
* @public
|
|
2006
2218
|
* <p>The selected visuals that the filter is applied to.</p>
|
|
2007
2219
|
*/
|
|
2008
2220
|
VisualIds?: string[];
|
|
@@ -2014,6 +2226,7 @@ export interface SheetVisualScopingConfiguration {
|
|
|
2014
2226
|
*/
|
|
2015
2227
|
export interface SelectedSheetsFilterScopeConfiguration {
|
|
2016
2228
|
/**
|
|
2229
|
+
* @public
|
|
2017
2230
|
* <p>The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.</p>
|
|
2018
2231
|
*/
|
|
2019
2232
|
SheetVisualScopingConfigurations?: SheetVisualScopingConfiguration[];
|
|
@@ -2025,6 +2238,7 @@ export interface SelectedSheetsFilterScopeConfiguration {
|
|
|
2025
2238
|
*/
|
|
2026
2239
|
export interface FilterScopeConfiguration {
|
|
2027
2240
|
/**
|
|
2241
|
+
* @public
|
|
2028
2242
|
* <p>The configuration for applying a filter to specific sheets.</p>
|
|
2029
2243
|
*/
|
|
2030
2244
|
SelectedSheets?: SelectedSheetsFilterScopeConfiguration;
|
|
@@ -2036,23 +2250,28 @@ export interface FilterScopeConfiguration {
|
|
|
2036
2250
|
*/
|
|
2037
2251
|
export interface FilterGroup {
|
|
2038
2252
|
/**
|
|
2253
|
+
* @public
|
|
2039
2254
|
* <p>The value that uniquely identifies a <code>FilterGroup</code> within a dashboard, template, or analysis.</p>
|
|
2040
2255
|
*/
|
|
2041
2256
|
FilterGroupId: string | undefined;
|
|
2042
2257
|
/**
|
|
2258
|
+
* @public
|
|
2043
2259
|
* <p>The list of filters that are present in a <code>FilterGroup</code>.</p>
|
|
2044
2260
|
*/
|
|
2045
2261
|
Filters: Filter[] | undefined;
|
|
2046
2262
|
/**
|
|
2263
|
+
* @public
|
|
2047
2264
|
* <p>The configuration that specifies what scope to apply to a <code>FilterGroup</code>.</p>
|
|
2048
2265
|
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
2049
2266
|
*/
|
|
2050
2267
|
ScopeConfiguration: FilterScopeConfiguration | undefined;
|
|
2051
2268
|
/**
|
|
2269
|
+
* @public
|
|
2052
2270
|
* <p>The status of the <code>FilterGroup</code>.</p>
|
|
2053
2271
|
*/
|
|
2054
2272
|
Status?: WidgetStatus | string;
|
|
2055
2273
|
/**
|
|
2274
|
+
* @public
|
|
2056
2275
|
* <p>The filter new feature which can apply filter group to all data sets. Choose one of the following options:</p>
|
|
2057
2276
|
* <ul>
|
|
2058
2277
|
* <li>
|
|
@@ -2075,14 +2294,17 @@ export interface FilterGroup {
|
|
|
2075
2294
|
*/
|
|
2076
2295
|
export interface DynamicDefaultValue {
|
|
2077
2296
|
/**
|
|
2297
|
+
* @public
|
|
2078
2298
|
* <p>The column that contains the username.</p>
|
|
2079
2299
|
*/
|
|
2080
2300
|
UserNameColumn?: ColumnIdentifier;
|
|
2081
2301
|
/**
|
|
2302
|
+
* @public
|
|
2082
2303
|
* <p>The column that contains the group name.</p>
|
|
2083
2304
|
*/
|
|
2084
2305
|
GroupNameColumn?: ColumnIdentifier;
|
|
2085
2306
|
/**
|
|
2307
|
+
* @public
|
|
2086
2308
|
* <p>The column that contains the default value of each user or group.</p>
|
|
2087
2309
|
*/
|
|
2088
2310
|
DefaultValueColumn: ColumnIdentifier | undefined;
|
|
@@ -2093,14 +2315,17 @@ export interface DynamicDefaultValue {
|
|
|
2093
2315
|
*/
|
|
2094
2316
|
export interface DateTimeDefaultValues {
|
|
2095
2317
|
/**
|
|
2318
|
+
* @public
|
|
2096
2319
|
* <p>The dynamic value of the <code>DataTimeDefaultValues</code>. Different defaults are displayed according to users, groups, and values mapping.</p>
|
|
2097
2320
|
*/
|
|
2098
2321
|
DynamicValue?: DynamicDefaultValue;
|
|
2099
2322
|
/**
|
|
2323
|
+
* @public
|
|
2100
2324
|
* <p>The static values of the <code>DataTimeDefaultValues</code>.</p>
|
|
2101
2325
|
*/
|
|
2102
2326
|
StaticValues?: Date[];
|
|
2103
2327
|
/**
|
|
2328
|
+
* @public
|
|
2104
2329
|
* <p>The rolling date of the <code>DataTimeDefaultValues</code>. The date is determined from the dataset based on input expression.</p>
|
|
2105
2330
|
*/
|
|
2106
2331
|
RollingDate?: RollingDateConfiguration;
|
|
@@ -2111,10 +2336,12 @@ export interface DateTimeDefaultValues {
|
|
|
2111
2336
|
*/
|
|
2112
2337
|
export interface MappedDataSetParameter {
|
|
2113
2338
|
/**
|
|
2339
|
+
* @public
|
|
2114
2340
|
* <p>A unique name that identifies a dataset within the analysis or dashboard.</p>
|
|
2115
2341
|
*/
|
|
2116
2342
|
DataSetIdentifier: string | undefined;
|
|
2117
2343
|
/**
|
|
2344
|
+
* @public
|
|
2118
2345
|
* <p>The name of the dataset parameter.</p>
|
|
2119
2346
|
*/
|
|
2120
2347
|
DataSetParameterName: string | undefined;
|
|
@@ -2137,6 +2364,7 @@ export type ValueWhenUnsetOption = (typeof ValueWhenUnsetOption)[keyof typeof Va
|
|
|
2137
2364
|
*/
|
|
2138
2365
|
export interface DateTimeValueWhenUnsetConfiguration {
|
|
2139
2366
|
/**
|
|
2367
|
+
* @public
|
|
2140
2368
|
* <p>The built-in options for default values. The value can be one of the following:</p>
|
|
2141
2369
|
* <ul>
|
|
2142
2370
|
* <li>
|
|
@@ -2151,6 +2379,7 @@ export interface DateTimeValueWhenUnsetConfiguration {
|
|
|
2151
2379
|
*/
|
|
2152
2380
|
ValueWhenUnsetOption?: ValueWhenUnsetOption | string;
|
|
2153
2381
|
/**
|
|
2382
|
+
* @public
|
|
2154
2383
|
* <p>A custom value that's used when the value of a parameter isn't set.</p>
|
|
2155
2384
|
*/
|
|
2156
2385
|
CustomValue?: Date;
|
|
@@ -2161,22 +2390,27 @@ export interface DateTimeValueWhenUnsetConfiguration {
|
|
|
2161
2390
|
*/
|
|
2162
2391
|
export interface DateTimeParameterDeclaration {
|
|
2163
2392
|
/**
|
|
2393
|
+
* @public
|
|
2164
2394
|
* <p>The name of the parameter that is being declared.</p>
|
|
2165
2395
|
*/
|
|
2166
2396
|
Name: string | undefined;
|
|
2167
2397
|
/**
|
|
2398
|
+
* @public
|
|
2168
2399
|
* <p>The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.</p>
|
|
2169
2400
|
*/
|
|
2170
2401
|
DefaultValues?: DateTimeDefaultValues;
|
|
2171
2402
|
/**
|
|
2403
|
+
* @public
|
|
2172
2404
|
* <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
|
|
2173
2405
|
*/
|
|
2174
2406
|
TimeGranularity?: TimeGranularity | string;
|
|
2175
2407
|
/**
|
|
2408
|
+
* @public
|
|
2176
2409
|
* <p>The configuration that defines the default value of a <code>DateTime</code> parameter when a value has not been set.</p>
|
|
2177
2410
|
*/
|
|
2178
2411
|
ValueWhenUnset?: DateTimeValueWhenUnsetConfiguration;
|
|
2179
2412
|
/**
|
|
2413
|
+
* @public
|
|
2180
2414
|
* <p>A list of dataset parameters that are mapped to an analysis parameter.</p>
|
|
2181
2415
|
*/
|
|
2182
2416
|
MappedDataSetParameters?: MappedDataSetParameter[];
|
|
@@ -2187,10 +2421,12 @@ export interface DateTimeParameterDeclaration {
|
|
|
2187
2421
|
*/
|
|
2188
2422
|
export interface DecimalDefaultValues {
|
|
2189
2423
|
/**
|
|
2424
|
+
* @public
|
|
2190
2425
|
* <p>The dynamic value of the <code>DecimalDefaultValues</code>. Different defaults are displayed according to users, groups, and values mapping.</p>
|
|
2191
2426
|
*/
|
|
2192
2427
|
DynamicValue?: DynamicDefaultValue;
|
|
2193
2428
|
/**
|
|
2429
|
+
* @public
|
|
2194
2430
|
* <p>The static values of the <code>DecimalDefaultValues</code>.</p>
|
|
2195
2431
|
*/
|
|
2196
2432
|
StaticValues?: number[];
|
|
@@ -2213,6 +2449,7 @@ export type ParameterValueType = (typeof ParameterValueType)[keyof typeof Parame
|
|
|
2213
2449
|
*/
|
|
2214
2450
|
export interface DecimalValueWhenUnsetConfiguration {
|
|
2215
2451
|
/**
|
|
2452
|
+
* @public
|
|
2216
2453
|
* <p>The built-in options for default values. The value can be one of the following:</p>
|
|
2217
2454
|
* <ul>
|
|
2218
2455
|
* <li>
|
|
@@ -2227,6 +2464,7 @@ export interface DecimalValueWhenUnsetConfiguration {
|
|
|
2227
2464
|
*/
|
|
2228
2465
|
ValueWhenUnsetOption?: ValueWhenUnsetOption | string;
|
|
2229
2466
|
/**
|
|
2467
|
+
* @public
|
|
2230
2468
|
* <p>A custom value that's used when the value of a parameter isn't set.</p>
|
|
2231
2469
|
*/
|
|
2232
2470
|
CustomValue?: number;
|
|
@@ -2237,22 +2475,27 @@ export interface DecimalValueWhenUnsetConfiguration {
|
|
|
2237
2475
|
*/
|
|
2238
2476
|
export interface DecimalParameterDeclaration {
|
|
2239
2477
|
/**
|
|
2478
|
+
* @public
|
|
2240
2479
|
* <p>The value type determines whether the parameter is a single-value or multi-value parameter.</p>
|
|
2241
2480
|
*/
|
|
2242
2481
|
ParameterValueType: ParameterValueType | string | undefined;
|
|
2243
2482
|
/**
|
|
2483
|
+
* @public
|
|
2244
2484
|
* <p>The name of the parameter that is being declared.</p>
|
|
2245
2485
|
*/
|
|
2246
2486
|
Name: string | undefined;
|
|
2247
2487
|
/**
|
|
2488
|
+
* @public
|
|
2248
2489
|
* <p>The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.</p>
|
|
2249
2490
|
*/
|
|
2250
2491
|
DefaultValues?: DecimalDefaultValues;
|
|
2251
2492
|
/**
|
|
2493
|
+
* @public
|
|
2252
2494
|
* <p>The configuration that defines the default value of a <code>Decimal</code> parameter when a value has not been set.</p>
|
|
2253
2495
|
*/
|
|
2254
2496
|
ValueWhenUnset?: DecimalValueWhenUnsetConfiguration;
|
|
2255
2497
|
/**
|
|
2498
|
+
* @public
|
|
2256
2499
|
* <p>A list of dataset parameters that are mapped to an analysis parameter.</p>
|
|
2257
2500
|
*/
|
|
2258
2501
|
MappedDataSetParameters?: MappedDataSetParameter[];
|
|
@@ -2263,10 +2506,12 @@ export interface DecimalParameterDeclaration {
|
|
|
2263
2506
|
*/
|
|
2264
2507
|
export interface IntegerDefaultValues {
|
|
2265
2508
|
/**
|
|
2509
|
+
* @public
|
|
2266
2510
|
* <p>The dynamic value of the <code>IntegerDefaultValues</code>. Different defaults are displayed according to users, groups, and values mapping.</p>
|
|
2267
2511
|
*/
|
|
2268
2512
|
DynamicValue?: DynamicDefaultValue;
|
|
2269
2513
|
/**
|
|
2514
|
+
* @public
|
|
2270
2515
|
* <p>The static values of the <code>IntegerDefaultValues</code>.</p>
|
|
2271
2516
|
*/
|
|
2272
2517
|
StaticValues?: number[];
|
|
@@ -2278,6 +2523,7 @@ export interface IntegerDefaultValues {
|
|
|
2278
2523
|
*/
|
|
2279
2524
|
export interface IntegerValueWhenUnsetConfiguration {
|
|
2280
2525
|
/**
|
|
2526
|
+
* @public
|
|
2281
2527
|
* <p>The built-in options for default values. The value can be one of the following:</p>
|
|
2282
2528
|
* <ul>
|
|
2283
2529
|
* <li>
|
|
@@ -2292,6 +2538,7 @@ export interface IntegerValueWhenUnsetConfiguration {
|
|
|
2292
2538
|
*/
|
|
2293
2539
|
ValueWhenUnsetOption?: ValueWhenUnsetOption | string;
|
|
2294
2540
|
/**
|
|
2541
|
+
* @public
|
|
2295
2542
|
* <p>A custom value that's used when the value of a parameter isn't set.</p>
|
|
2296
2543
|
*/
|
|
2297
2544
|
CustomValue?: number;
|
|
@@ -2302,22 +2549,27 @@ export interface IntegerValueWhenUnsetConfiguration {
|
|
|
2302
2549
|
*/
|
|
2303
2550
|
export interface IntegerParameterDeclaration {
|
|
2304
2551
|
/**
|
|
2552
|
+
* @public
|
|
2305
2553
|
* <p>The value type determines whether the parameter is a single-value or multi-value parameter.</p>
|
|
2306
2554
|
*/
|
|
2307
2555
|
ParameterValueType: ParameterValueType | string | undefined;
|
|
2308
2556
|
/**
|
|
2557
|
+
* @public
|
|
2309
2558
|
* <p>The name of the parameter that is being declared.</p>
|
|
2310
2559
|
*/
|
|
2311
2560
|
Name: string | undefined;
|
|
2312
2561
|
/**
|
|
2562
|
+
* @public
|
|
2313
2563
|
* <p>The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.</p>
|
|
2314
2564
|
*/
|
|
2315
2565
|
DefaultValues?: IntegerDefaultValues;
|
|
2316
2566
|
/**
|
|
2567
|
+
* @public
|
|
2317
2568
|
* <p>A parameter declaration for the <code>Integer</code> data type.</p>
|
|
2318
2569
|
*/
|
|
2319
2570
|
ValueWhenUnset?: IntegerValueWhenUnsetConfiguration;
|
|
2320
2571
|
/**
|
|
2572
|
+
* @public
|
|
2321
2573
|
* <p>A list of dataset parameters that are mapped to an analysis parameter.</p>
|
|
2322
2574
|
*/
|
|
2323
2575
|
MappedDataSetParameters?: MappedDataSetParameter[];
|
|
@@ -2328,10 +2580,12 @@ export interface IntegerParameterDeclaration {
|
|
|
2328
2580
|
*/
|
|
2329
2581
|
export interface StringDefaultValues {
|
|
2330
2582
|
/**
|
|
2583
|
+
* @public
|
|
2331
2584
|
* <p>The dynamic value of the <code>StringDefaultValues</code>. Different defaults displayed according to users, groups, and values mapping.</p>
|
|
2332
2585
|
*/
|
|
2333
2586
|
DynamicValue?: DynamicDefaultValue;
|
|
2334
2587
|
/**
|
|
2588
|
+
* @public
|
|
2335
2589
|
* <p>The static values of the <code>DecimalDefaultValues</code>.</p>
|
|
2336
2590
|
*/
|
|
2337
2591
|
StaticValues?: string[];
|
|
@@ -2342,6 +2596,7 @@ export interface StringDefaultValues {
|
|
|
2342
2596
|
*/
|
|
2343
2597
|
export interface StringValueWhenUnsetConfiguration {
|
|
2344
2598
|
/**
|
|
2599
|
+
* @public
|
|
2345
2600
|
* <p>The built-in options for default values. The value can be one of the following:</p>
|
|
2346
2601
|
* <ul>
|
|
2347
2602
|
* <li>
|
|
@@ -2356,6 +2611,7 @@ export interface StringValueWhenUnsetConfiguration {
|
|
|
2356
2611
|
*/
|
|
2357
2612
|
ValueWhenUnsetOption?: ValueWhenUnsetOption | string;
|
|
2358
2613
|
/**
|
|
2614
|
+
* @public
|
|
2359
2615
|
* <p>A custom value that's used when the value of a parameter isn't set.</p>
|
|
2360
2616
|
*/
|
|
2361
2617
|
CustomValue?: string;
|
|
@@ -2366,22 +2622,27 @@ export interface StringValueWhenUnsetConfiguration {
|
|
|
2366
2622
|
*/
|
|
2367
2623
|
export interface StringParameterDeclaration {
|
|
2368
2624
|
/**
|
|
2625
|
+
* @public
|
|
2369
2626
|
* <p>The value type determines whether the parameter is a single-value or multi-value parameter.</p>
|
|
2370
2627
|
*/
|
|
2371
2628
|
ParameterValueType: ParameterValueType | string | undefined;
|
|
2372
2629
|
/**
|
|
2630
|
+
* @public
|
|
2373
2631
|
* <p>The name of the parameter that is being declared.</p>
|
|
2374
2632
|
*/
|
|
2375
2633
|
Name: string | undefined;
|
|
2376
2634
|
/**
|
|
2635
|
+
* @public
|
|
2377
2636
|
* <p>The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.</p>
|
|
2378
2637
|
*/
|
|
2379
2638
|
DefaultValues?: StringDefaultValues;
|
|
2380
2639
|
/**
|
|
2640
|
+
* @public
|
|
2381
2641
|
* <p>The configuration that defines the default value of a <code>String</code> parameter when a value has not been set.</p>
|
|
2382
2642
|
*/
|
|
2383
2643
|
ValueWhenUnset?: StringValueWhenUnsetConfiguration;
|
|
2384
2644
|
/**
|
|
2645
|
+
* @public
|
|
2385
2646
|
* <p>A list of dataset parameters that are mapped to an analysis parameter.</p>
|
|
2386
2647
|
*/
|
|
2387
2648
|
MappedDataSetParameters?: MappedDataSetParameter[];
|
|
@@ -2394,18 +2655,22 @@ export interface StringParameterDeclaration {
|
|
|
2394
2655
|
*/
|
|
2395
2656
|
export interface ParameterDeclaration {
|
|
2396
2657
|
/**
|
|
2658
|
+
* @public
|
|
2397
2659
|
* <p>A parameter declaration for the <code>String</code> data type.</p>
|
|
2398
2660
|
*/
|
|
2399
2661
|
StringParameterDeclaration?: StringParameterDeclaration;
|
|
2400
2662
|
/**
|
|
2663
|
+
* @public
|
|
2401
2664
|
* <p>A parameter declaration for the <code>Decimal</code> data type.</p>
|
|
2402
2665
|
*/
|
|
2403
2666
|
DecimalParameterDeclaration?: DecimalParameterDeclaration;
|
|
2404
2667
|
/**
|
|
2668
|
+
* @public
|
|
2405
2669
|
* <p>A parameter declaration for the <code>Integer</code> data type.</p>
|
|
2406
2670
|
*/
|
|
2407
2671
|
IntegerParameterDeclaration?: IntegerParameterDeclaration;
|
|
2408
2672
|
/**
|
|
2673
|
+
* @public
|
|
2409
2674
|
* <p>A parameter declaration for the <code>DateTime</code> data type.</p>
|
|
2410
2675
|
*/
|
|
2411
2676
|
DateTimeParameterDeclaration?: DateTimeParameterDeclaration;
|
|
@@ -2416,10 +2681,12 @@ export interface ParameterDeclaration {
|
|
|
2416
2681
|
*/
|
|
2417
2682
|
export interface SheetControlInfoIconLabelOptions {
|
|
2418
2683
|
/**
|
|
2684
|
+
* @public
|
|
2419
2685
|
* <p>The visibility configuration of info icon label options.</p>
|
|
2420
2686
|
*/
|
|
2421
2687
|
Visibility?: Visibility | string;
|
|
2422
2688
|
/**
|
|
2689
|
+
* @public
|
|
2423
2690
|
* <p> The text content of info icon.</p>
|
|
2424
2691
|
*/
|
|
2425
2692
|
InfoIconText?: string;
|
|
@@ -2457,6 +2724,7 @@ export type RelativeFontSize = (typeof RelativeFontSize)[keyof typeof RelativeFo
|
|
|
2457
2724
|
*/
|
|
2458
2725
|
export interface FontSize {
|
|
2459
2726
|
/**
|
|
2727
|
+
* @public
|
|
2460
2728
|
* <p>The lexical name for the text size, proportional to its surrounding context.</p>
|
|
2461
2729
|
*/
|
|
2462
2730
|
Relative?: RelativeFontSize | string;
|
|
@@ -2491,6 +2759,7 @@ export type FontWeightName = (typeof FontWeightName)[keyof typeof FontWeightName
|
|
|
2491
2759
|
*/
|
|
2492
2760
|
export interface FontWeight {
|
|
2493
2761
|
/**
|
|
2762
|
+
* @public
|
|
2494
2763
|
* <p>The lexical name for the level of boldness of the text display.</p>
|
|
2495
2764
|
*/
|
|
2496
2765
|
Name?: FontWeightName | string;
|
|
@@ -2501,22 +2770,27 @@ export interface FontWeight {
|
|
|
2501
2770
|
*/
|
|
2502
2771
|
export interface FontConfiguration {
|
|
2503
2772
|
/**
|
|
2773
|
+
* @public
|
|
2504
2774
|
* <p>The option that determines the text display size.</p>
|
|
2505
2775
|
*/
|
|
2506
2776
|
FontSize?: FontSize;
|
|
2507
2777
|
/**
|
|
2778
|
+
* @public
|
|
2508
2779
|
* <p>Determines the appearance of decorative lines on the text.</p>
|
|
2509
2780
|
*/
|
|
2510
2781
|
FontDecoration?: FontDecoration | string;
|
|
2511
2782
|
/**
|
|
2783
|
+
* @public
|
|
2512
2784
|
* <p>Determines the color of the text.</p>
|
|
2513
2785
|
*/
|
|
2514
2786
|
FontColor?: string;
|
|
2515
2787
|
/**
|
|
2788
|
+
* @public
|
|
2516
2789
|
* <p>The option that determines the text display weight, or boldness.</p>
|
|
2517
2790
|
*/
|
|
2518
2791
|
FontWeight?: FontWeight;
|
|
2519
2792
|
/**
|
|
2793
|
+
* @public
|
|
2520
2794
|
* <p>Determines the text display face that is inherited by the given font family.</p>
|
|
2521
2795
|
*/
|
|
2522
2796
|
FontStyle?: FontStyle | string;
|
|
@@ -2527,14 +2801,17 @@ export interface FontConfiguration {
|
|
|
2527
2801
|
*/
|
|
2528
2802
|
export interface LabelOptions {
|
|
2529
2803
|
/**
|
|
2804
|
+
* @public
|
|
2530
2805
|
* <p>Determines whether or not the label is visible.</p>
|
|
2531
2806
|
*/
|
|
2532
2807
|
Visibility?: Visibility | string;
|
|
2533
2808
|
/**
|
|
2809
|
+
* @public
|
|
2534
2810
|
* <p>The font configuration of the label.</p>
|
|
2535
2811
|
*/
|
|
2536
2812
|
FontConfiguration?: FontConfiguration;
|
|
2537
2813
|
/**
|
|
2814
|
+
* @public
|
|
2538
2815
|
* <p>The text for the label.</p>
|
|
2539
2816
|
*/
|
|
2540
2817
|
CustomLabel?: string;
|
|
@@ -2545,14 +2822,17 @@ export interface LabelOptions {
|
|
|
2545
2822
|
*/
|
|
2546
2823
|
export interface DateTimePickerControlDisplayOptions {
|
|
2547
2824
|
/**
|
|
2825
|
+
* @public
|
|
2548
2826
|
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
2549
2827
|
*/
|
|
2550
2828
|
TitleOptions?: LabelOptions;
|
|
2551
2829
|
/**
|
|
2830
|
+
* @public
|
|
2552
2831
|
* <p>Customize how dates are formatted in controls.</p>
|
|
2553
2832
|
*/
|
|
2554
2833
|
DateTimeFormat?: string;
|
|
2555
2834
|
/**
|
|
2835
|
+
* @public
|
|
2556
2836
|
* <p>The configuration of info icon label options.</p>
|
|
2557
2837
|
*/
|
|
2558
2838
|
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
@@ -2575,22 +2855,27 @@ export type SheetControlDateTimePickerType = (typeof SheetControlDateTimePickerT
|
|
|
2575
2855
|
*/
|
|
2576
2856
|
export interface FilterDateTimePickerControl {
|
|
2577
2857
|
/**
|
|
2858
|
+
* @public
|
|
2578
2859
|
* <p>The ID of the <code>FilterDateTimePickerControl</code>.</p>
|
|
2579
2860
|
*/
|
|
2580
2861
|
FilterControlId: string | undefined;
|
|
2581
2862
|
/**
|
|
2863
|
+
* @public
|
|
2582
2864
|
* <p>The title of the <code>FilterDateTimePickerControl</code>.</p>
|
|
2583
2865
|
*/
|
|
2584
2866
|
Title: string | undefined;
|
|
2585
2867
|
/**
|
|
2868
|
+
* @public
|
|
2586
2869
|
* <p>The source filter ID of the <code>FilterDateTimePickerControl</code>.</p>
|
|
2587
2870
|
*/
|
|
2588
2871
|
SourceFilterId: string | undefined;
|
|
2589
2872
|
/**
|
|
2873
|
+
* @public
|
|
2590
2874
|
* <p>The display options of a control.</p>
|
|
2591
2875
|
*/
|
|
2592
2876
|
DisplayOptions?: DateTimePickerControlDisplayOptions;
|
|
2593
2877
|
/**
|
|
2878
|
+
* @public
|
|
2594
2879
|
* <p>The date time picker type of a <code>FilterDateTimePickerControl</code>. Choose one of the following options:</p>
|
|
2595
2880
|
* <ul>
|
|
2596
2881
|
* <li>
|
|
@@ -2611,10 +2896,12 @@ export interface FilterDateTimePickerControl {
|
|
|
2611
2896
|
*/
|
|
2612
2897
|
export interface CascadingControlSource {
|
|
2613
2898
|
/**
|
|
2899
|
+
* @public
|
|
2614
2900
|
* <p>The source sheet control ID of a <code>CascadingControlSource</code>.</p>
|
|
2615
2901
|
*/
|
|
2616
2902
|
SourceSheetControlId?: string;
|
|
2617
2903
|
/**
|
|
2904
|
+
* @public
|
|
2618
2905
|
* <p>The column identifier that determines which column to look up for the source sheet control.</p>
|
|
2619
2906
|
*/
|
|
2620
2907
|
ColumnToMatch?: ColumnIdentifier;
|
|
@@ -2625,6 +2912,7 @@ export interface CascadingControlSource {
|
|
|
2625
2912
|
*/
|
|
2626
2913
|
export interface CascadingControlConfiguration {
|
|
2627
2914
|
/**
|
|
2915
|
+
* @public
|
|
2628
2916
|
* <p>A list of source controls that determine the values that are used in the current control.</p>
|
|
2629
2917
|
*/
|
|
2630
2918
|
SourceControls?: CascadingControlSource[];
|
|
@@ -2635,6 +2923,7 @@ export interface CascadingControlConfiguration {
|
|
|
2635
2923
|
*/
|
|
2636
2924
|
export interface ListControlSelectAllOptions {
|
|
2637
2925
|
/**
|
|
2926
|
+
* @public
|
|
2638
2927
|
* <p>The visibility configuration of the <code>Select all</code> options in a list control.</p>
|
|
2639
2928
|
*/
|
|
2640
2929
|
Visibility?: Visibility | string;
|
|
@@ -2645,15 +2934,18 @@ export interface ListControlSelectAllOptions {
|
|
|
2645
2934
|
*/
|
|
2646
2935
|
export interface DropDownControlDisplayOptions {
|
|
2647
2936
|
/**
|
|
2937
|
+
* @public
|
|
2648
2938
|
* <p>The configuration of the <code>Select all</code> options in a
|
|
2649
2939
|
* dropdown control.</p>
|
|
2650
2940
|
*/
|
|
2651
2941
|
SelectAllOptions?: ListControlSelectAllOptions;
|
|
2652
2942
|
/**
|
|
2943
|
+
* @public
|
|
2653
2944
|
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
2654
2945
|
*/
|
|
2655
2946
|
TitleOptions?: LabelOptions;
|
|
2656
2947
|
/**
|
|
2948
|
+
* @public
|
|
2657
2949
|
* <p>The configuration of info icon label options.</p>
|
|
2658
2950
|
*/
|
|
2659
2951
|
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
@@ -2664,6 +2956,7 @@ export interface DropDownControlDisplayOptions {
|
|
|
2664
2956
|
*/
|
|
2665
2957
|
export interface FilterSelectableValues {
|
|
2666
2958
|
/**
|
|
2959
|
+
* @public
|
|
2667
2960
|
* <p>The values that are used in the <code>FilterSelectableValues</code>.</p>
|
|
2668
2961
|
*/
|
|
2669
2962
|
Values?: string[];
|
|
@@ -2686,22 +2979,27 @@ export type SheetControlListType = (typeof SheetControlListType)[keyof typeof Sh
|
|
|
2686
2979
|
*/
|
|
2687
2980
|
export interface FilterDropDownControl {
|
|
2688
2981
|
/**
|
|
2982
|
+
* @public
|
|
2689
2983
|
* <p>The ID of the <code>FilterDropDownControl</code>.</p>
|
|
2690
2984
|
*/
|
|
2691
2985
|
FilterControlId: string | undefined;
|
|
2692
2986
|
/**
|
|
2987
|
+
* @public
|
|
2693
2988
|
* <p>The title of the <code>FilterDropDownControl</code>.</p>
|
|
2694
2989
|
*/
|
|
2695
2990
|
Title: string | undefined;
|
|
2696
2991
|
/**
|
|
2992
|
+
* @public
|
|
2697
2993
|
* <p>The source filter ID of the <code>FilterDropDownControl</code>.</p>
|
|
2698
2994
|
*/
|
|
2699
2995
|
SourceFilterId: string | undefined;
|
|
2700
2996
|
/**
|
|
2997
|
+
* @public
|
|
2701
2998
|
* <p>The display options of the <code>FilterDropDownControl</code>.</p>
|
|
2702
2999
|
*/
|
|
2703
3000
|
DisplayOptions?: DropDownControlDisplayOptions;
|
|
2704
3001
|
/**
|
|
3002
|
+
* @public
|
|
2705
3003
|
* <p>The type of the <code>FilterDropDownControl</code>. Choose one of the following options:</p>
|
|
2706
3004
|
* <ul>
|
|
2707
3005
|
* <li>
|
|
@@ -2716,10 +3014,12 @@ export interface FilterDropDownControl {
|
|
|
2716
3014
|
*/
|
|
2717
3015
|
Type?: SheetControlListType | string;
|
|
2718
3016
|
/**
|
|
3017
|
+
* @public
|
|
2719
3018
|
* <p>A list of selectable values that are used in a control.</p>
|
|
2720
3019
|
*/
|
|
2721
3020
|
SelectableValues?: FilterSelectableValues;
|
|
2722
3021
|
/**
|
|
3022
|
+
* @public
|
|
2723
3023
|
* <p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>
|
|
2724
3024
|
*/
|
|
2725
3025
|
CascadingControlConfiguration?: CascadingControlConfiguration;
|
|
@@ -2730,6 +3030,7 @@ export interface FilterDropDownControl {
|
|
|
2730
3030
|
*/
|
|
2731
3031
|
export interface ListControlSearchOptions {
|
|
2732
3032
|
/**
|
|
3033
|
+
* @public
|
|
2733
3034
|
* <p>The visibility configuration of the search options in a list control.</p>
|
|
2734
3035
|
*/
|
|
2735
3036
|
Visibility?: Visibility | string;
|
|
@@ -2740,18 +3041,22 @@ export interface ListControlSearchOptions {
|
|
|
2740
3041
|
*/
|
|
2741
3042
|
export interface ListControlDisplayOptions {
|
|
2742
3043
|
/**
|
|
3044
|
+
* @public
|
|
2743
3045
|
* <p>The configuration of the search options in a list control.</p>
|
|
2744
3046
|
*/
|
|
2745
3047
|
SearchOptions?: ListControlSearchOptions;
|
|
2746
3048
|
/**
|
|
3049
|
+
* @public
|
|
2747
3050
|
* <p>The configuration of the <code>Select all</code> options in a list control.</p>
|
|
2748
3051
|
*/
|
|
2749
3052
|
SelectAllOptions?: ListControlSelectAllOptions;
|
|
2750
3053
|
/**
|
|
3054
|
+
* @public
|
|
2751
3055
|
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
2752
3056
|
*/
|
|
2753
3057
|
TitleOptions?: LabelOptions;
|
|
2754
3058
|
/**
|
|
3059
|
+
* @public
|
|
2755
3060
|
* <p>The configuration of info icon label options.</p>
|
|
2756
3061
|
*/
|
|
2757
3062
|
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
@@ -2762,22 +3067,27 @@ export interface ListControlDisplayOptions {
|
|
|
2762
3067
|
*/
|
|
2763
3068
|
export interface FilterListControl {
|
|
2764
3069
|
/**
|
|
3070
|
+
* @public
|
|
2765
3071
|
* <p>The ID of the <code>FilterListControl</code>.</p>
|
|
2766
3072
|
*/
|
|
2767
3073
|
FilterControlId: string | undefined;
|
|
2768
3074
|
/**
|
|
3075
|
+
* @public
|
|
2769
3076
|
* <p>The title of the <code>FilterListControl</code>.</p>
|
|
2770
3077
|
*/
|
|
2771
3078
|
Title: string | undefined;
|
|
2772
3079
|
/**
|
|
3080
|
+
* @public
|
|
2773
3081
|
* <p>The source filter ID of the <code>FilterListControl</code>.</p>
|
|
2774
3082
|
*/
|
|
2775
3083
|
SourceFilterId: string | undefined;
|
|
2776
3084
|
/**
|
|
3085
|
+
* @public
|
|
2777
3086
|
* <p>The display options of a control.</p>
|
|
2778
3087
|
*/
|
|
2779
3088
|
DisplayOptions?: ListControlDisplayOptions;
|
|
2780
3089
|
/**
|
|
3090
|
+
* @public
|
|
2781
3091
|
* <p>The type of <code>FilterListControl</code>. Choose one of the following options:</p>
|
|
2782
3092
|
* <ul>
|
|
2783
3093
|
* <li>
|
|
@@ -2792,10 +3102,12 @@ export interface FilterListControl {
|
|
|
2792
3102
|
*/
|
|
2793
3103
|
Type?: SheetControlListType | string;
|
|
2794
3104
|
/**
|
|
3105
|
+
* @public
|
|
2795
3106
|
* <p>A list of selectable values that are used in a control.</p>
|
|
2796
3107
|
*/
|
|
2797
3108
|
SelectableValues?: FilterSelectableValues;
|
|
2798
3109
|
/**
|
|
3110
|
+
* @public
|
|
2799
3111
|
* <p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>
|
|
2800
3112
|
*/
|
|
2801
3113
|
CascadingControlConfiguration?: CascadingControlConfiguration;
|
|
@@ -2806,14 +3118,17 @@ export interface FilterListControl {
|
|
|
2806
3118
|
*/
|
|
2807
3119
|
export interface RelativeDateTimeControlDisplayOptions {
|
|
2808
3120
|
/**
|
|
3121
|
+
* @public
|
|
2809
3122
|
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
2810
3123
|
*/
|
|
2811
3124
|
TitleOptions?: LabelOptions;
|
|
2812
3125
|
/**
|
|
3126
|
+
* @public
|
|
2813
3127
|
* <p>Customize how dates are formatted in controls.</p>
|
|
2814
3128
|
*/
|
|
2815
3129
|
DateTimeFormat?: string;
|
|
2816
3130
|
/**
|
|
3131
|
+
* @public
|
|
2817
3132
|
* <p>The configuration of info icon label options.</p>
|
|
2818
3133
|
*/
|
|
2819
3134
|
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
@@ -2824,18 +3139,22 @@ export interface RelativeDateTimeControlDisplayOptions {
|
|
|
2824
3139
|
*/
|
|
2825
3140
|
export interface FilterRelativeDateTimeControl {
|
|
2826
3141
|
/**
|
|
3142
|
+
* @public
|
|
2827
3143
|
* <p>The ID of the <code>FilterTextAreaControl</code>.</p>
|
|
2828
3144
|
*/
|
|
2829
3145
|
FilterControlId: string | undefined;
|
|
2830
3146
|
/**
|
|
3147
|
+
* @public
|
|
2831
3148
|
* <p>The title of the <code>FilterTextAreaControl</code>.</p>
|
|
2832
3149
|
*/
|
|
2833
3150
|
Title: string | undefined;
|
|
2834
3151
|
/**
|
|
3152
|
+
* @public
|
|
2835
3153
|
* <p>The source filter ID of the <code>FilterTextAreaControl</code>.</p>
|
|
2836
3154
|
*/
|
|
2837
3155
|
SourceFilterId: string | undefined;
|
|
2838
3156
|
/**
|
|
3157
|
+
* @public
|
|
2839
3158
|
* <p>The display options of a control.</p>
|
|
2840
3159
|
*/
|
|
2841
3160
|
DisplayOptions?: RelativeDateTimeControlDisplayOptions;
|
|
@@ -2846,10 +3165,12 @@ export interface FilterRelativeDateTimeControl {
|
|
|
2846
3165
|
*/
|
|
2847
3166
|
export interface SliderControlDisplayOptions {
|
|
2848
3167
|
/**
|
|
3168
|
+
* @public
|
|
2849
3169
|
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
2850
3170
|
*/
|
|
2851
3171
|
TitleOptions?: LabelOptions;
|
|
2852
3172
|
/**
|
|
3173
|
+
* @public
|
|
2853
3174
|
* <p>The configuration of info icon label options.</p>
|
|
2854
3175
|
*/
|
|
2855
3176
|
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
@@ -2872,22 +3193,27 @@ export type SheetControlSliderType = (typeof SheetControlSliderType)[keyof typeo
|
|
|
2872
3193
|
*/
|
|
2873
3194
|
export interface FilterSliderControl {
|
|
2874
3195
|
/**
|
|
3196
|
+
* @public
|
|
2875
3197
|
* <p>The ID of the <code>FilterSliderControl</code>.</p>
|
|
2876
3198
|
*/
|
|
2877
3199
|
FilterControlId: string | undefined;
|
|
2878
3200
|
/**
|
|
3201
|
+
* @public
|
|
2879
3202
|
* <p>The title of the <code>FilterSliderControl</code>.</p>
|
|
2880
3203
|
*/
|
|
2881
3204
|
Title: string | undefined;
|
|
2882
3205
|
/**
|
|
3206
|
+
* @public
|
|
2883
3207
|
* <p>The source filter ID of the <code>FilterSliderControl</code>.</p>
|
|
2884
3208
|
*/
|
|
2885
3209
|
SourceFilterId: string | undefined;
|
|
2886
3210
|
/**
|
|
3211
|
+
* @public
|
|
2887
3212
|
* <p>The display options of a control.</p>
|
|
2888
3213
|
*/
|
|
2889
3214
|
DisplayOptions?: SliderControlDisplayOptions;
|
|
2890
3215
|
/**
|
|
3216
|
+
* @public
|
|
2891
3217
|
* <p>The type of <code>FilterSliderControl</code>. Choose one of the following options:</p>
|
|
2892
3218
|
* <ul>
|
|
2893
3219
|
* <li>
|
|
@@ -2902,14 +3228,17 @@ export interface FilterSliderControl {
|
|
|
2902
3228
|
*/
|
|
2903
3229
|
Type?: SheetControlSliderType | string;
|
|
2904
3230
|
/**
|
|
3231
|
+
* @public
|
|
2905
3232
|
* <p>The smaller value that is displayed at the left of the slider.</p>
|
|
2906
3233
|
*/
|
|
2907
3234
|
MaximumValue: number | undefined;
|
|
2908
3235
|
/**
|
|
3236
|
+
* @public
|
|
2909
3237
|
* <p>The larger value that is displayed at the right of the slider.</p>
|
|
2910
3238
|
*/
|
|
2911
3239
|
MinimumValue: number | undefined;
|
|
2912
3240
|
/**
|
|
3241
|
+
* @public
|
|
2913
3242
|
* <p>The number of increments that the slider bar is divided into.</p>
|
|
2914
3243
|
*/
|
|
2915
3244
|
StepSize: number | undefined;
|
|
@@ -2920,6 +3249,7 @@ export interface FilterSliderControl {
|
|
|
2920
3249
|
*/
|
|
2921
3250
|
export interface TextControlPlaceholderOptions {
|
|
2922
3251
|
/**
|
|
3252
|
+
* @public
|
|
2923
3253
|
* <p>The visibility configuration of the placeholder options in a text control.</p>
|
|
2924
3254
|
*/
|
|
2925
3255
|
Visibility?: Visibility | string;
|
|
@@ -2930,14 +3260,17 @@ export interface TextControlPlaceholderOptions {
|
|
|
2930
3260
|
*/
|
|
2931
3261
|
export interface TextAreaControlDisplayOptions {
|
|
2932
3262
|
/**
|
|
3263
|
+
* @public
|
|
2933
3264
|
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
2934
3265
|
*/
|
|
2935
3266
|
TitleOptions?: LabelOptions;
|
|
2936
3267
|
/**
|
|
3268
|
+
* @public
|
|
2937
3269
|
* <p>The configuration of the placeholder options in a text area control.</p>
|
|
2938
3270
|
*/
|
|
2939
3271
|
PlaceholderOptions?: TextControlPlaceholderOptions;
|
|
2940
3272
|
/**
|
|
3273
|
+
* @public
|
|
2941
3274
|
* <p>The configuration of info icon label options.</p>
|
|
2942
3275
|
*/
|
|
2943
3276
|
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
@@ -2948,22 +3281,27 @@ export interface TextAreaControlDisplayOptions {
|
|
|
2948
3281
|
*/
|
|
2949
3282
|
export interface FilterTextAreaControl {
|
|
2950
3283
|
/**
|
|
3284
|
+
* @public
|
|
2951
3285
|
* <p>The ID of the <code>FilterTextAreaControl</code>.</p>
|
|
2952
3286
|
*/
|
|
2953
3287
|
FilterControlId: string | undefined;
|
|
2954
3288
|
/**
|
|
3289
|
+
* @public
|
|
2955
3290
|
* <p>The title of the <code>FilterTextAreaControl</code>.</p>
|
|
2956
3291
|
*/
|
|
2957
3292
|
Title: string | undefined;
|
|
2958
3293
|
/**
|
|
3294
|
+
* @public
|
|
2959
3295
|
* <p>The source filter ID of the <code>FilterTextAreaControl</code>.</p>
|
|
2960
3296
|
*/
|
|
2961
3297
|
SourceFilterId: string | undefined;
|
|
2962
3298
|
/**
|
|
3299
|
+
* @public
|
|
2963
3300
|
* <p>The delimiter that is used to separate the lines in text.</p>
|
|
2964
3301
|
*/
|
|
2965
3302
|
Delimiter?: string;
|
|
2966
3303
|
/**
|
|
3304
|
+
* @public
|
|
2967
3305
|
* <p>The display options of a control.</p>
|
|
2968
3306
|
*/
|
|
2969
3307
|
DisplayOptions?: TextAreaControlDisplayOptions;
|
|
@@ -2974,14 +3312,17 @@ export interface FilterTextAreaControl {
|
|
|
2974
3312
|
*/
|
|
2975
3313
|
export interface TextFieldControlDisplayOptions {
|
|
2976
3314
|
/**
|
|
3315
|
+
* @public
|
|
2977
3316
|
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
2978
3317
|
*/
|
|
2979
3318
|
TitleOptions?: LabelOptions;
|
|
2980
3319
|
/**
|
|
3320
|
+
* @public
|
|
2981
3321
|
* <p>The configuration of the placeholder options in a text field control.</p>
|
|
2982
3322
|
*/
|
|
2983
3323
|
PlaceholderOptions?: TextControlPlaceholderOptions;
|
|
2984
3324
|
/**
|
|
3325
|
+
* @public
|
|
2985
3326
|
* <p>The configuration of info icon label options.</p>
|
|
2986
3327
|
*/
|
|
2987
3328
|
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
@@ -2992,18 +3333,22 @@ export interface TextFieldControlDisplayOptions {
|
|
|
2992
3333
|
*/
|
|
2993
3334
|
export interface FilterTextFieldControl {
|
|
2994
3335
|
/**
|
|
3336
|
+
* @public
|
|
2995
3337
|
* <p>The ID of the <code>FilterTextFieldControl</code>.</p>
|
|
2996
3338
|
*/
|
|
2997
3339
|
FilterControlId: string | undefined;
|
|
2998
3340
|
/**
|
|
3341
|
+
* @public
|
|
2999
3342
|
* <p>The title of the <code>FilterTextFieldControl</code>.</p>
|
|
3000
3343
|
*/
|
|
3001
3344
|
Title: string | undefined;
|
|
3002
3345
|
/**
|
|
3346
|
+
* @public
|
|
3003
3347
|
* <p>The source filter ID of the <code>FilterTextFieldControl</code>.</p>
|
|
3004
3348
|
*/
|
|
3005
3349
|
SourceFilterId: string | undefined;
|
|
3006
3350
|
/**
|
|
3351
|
+
* @public
|
|
3007
3352
|
* <p>The display options of a control.</p>
|
|
3008
3353
|
*/
|
|
3009
3354
|
DisplayOptions?: TextFieldControlDisplayOptions;
|
|
@@ -3015,30 +3360,37 @@ export interface FilterTextFieldControl {
|
|
|
3015
3360
|
*/
|
|
3016
3361
|
export interface FilterControl {
|
|
3017
3362
|
/**
|
|
3363
|
+
* @public
|
|
3018
3364
|
* <p>A control from a date filter that is used to specify date and time.</p>
|
|
3019
3365
|
*/
|
|
3020
3366
|
DateTimePicker?: FilterDateTimePickerControl;
|
|
3021
3367
|
/**
|
|
3368
|
+
* @public
|
|
3022
3369
|
* <p>A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.</p>
|
|
3023
3370
|
*/
|
|
3024
3371
|
List?: FilterListControl;
|
|
3025
3372
|
/**
|
|
3373
|
+
* @public
|
|
3026
3374
|
* <p>A control to display a dropdown list with buttons that are used to select a single value.</p>
|
|
3027
3375
|
*/
|
|
3028
3376
|
Dropdown?: FilterDropDownControl;
|
|
3029
3377
|
/**
|
|
3378
|
+
* @public
|
|
3030
3379
|
* <p>A control to display a text box that is used to enter a single entry.</p>
|
|
3031
3380
|
*/
|
|
3032
3381
|
TextField?: FilterTextFieldControl;
|
|
3033
3382
|
/**
|
|
3383
|
+
* @public
|
|
3034
3384
|
* <p>A control to display a text box that is used to enter multiple entries.</p>
|
|
3035
3385
|
*/
|
|
3036
3386
|
TextArea?: FilterTextAreaControl;
|
|
3037
3387
|
/**
|
|
3388
|
+
* @public
|
|
3038
3389
|
* <p>A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.</p>
|
|
3039
3390
|
*/
|
|
3040
3391
|
Slider?: FilterSliderControl;
|
|
3041
3392
|
/**
|
|
3393
|
+
* @public
|
|
3042
3394
|
* <p>A control from a date filter that is used to specify the relative date.</p>
|
|
3043
3395
|
*/
|
|
3044
3396
|
RelativeDateTime?: FilterRelativeDateTimeControl;
|
|
@@ -3049,10 +3401,12 @@ export interface FilterControl {
|
|
|
3049
3401
|
*/
|
|
3050
3402
|
export interface FreeFormLayoutElementBackgroundStyle {
|
|
3051
3403
|
/**
|
|
3404
|
+
* @public
|
|
3052
3405
|
* <p>The background visibility of a free-form layout element.</p>
|
|
3053
3406
|
*/
|
|
3054
3407
|
Visibility?: Visibility | string;
|
|
3055
3408
|
/**
|
|
3409
|
+
* @public
|
|
3056
3410
|
* <p>The background color of a free-form layout element.</p>
|
|
3057
3411
|
*/
|
|
3058
3412
|
Color?: string;
|
|
@@ -3063,10 +3417,12 @@ export interface FreeFormLayoutElementBackgroundStyle {
|
|
|
3063
3417
|
*/
|
|
3064
3418
|
export interface FreeFormLayoutElementBorderStyle {
|
|
3065
3419
|
/**
|
|
3420
|
+
* @public
|
|
3066
3421
|
* <p>The border visibility of a free-form layout element.</p>
|
|
3067
3422
|
*/
|
|
3068
3423
|
Visibility?: Visibility | string;
|
|
3069
3424
|
/**
|
|
3425
|
+
* @public
|
|
3070
3426
|
* <p>The border color of a free-form layout element.</p>
|
|
3071
3427
|
*/
|
|
3072
3428
|
Color?: string;
|
|
@@ -3091,6 +3447,7 @@ export type LayoutElementType = (typeof LayoutElementType)[keyof typeof LayoutEl
|
|
|
3091
3447
|
*/
|
|
3092
3448
|
export interface LoadingAnimation {
|
|
3093
3449
|
/**
|
|
3450
|
+
* @public
|
|
3094
3451
|
* <p>The visibility configuration of <code>LoadingAnimation</code>.</p>
|
|
3095
3452
|
*/
|
|
3096
3453
|
Visibility?: Visibility | string;
|
|
@@ -3101,6 +3458,7 @@ export interface LoadingAnimation {
|
|
|
3101
3458
|
*/
|
|
3102
3459
|
export interface SheetElementConfigurationOverrides {
|
|
3103
3460
|
/**
|
|
3461
|
+
* @public
|
|
3104
3462
|
* <p>Determines whether or not the overrides are visible. Choose one of the following options:</p>
|
|
3105
3463
|
* <ul>
|
|
3106
3464
|
* <li>
|
|
@@ -3123,10 +3481,12 @@ export interface SheetElementConfigurationOverrides {
|
|
|
3123
3481
|
*/
|
|
3124
3482
|
export interface SheetElementRenderingRule {
|
|
3125
3483
|
/**
|
|
3484
|
+
* @public
|
|
3126
3485
|
* <p>The expression of the rendering rules of a sheet.</p>
|
|
3127
3486
|
*/
|
|
3128
3487
|
Expression: string | undefined;
|
|
3129
3488
|
/**
|
|
3489
|
+
* @public
|
|
3130
3490
|
* <p>The override configuration of the rendering rules of a sheet.</p>
|
|
3131
3491
|
*/
|
|
3132
3492
|
ConfigurationOverrides: SheetElementConfigurationOverrides | undefined;
|
|
@@ -3137,50 +3497,62 @@ export interface SheetElementRenderingRule {
|
|
|
3137
3497
|
*/
|
|
3138
3498
|
export interface FreeFormLayoutElement {
|
|
3139
3499
|
/**
|
|
3500
|
+
* @public
|
|
3140
3501
|
* <p>A unique identifier for an element within a free-form layout.</p>
|
|
3141
3502
|
*/
|
|
3142
3503
|
ElementId: string | undefined;
|
|
3143
3504
|
/**
|
|
3505
|
+
* @public
|
|
3144
3506
|
* <p>The type of element.</p>
|
|
3145
3507
|
*/
|
|
3146
3508
|
ElementType: LayoutElementType | string | undefined;
|
|
3147
3509
|
/**
|
|
3510
|
+
* @public
|
|
3148
3511
|
* <p>The x-axis coordinate of the element.</p>
|
|
3149
3512
|
*/
|
|
3150
3513
|
XAxisLocation: string | undefined;
|
|
3151
3514
|
/**
|
|
3515
|
+
* @public
|
|
3152
3516
|
* <p>The y-axis coordinate of the element.</p>
|
|
3153
3517
|
*/
|
|
3154
3518
|
YAxisLocation: string | undefined;
|
|
3155
3519
|
/**
|
|
3520
|
+
* @public
|
|
3156
3521
|
* <p>The width of an element within a free-form layout.</p>
|
|
3157
3522
|
*/
|
|
3158
3523
|
Width: string | undefined;
|
|
3159
3524
|
/**
|
|
3525
|
+
* @public
|
|
3160
3526
|
* <p>The height of an element within a free-form layout.</p>
|
|
3161
3527
|
*/
|
|
3162
3528
|
Height: string | undefined;
|
|
3163
3529
|
/**
|
|
3530
|
+
* @public
|
|
3164
3531
|
* <p>The visibility of an element within a free-form layout.</p>
|
|
3165
3532
|
*/
|
|
3166
3533
|
Visibility?: Visibility | string;
|
|
3167
3534
|
/**
|
|
3535
|
+
* @public
|
|
3168
3536
|
* <p>The rendering rules that determine when an element should be displayed within a free-form layout.</p>
|
|
3169
3537
|
*/
|
|
3170
3538
|
RenderingRules?: SheetElementRenderingRule[];
|
|
3171
3539
|
/**
|
|
3540
|
+
* @public
|
|
3172
3541
|
* <p>The border style configuration of a free-form layout element.</p>
|
|
3173
3542
|
*/
|
|
3174
3543
|
BorderStyle?: FreeFormLayoutElementBorderStyle;
|
|
3175
3544
|
/**
|
|
3545
|
+
* @public
|
|
3176
3546
|
* <p>The border style configuration of a free-form layout element. This border style is used when the element is selected.</p>
|
|
3177
3547
|
*/
|
|
3178
3548
|
SelectedBorderStyle?: FreeFormLayoutElementBorderStyle;
|
|
3179
3549
|
/**
|
|
3550
|
+
* @public
|
|
3180
3551
|
* <p>The background style configuration of a free-form layout element.</p>
|
|
3181
3552
|
*/
|
|
3182
3553
|
BackgroundStyle?: FreeFormLayoutElementBackgroundStyle;
|
|
3183
3554
|
/**
|
|
3555
|
+
* @public
|
|
3184
3556
|
* <p>The loading animation configuration of a free-form layout element.</p>
|
|
3185
3557
|
*/
|
|
3186
3558
|
LoadingAnimation?: LoadingAnimation;
|
|
@@ -3191,10 +3563,12 @@ export interface FreeFormLayoutElement {
|
|
|
3191
3563
|
*/
|
|
3192
3564
|
export interface FreeFormLayoutConfiguration {
|
|
3193
3565
|
/**
|
|
3566
|
+
* @public
|
|
3194
3567
|
* <p>The elements that are included in a free-form layout.</p>
|
|
3195
3568
|
*/
|
|
3196
3569
|
Elements: FreeFormLayoutElement[] | undefined;
|
|
3197
3570
|
/**
|
|
3571
|
+
* @public
|
|
3198
3572
|
* <p>Configuration options for the canvas of a free-form layout.</p>
|
|
3199
3573
|
*/
|
|
3200
3574
|
CanvasSizeOptions?: FreeFormLayoutCanvasSizeOptions;
|
|
@@ -3205,26 +3579,32 @@ export interface FreeFormLayoutConfiguration {
|
|
|
3205
3579
|
*/
|
|
3206
3580
|
export interface GridLayoutElement {
|
|
3207
3581
|
/**
|
|
3582
|
+
* @public
|
|
3208
3583
|
* <p>A unique identifier for an element within a grid layout.</p>
|
|
3209
3584
|
*/
|
|
3210
3585
|
ElementId: string | undefined;
|
|
3211
3586
|
/**
|
|
3587
|
+
* @public
|
|
3212
3588
|
* <p>The type of element.</p>
|
|
3213
3589
|
*/
|
|
3214
3590
|
ElementType: LayoutElementType | string | undefined;
|
|
3215
3591
|
/**
|
|
3592
|
+
* @public
|
|
3216
3593
|
* <p>The column index for the upper left corner of an element.</p>
|
|
3217
3594
|
*/
|
|
3218
3595
|
ColumnIndex?: number;
|
|
3219
3596
|
/**
|
|
3597
|
+
* @public
|
|
3220
3598
|
* <p>The width of a grid element expressed as a number of grid columns.</p>
|
|
3221
3599
|
*/
|
|
3222
3600
|
ColumnSpan: number | undefined;
|
|
3223
3601
|
/**
|
|
3602
|
+
* @public
|
|
3224
3603
|
* <p>The row index for the upper left corner of an element.</p>
|
|
3225
3604
|
*/
|
|
3226
3605
|
RowIndex?: number;
|
|
3227
3606
|
/**
|
|
3607
|
+
* @public
|
|
3228
3608
|
* <p>The height of a grid element expressed as a number of grid rows.</p>
|
|
3229
3609
|
*/
|
|
3230
3610
|
RowSpan: number | undefined;
|
|
@@ -3236,10 +3616,12 @@ export interface GridLayoutElement {
|
|
|
3236
3616
|
*/
|
|
3237
3617
|
export interface GridLayoutConfiguration {
|
|
3238
3618
|
/**
|
|
3619
|
+
* @public
|
|
3239
3620
|
* <p>The elements that are included in a grid layout.</p>
|
|
3240
3621
|
*/
|
|
3241
3622
|
Elements: GridLayoutElement[] | undefined;
|
|
3242
3623
|
/**
|
|
3624
|
+
* @public
|
|
3243
3625
|
* <p>Configuration options for the canvas of a grid layout.</p>
|
|
3244
3626
|
*/
|
|
3245
3627
|
CanvasSizeOptions?: GridLayoutCanvasSizeOptions;
|
|
@@ -3250,6 +3632,7 @@ export interface GridLayoutConfiguration {
|
|
|
3250
3632
|
*/
|
|
3251
3633
|
export interface FreeFormSectionLayoutConfiguration {
|
|
3252
3634
|
/**
|
|
3635
|
+
* @public
|
|
3253
3636
|
* <p>The elements that are included in the free-form layout.</p>
|
|
3254
3637
|
*/
|
|
3255
3638
|
Elements: FreeFormLayoutElement[] | undefined;
|
|
@@ -3260,6 +3643,7 @@ export interface FreeFormSectionLayoutConfiguration {
|
|
|
3260
3643
|
*/
|
|
3261
3644
|
export interface SectionLayoutConfiguration {
|
|
3262
3645
|
/**
|
|
3646
|
+
* @public
|
|
3263
3647
|
* <p>The free-form layout configuration of a section.</p>
|
|
3264
3648
|
*/
|
|
3265
3649
|
FreeFormLayout: FreeFormSectionLayoutConfiguration | undefined;
|
|
@@ -3270,6 +3654,7 @@ export interface SectionLayoutConfiguration {
|
|
|
3270
3654
|
*/
|
|
3271
3655
|
export interface BodySectionContent {
|
|
3272
3656
|
/**
|
|
3657
|
+
* @public
|
|
3273
3658
|
* <p>The layout configuration of a body section.</p>
|
|
3274
3659
|
*/
|
|
3275
3660
|
Layout?: SectionLayoutConfiguration;
|
|
@@ -3292,6 +3677,7 @@ export type SectionPageBreakStatus = (typeof SectionPageBreakStatus)[keyof typeo
|
|
|
3292
3677
|
*/
|
|
3293
3678
|
export interface SectionAfterPageBreak {
|
|
3294
3679
|
/**
|
|
3680
|
+
* @public
|
|
3295
3681
|
* <p>The option that enables or disables a page break at the end of a section.</p>
|
|
3296
3682
|
*/
|
|
3297
3683
|
Status?: SectionPageBreakStatus | string;
|
|
@@ -3302,6 +3688,7 @@ export interface SectionAfterPageBreak {
|
|
|
3302
3688
|
*/
|
|
3303
3689
|
export interface SectionPageBreakConfiguration {
|
|
3304
3690
|
/**
|
|
3691
|
+
* @public
|
|
3305
3692
|
* <p>The configuration of a page break after a section.</p>
|
|
3306
3693
|
*/
|
|
3307
3694
|
After?: SectionAfterPageBreak;
|
|
@@ -3312,11 +3699,13 @@ export interface SectionPageBreakConfiguration {
|
|
|
3312
3699
|
*/
|
|
3313
3700
|
export interface SectionStyle {
|
|
3314
3701
|
/**
|
|
3702
|
+
* @public
|
|
3315
3703
|
* <p>The height of a section.</p>
|
|
3316
3704
|
* <p>Heights can only be defined for header and footer sections. The default height margin is 0.5 inches. </p>
|
|
3317
3705
|
*/
|
|
3318
3706
|
Height?: string;
|
|
3319
3707
|
/**
|
|
3708
|
+
* @public
|
|
3320
3709
|
* <p>The spacing between section content and its top, bottom, left, and right edges.</p>
|
|
3321
3710
|
* <p>There is no padding by default.</p>
|
|
3322
3711
|
*/
|
|
@@ -3328,18 +3717,22 @@ export interface SectionStyle {
|
|
|
3328
3717
|
*/
|
|
3329
3718
|
export interface BodySectionConfiguration {
|
|
3330
3719
|
/**
|
|
3720
|
+
* @public
|
|
3331
3721
|
* <p>The unique identifier of a body section.</p>
|
|
3332
3722
|
*/
|
|
3333
3723
|
SectionId: string | undefined;
|
|
3334
3724
|
/**
|
|
3725
|
+
* @public
|
|
3335
3726
|
* <p>The configuration of content in a body section.</p>
|
|
3336
3727
|
*/
|
|
3337
3728
|
Content: BodySectionContent | undefined;
|
|
3338
3729
|
/**
|
|
3730
|
+
* @public
|
|
3339
3731
|
* <p>The style options of a body section.</p>
|
|
3340
3732
|
*/
|
|
3341
3733
|
Style?: SectionStyle;
|
|
3342
3734
|
/**
|
|
3735
|
+
* @public
|
|
3343
3736
|
* <p>The configuration of a page break for a section.</p>
|
|
3344
3737
|
*/
|
|
3345
3738
|
PageBreakConfiguration?: SectionPageBreakConfiguration;
|
|
@@ -3350,14 +3743,17 @@ export interface BodySectionConfiguration {
|
|
|
3350
3743
|
*/
|
|
3351
3744
|
export interface HeaderFooterSectionConfiguration {
|
|
3352
3745
|
/**
|
|
3746
|
+
* @public
|
|
3353
3747
|
* <p>The unique identifier of the header or footer section.</p>
|
|
3354
3748
|
*/
|
|
3355
3749
|
SectionId: string | undefined;
|
|
3356
3750
|
/**
|
|
3751
|
+
* @public
|
|
3357
3752
|
* <p>The layout configuration of the header or footer section.</p>
|
|
3358
3753
|
*/
|
|
3359
3754
|
Layout: SectionLayoutConfiguration | undefined;
|
|
3360
3755
|
/**
|
|
3756
|
+
* @public
|
|
3361
3757
|
* <p>The style options of a header or footer section.</p>
|
|
3362
3758
|
*/
|
|
3363
3759
|
Style?: SectionStyle;
|
|
@@ -3369,18 +3765,22 @@ export interface HeaderFooterSectionConfiguration {
|
|
|
3369
3765
|
*/
|
|
3370
3766
|
export interface SectionBasedLayoutConfiguration {
|
|
3371
3767
|
/**
|
|
3768
|
+
* @public
|
|
3372
3769
|
* <p>A list of header section configurations.</p>
|
|
3373
3770
|
*/
|
|
3374
3771
|
HeaderSections: HeaderFooterSectionConfiguration[] | undefined;
|
|
3375
3772
|
/**
|
|
3773
|
+
* @public
|
|
3376
3774
|
* <p>A list of body section configurations.</p>
|
|
3377
3775
|
*/
|
|
3378
3776
|
BodySections: BodySectionConfiguration[] | undefined;
|
|
3379
3777
|
/**
|
|
3778
|
+
* @public
|
|
3380
3779
|
* <p>A list of footer section configurations.</p>
|
|
3381
3780
|
*/
|
|
3382
3781
|
FooterSections: HeaderFooterSectionConfiguration[] | undefined;
|
|
3383
3782
|
/**
|
|
3783
|
+
* @public
|
|
3384
3784
|
* <p>The options for the canvas of a section-based layout.</p>
|
|
3385
3785
|
*/
|
|
3386
3786
|
CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptions | undefined;
|
|
@@ -3392,14 +3792,17 @@ export interface SectionBasedLayoutConfiguration {
|
|
|
3392
3792
|
*/
|
|
3393
3793
|
export interface LayoutConfiguration {
|
|
3394
3794
|
/**
|
|
3795
|
+
* @public
|
|
3395
3796
|
* <p>A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: <code>FIXED</code> or <code>RESPONSIVE</code>.</p>
|
|
3396
3797
|
*/
|
|
3397
3798
|
GridLayout?: GridLayoutConfiguration;
|
|
3398
3799
|
/**
|
|
3800
|
+
* @public
|
|
3399
3801
|
* <p>A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.</p>
|
|
3400
3802
|
*/
|
|
3401
3803
|
FreeFormLayout?: FreeFormLayoutConfiguration;
|
|
3402
3804
|
/**
|
|
3805
|
+
* @public
|
|
3403
3806
|
* <p>A section based layout organizes visuals into multiple sections and has customized header, footer and page break.</p>
|
|
3404
3807
|
*/
|
|
3405
3808
|
SectionBasedLayout?: SectionBasedLayoutConfiguration;
|
|
@@ -3412,6 +3815,7 @@ export interface LayoutConfiguration {
|
|
|
3412
3815
|
*/
|
|
3413
3816
|
export interface Layout {
|
|
3414
3817
|
/**
|
|
3818
|
+
* @public
|
|
3415
3819
|
* <p>The configuration that determines what the type of layout for a sheet.</p>
|
|
3416
3820
|
*/
|
|
3417
3821
|
Configuration: LayoutConfiguration | undefined;
|
|
@@ -3422,18 +3826,22 @@ export interface Layout {
|
|
|
3422
3826
|
*/
|
|
3423
3827
|
export interface ParameterDateTimePickerControl {
|
|
3424
3828
|
/**
|
|
3829
|
+
* @public
|
|
3425
3830
|
* <p>The ID of the <code>ParameterDateTimePickerControl</code>.</p>
|
|
3426
3831
|
*/
|
|
3427
3832
|
ParameterControlId: string | undefined;
|
|
3428
3833
|
/**
|
|
3834
|
+
* @public
|
|
3429
3835
|
* <p>The title of the <code>ParameterDateTimePickerControl</code>.</p>
|
|
3430
3836
|
*/
|
|
3431
3837
|
Title: string | undefined;
|
|
3432
3838
|
/**
|
|
3839
|
+
* @public
|
|
3433
3840
|
* <p>The name of the <code>ParameterDateTimePickerControl</code>.</p>
|
|
3434
3841
|
*/
|
|
3435
3842
|
SourceParameterName: string | undefined;
|
|
3436
3843
|
/**
|
|
3844
|
+
* @public
|
|
3437
3845
|
* <p>The display options of a control.</p>
|
|
3438
3846
|
*/
|
|
3439
3847
|
DisplayOptions?: DateTimePickerControlDisplayOptions;
|
|
@@ -3444,10 +3852,12 @@ export interface ParameterDateTimePickerControl {
|
|
|
3444
3852
|
*/
|
|
3445
3853
|
export interface ParameterSelectableValues {
|
|
3446
3854
|
/**
|
|
3855
|
+
* @public
|
|
3447
3856
|
* <p>The values that are used in <code>ParameterSelectableValues</code>.</p>
|
|
3448
3857
|
*/
|
|
3449
3858
|
Values?: string[];
|
|
3450
3859
|
/**
|
|
3860
|
+
* @public
|
|
3451
3861
|
* <p>The column identifier that fetches values from the data set.</p>
|
|
3452
3862
|
*/
|
|
3453
3863
|
LinkToDataSetColumn?: ColumnIdentifier;
|
|
@@ -3458,30 +3868,37 @@ export interface ParameterSelectableValues {
|
|
|
3458
3868
|
*/
|
|
3459
3869
|
export interface ParameterDropDownControl {
|
|
3460
3870
|
/**
|
|
3871
|
+
* @public
|
|
3461
3872
|
* <p>The ID of the <code>ParameterDropDownControl</code>.</p>
|
|
3462
3873
|
*/
|
|
3463
3874
|
ParameterControlId: string | undefined;
|
|
3464
3875
|
/**
|
|
3876
|
+
* @public
|
|
3465
3877
|
* <p>The title of the <code>ParameterDropDownControl</code>.</p>
|
|
3466
3878
|
*/
|
|
3467
3879
|
Title: string | undefined;
|
|
3468
3880
|
/**
|
|
3881
|
+
* @public
|
|
3469
3882
|
* <p>The source parameter name of the <code>ParameterDropDownControl</code>.</p>
|
|
3470
3883
|
*/
|
|
3471
3884
|
SourceParameterName: string | undefined;
|
|
3472
3885
|
/**
|
|
3886
|
+
* @public
|
|
3473
3887
|
* <p>The display options of a control.</p>
|
|
3474
3888
|
*/
|
|
3475
3889
|
DisplayOptions?: DropDownControlDisplayOptions;
|
|
3476
3890
|
/**
|
|
3891
|
+
* @public
|
|
3477
3892
|
* <p>The type parameter name of the <code>ParameterDropDownControl</code>.</p>
|
|
3478
3893
|
*/
|
|
3479
3894
|
Type?: SheetControlListType | string;
|
|
3480
3895
|
/**
|
|
3896
|
+
* @public
|
|
3481
3897
|
* <p>A list of selectable values that are used in a control.</p>
|
|
3482
3898
|
*/
|
|
3483
3899
|
SelectableValues?: ParameterSelectableValues;
|
|
3484
3900
|
/**
|
|
3901
|
+
* @public
|
|
3485
3902
|
* <p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>
|
|
3486
3903
|
*/
|
|
3487
3904
|
CascadingControlConfiguration?: CascadingControlConfiguration;
|
|
@@ -3492,30 +3909,37 @@ export interface ParameterDropDownControl {
|
|
|
3492
3909
|
*/
|
|
3493
3910
|
export interface ParameterListControl {
|
|
3494
3911
|
/**
|
|
3912
|
+
* @public
|
|
3495
3913
|
* <p>The ID of the <code>ParameterListControl</code>.</p>
|
|
3496
3914
|
*/
|
|
3497
3915
|
ParameterControlId: string | undefined;
|
|
3498
3916
|
/**
|
|
3917
|
+
* @public
|
|
3499
3918
|
* <p>The title of the <code>ParameterListControl</code>.</p>
|
|
3500
3919
|
*/
|
|
3501
3920
|
Title: string | undefined;
|
|
3502
3921
|
/**
|
|
3922
|
+
* @public
|
|
3503
3923
|
* <p>The source parameter name of the <code>ParameterListControl</code>.</p>
|
|
3504
3924
|
*/
|
|
3505
3925
|
SourceParameterName: string | undefined;
|
|
3506
3926
|
/**
|
|
3927
|
+
* @public
|
|
3507
3928
|
* <p>The display options of a control.</p>
|
|
3508
3929
|
*/
|
|
3509
3930
|
DisplayOptions?: ListControlDisplayOptions;
|
|
3510
3931
|
/**
|
|
3932
|
+
* @public
|
|
3511
3933
|
* <p>The type of <code>ParameterListControl</code>.</p>
|
|
3512
3934
|
*/
|
|
3513
3935
|
Type?: SheetControlListType | string;
|
|
3514
3936
|
/**
|
|
3937
|
+
* @public
|
|
3515
3938
|
* <p>A list of selectable values that are used in a control.</p>
|
|
3516
3939
|
*/
|
|
3517
3940
|
SelectableValues?: ParameterSelectableValues;
|
|
3518
3941
|
/**
|
|
3942
|
+
* @public
|
|
3519
3943
|
* <p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>
|
|
3520
3944
|
*/
|
|
3521
3945
|
CascadingControlConfiguration?: CascadingControlConfiguration;
|
|
@@ -3526,30 +3950,37 @@ export interface ParameterListControl {
|
|
|
3526
3950
|
*/
|
|
3527
3951
|
export interface ParameterSliderControl {
|
|
3528
3952
|
/**
|
|
3953
|
+
* @public
|
|
3529
3954
|
* <p>The ID of the <code>ParameterSliderControl</code>.</p>
|
|
3530
3955
|
*/
|
|
3531
3956
|
ParameterControlId: string | undefined;
|
|
3532
3957
|
/**
|
|
3958
|
+
* @public
|
|
3533
3959
|
* <p>The title of the <code>ParameterSliderControl</code>.</p>
|
|
3534
3960
|
*/
|
|
3535
3961
|
Title: string | undefined;
|
|
3536
3962
|
/**
|
|
3963
|
+
* @public
|
|
3537
3964
|
* <p>The source parameter name of the <code>ParameterSliderControl</code>.</p>
|
|
3538
3965
|
*/
|
|
3539
3966
|
SourceParameterName: string | undefined;
|
|
3540
3967
|
/**
|
|
3968
|
+
* @public
|
|
3541
3969
|
* <p>The display options of a control.</p>
|
|
3542
3970
|
*/
|
|
3543
3971
|
DisplayOptions?: SliderControlDisplayOptions;
|
|
3544
3972
|
/**
|
|
3973
|
+
* @public
|
|
3545
3974
|
* <p>The smaller value that is displayed at the left of the slider.</p>
|
|
3546
3975
|
*/
|
|
3547
3976
|
MaximumValue: number | undefined;
|
|
3548
3977
|
/**
|
|
3978
|
+
* @public
|
|
3549
3979
|
* <p>The larger value that is displayed at the right of the slider.</p>
|
|
3550
3980
|
*/
|
|
3551
3981
|
MinimumValue: number | undefined;
|
|
3552
3982
|
/**
|
|
3983
|
+
* @public
|
|
3553
3984
|
* <p>The number of increments that the slider bar is divided into.</p>
|
|
3554
3985
|
*/
|
|
3555
3986
|
StepSize: number | undefined;
|
|
@@ -3560,22 +3991,27 @@ export interface ParameterSliderControl {
|
|
|
3560
3991
|
*/
|
|
3561
3992
|
export interface ParameterTextAreaControl {
|
|
3562
3993
|
/**
|
|
3994
|
+
* @public
|
|
3563
3995
|
* <p>The ID of the <code>ParameterTextAreaControl</code>.</p>
|
|
3564
3996
|
*/
|
|
3565
3997
|
ParameterControlId: string | undefined;
|
|
3566
3998
|
/**
|
|
3999
|
+
* @public
|
|
3567
4000
|
* <p>The title of the <code>ParameterTextAreaControl</code>.</p>
|
|
3568
4001
|
*/
|
|
3569
4002
|
Title: string | undefined;
|
|
3570
4003
|
/**
|
|
4004
|
+
* @public
|
|
3571
4005
|
* <p>The source parameter name of the <code>ParameterTextAreaControl</code>.</p>
|
|
3572
4006
|
*/
|
|
3573
4007
|
SourceParameterName: string | undefined;
|
|
3574
4008
|
/**
|
|
4009
|
+
* @public
|
|
3575
4010
|
* <p>The delimiter that is used to separate the lines in text.</p>
|
|
3576
4011
|
*/
|
|
3577
4012
|
Delimiter?: string;
|
|
3578
4013
|
/**
|
|
4014
|
+
* @public
|
|
3579
4015
|
* <p>The display options of a control.</p>
|
|
3580
4016
|
*/
|
|
3581
4017
|
DisplayOptions?: TextAreaControlDisplayOptions;
|
|
@@ -3586,18 +4022,22 @@ export interface ParameterTextAreaControl {
|
|
|
3586
4022
|
*/
|
|
3587
4023
|
export interface ParameterTextFieldControl {
|
|
3588
4024
|
/**
|
|
4025
|
+
* @public
|
|
3589
4026
|
* <p>The ID of the <code>ParameterTextFieldControl</code>.</p>
|
|
3590
4027
|
*/
|
|
3591
4028
|
ParameterControlId: string | undefined;
|
|
3592
4029
|
/**
|
|
4030
|
+
* @public
|
|
3593
4031
|
* <p>The title of the <code>ParameterTextFieldControl</code>.</p>
|
|
3594
4032
|
*/
|
|
3595
4033
|
Title: string | undefined;
|
|
3596
4034
|
/**
|
|
4035
|
+
* @public
|
|
3597
4036
|
* <p>The source parameter name of the <code>ParameterTextFieldControl</code>.</p>
|
|
3598
4037
|
*/
|
|
3599
4038
|
SourceParameterName: string | undefined;
|
|
3600
4039
|
/**
|
|
4040
|
+
* @public
|
|
3601
4041
|
* <p>The display options of a control.</p>
|
|
3602
4042
|
*/
|
|
3603
4043
|
DisplayOptions?: TextFieldControlDisplayOptions;
|
|
@@ -3609,26 +4049,32 @@ export interface ParameterTextFieldControl {
|
|
|
3609
4049
|
*/
|
|
3610
4050
|
export interface ParameterControl {
|
|
3611
4051
|
/**
|
|
4052
|
+
* @public
|
|
3612
4053
|
* <p>A control from a date parameter that specifies date and time.</p>
|
|
3613
4054
|
*/
|
|
3614
4055
|
DateTimePicker?: ParameterDateTimePickerControl;
|
|
3615
4056
|
/**
|
|
4057
|
+
* @public
|
|
3616
4058
|
* <p>A control to display a list with buttons or boxes that are used to select either a single value or multiple values.</p>
|
|
3617
4059
|
*/
|
|
3618
4060
|
List?: ParameterListControl;
|
|
3619
4061
|
/**
|
|
4062
|
+
* @public
|
|
3620
4063
|
* <p>A control to display a dropdown list with buttons that are used to select a single value.</p>
|
|
3621
4064
|
*/
|
|
3622
4065
|
Dropdown?: ParameterDropDownControl;
|
|
3623
4066
|
/**
|
|
4067
|
+
* @public
|
|
3624
4068
|
* <p>A control to display a text box that is used to enter a single entry.</p>
|
|
3625
4069
|
*/
|
|
3626
4070
|
TextField?: ParameterTextFieldControl;
|
|
3627
4071
|
/**
|
|
4072
|
+
* @public
|
|
3628
4073
|
* <p>A control to display a text box that is used to enter multiple entries.</p>
|
|
3629
4074
|
*/
|
|
3630
4075
|
TextArea?: ParameterTextAreaControl;
|
|
3631
4076
|
/**
|
|
4077
|
+
* @public
|
|
3632
4078
|
* <p>A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.</p>
|
|
3633
4079
|
*/
|
|
3634
4080
|
Slider?: ParameterSliderControl;
|
|
@@ -3639,6 +4085,7 @@ export interface ParameterControl {
|
|
|
3639
4085
|
*/
|
|
3640
4086
|
export interface SheetControlLayoutConfiguration {
|
|
3641
4087
|
/**
|
|
4088
|
+
* @public
|
|
3642
4089
|
* <p>The configuration that determines the elements and canvas size options of sheet control.</p>
|
|
3643
4090
|
*/
|
|
3644
4091
|
GridLayout?: GridLayoutConfiguration;
|
|
@@ -3649,6 +4096,7 @@ export interface SheetControlLayoutConfiguration {
|
|
|
3649
4096
|
*/
|
|
3650
4097
|
export interface SheetControlLayout {
|
|
3651
4098
|
/**
|
|
4099
|
+
* @public
|
|
3652
4100
|
* <p>The configuration that determines the elements and canvas size options of sheet control.</p>
|
|
3653
4101
|
*/
|
|
3654
4102
|
Configuration: SheetControlLayoutConfiguration | undefined;
|
|
@@ -3659,10 +4107,12 @@ export interface SheetControlLayout {
|
|
|
3659
4107
|
*/
|
|
3660
4108
|
export interface SheetTextBox {
|
|
3661
4109
|
/**
|
|
4110
|
+
* @public
|
|
3662
4111
|
* <p>The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.</p>
|
|
3663
4112
|
*/
|
|
3664
4113
|
SheetTextBoxId: string | undefined;
|
|
3665
4114
|
/**
|
|
4115
|
+
* @public
|
|
3666
4116
|
* <p>The content that is displayed in the text box.</p>
|
|
3667
4117
|
*/
|
|
3668
4118
|
Content?: string;
|
|
@@ -3685,10 +4135,12 @@ export type SelectedFieldOptions = (typeof SelectedFieldOptions)[keyof typeof Se
|
|
|
3685
4135
|
*/
|
|
3686
4136
|
export interface FilterOperationSelectedFieldsConfiguration {
|
|
3687
4137
|
/**
|
|
4138
|
+
* @public
|
|
3688
4139
|
* <p>Chooses the fields that are filtered in <code>CustomActionFilterOperation</code>.</p>
|
|
3689
4140
|
*/
|
|
3690
4141
|
SelectedFields?: string[];
|
|
3691
4142
|
/**
|
|
4143
|
+
* @public
|
|
3692
4144
|
* <p>A structure that contains the options that choose which fields are filtered in the <code>CustomActionFilterOperation</code>.</p>
|
|
3693
4145
|
* <p>Valid values are defined as follows:</p>
|
|
3694
4146
|
* <ul>
|
|
@@ -3700,6 +4152,7 @@ export interface FilterOperationSelectedFieldsConfiguration {
|
|
|
3700
4152
|
*/
|
|
3701
4153
|
SelectedFieldOptions?: SelectedFieldOptions | string;
|
|
3702
4154
|
/**
|
|
4155
|
+
* @public
|
|
3703
4156
|
* <p>The selected columns of a dataset.</p>
|
|
3704
4157
|
*/
|
|
3705
4158
|
SelectedColumns?: ColumnIdentifier[];
|
|
@@ -3722,10 +4175,12 @@ export type TargetVisualOptions = (typeof TargetVisualOptions)[keyof typeof Targ
|
|
|
3722
4175
|
*/
|
|
3723
4176
|
export interface SameSheetTargetVisualConfiguration {
|
|
3724
4177
|
/**
|
|
4178
|
+
* @public
|
|
3725
4179
|
* <p>A list of the target visual IDs that are located in the same sheet of the analysis.</p>
|
|
3726
4180
|
*/
|
|
3727
4181
|
TargetVisuals?: string[];
|
|
3728
4182
|
/**
|
|
4183
|
+
* @public
|
|
3729
4184
|
* <p>The options that choose the target visual in the same sheet.</p>
|
|
3730
4185
|
* <p>Valid values are defined as follows:</p>
|
|
3731
4186
|
* <ul>
|
|
@@ -3744,6 +4199,7 @@ export interface SameSheetTargetVisualConfiguration {
|
|
|
3744
4199
|
*/
|
|
3745
4200
|
export interface FilterOperationTargetVisualsConfiguration {
|
|
3746
4201
|
/**
|
|
4202
|
+
* @public
|
|
3747
4203
|
* <p>The configuration of the same-sheet target visuals that you want to be filtered.</p>
|
|
3748
4204
|
*/
|
|
3749
4205
|
SameSheetTargetVisualConfiguration?: SameSheetTargetVisualConfiguration;
|
|
@@ -3754,10 +4210,12 @@ export interface FilterOperationTargetVisualsConfiguration {
|
|
|
3754
4210
|
*/
|
|
3755
4211
|
export interface CustomActionFilterOperation {
|
|
3756
4212
|
/**
|
|
4213
|
+
* @public
|
|
3757
4214
|
* <p>The configuration that chooses the fields to be filtered.</p>
|
|
3758
4215
|
*/
|
|
3759
4216
|
SelectedFieldsConfiguration: FilterOperationSelectedFieldsConfiguration | undefined;
|
|
3760
4217
|
/**
|
|
4218
|
+
* @public
|
|
3761
4219
|
* <p>The configuration that chooses the target visuals to be filtered.</p>
|
|
3762
4220
|
*/
|
|
3763
4221
|
TargetVisualsConfiguration: FilterOperationTargetVisualsConfiguration | undefined;
|
|
@@ -3768,6 +4226,7 @@ export interface CustomActionFilterOperation {
|
|
|
3768
4226
|
*/
|
|
3769
4227
|
export interface LocalNavigationConfiguration {
|
|
3770
4228
|
/**
|
|
4229
|
+
* @public
|
|
3771
4230
|
* <p>The sheet that is targeted for navigation in the same analysis.</p>
|
|
3772
4231
|
*/
|
|
3773
4232
|
TargetSheetId: string | undefined;
|
|
@@ -3779,6 +4238,7 @@ export interface LocalNavigationConfiguration {
|
|
|
3779
4238
|
*/
|
|
3780
4239
|
export interface CustomActionNavigationOperation {
|
|
3781
4240
|
/**
|
|
4241
|
+
* @public
|
|
3782
4242
|
* <p>The configuration that chooses the navigation target.</p>
|
|
3783
4243
|
*/
|
|
3784
4244
|
LocalNavigationConfiguration?: LocalNavigationConfiguration;
|
|
@@ -3790,18 +4250,22 @@ export interface CustomActionNavigationOperation {
|
|
|
3790
4250
|
*/
|
|
3791
4251
|
export interface CustomParameterValues {
|
|
3792
4252
|
/**
|
|
4253
|
+
* @public
|
|
3793
4254
|
* <p>A list of string-type parameter values.</p>
|
|
3794
4255
|
*/
|
|
3795
4256
|
StringValues?: string[];
|
|
3796
4257
|
/**
|
|
4258
|
+
* @public
|
|
3797
4259
|
* <p>A list of integer-type parameter values.</p>
|
|
3798
4260
|
*/
|
|
3799
4261
|
IntegerValues?: number[];
|
|
3800
4262
|
/**
|
|
4263
|
+
* @public
|
|
3801
4264
|
* <p>A list of decimal-type parameter values.</p>
|
|
3802
4265
|
*/
|
|
3803
4266
|
DecimalValues?: number[];
|
|
3804
4267
|
/**
|
|
4268
|
+
* @public
|
|
3805
4269
|
* <p>A list of datetime-type parameter values.</p>
|
|
3806
4270
|
*/
|
|
3807
4271
|
DateTimeValues?: Date[];
|
|
@@ -3812,10 +4276,12 @@ export interface CustomParameterValues {
|
|
|
3812
4276
|
*/
|
|
3813
4277
|
export interface CustomValuesConfiguration {
|
|
3814
4278
|
/**
|
|
4279
|
+
* @public
|
|
3815
4280
|
* <p>Includes the null value in custom action parameter values.</p>
|
|
3816
4281
|
*/
|
|
3817
4282
|
IncludeNullValue?: boolean;
|
|
3818
4283
|
/**
|
|
4284
|
+
* @public
|
|
3819
4285
|
* <p>The customized parameter values.</p>
|
|
3820
4286
|
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
3821
4287
|
*/
|
|
@@ -3839,22 +4305,27 @@ export type SelectAllValueOptions = (typeof SelectAllValueOptions)[keyof typeof
|
|
|
3839
4305
|
*/
|
|
3840
4306
|
export interface DestinationParameterValueConfiguration {
|
|
3841
4307
|
/**
|
|
4308
|
+
* @public
|
|
3842
4309
|
* <p>The configuration of custom values for destination parameter in <code>DestinationParameterValueConfiguration</code>.</p>
|
|
3843
4310
|
*/
|
|
3844
4311
|
CustomValuesConfiguration?: CustomValuesConfiguration;
|
|
3845
4312
|
/**
|
|
4313
|
+
* @public
|
|
3846
4314
|
* <p>The configuration that selects all options.</p>
|
|
3847
4315
|
*/
|
|
3848
4316
|
SelectAllValueOptions?: SelectAllValueOptions | string;
|
|
3849
4317
|
/**
|
|
4318
|
+
* @public
|
|
3850
4319
|
* <p>The source parameter name of the destination parameter.</p>
|
|
3851
4320
|
*/
|
|
3852
4321
|
SourceParameterName?: string;
|
|
3853
4322
|
/**
|
|
4323
|
+
* @public
|
|
3854
4324
|
* <p>The source field ID of the destination parameter.</p>
|
|
3855
4325
|
*/
|
|
3856
4326
|
SourceField?: string;
|
|
3857
4327
|
/**
|
|
4328
|
+
* @public
|
|
3858
4329
|
* <p>A column of a data set.</p>
|
|
3859
4330
|
*/
|
|
3860
4331
|
SourceColumn?: ColumnIdentifier;
|
|
@@ -3865,10 +4336,12 @@ export interface DestinationParameterValueConfiguration {
|
|
|
3865
4336
|
*/
|
|
3866
4337
|
export interface SetParameterValueConfiguration {
|
|
3867
4338
|
/**
|
|
4339
|
+
* @public
|
|
3868
4340
|
* <p>The destination parameter name of the <code>SetParameterValueConfiguration</code>.</p>
|
|
3869
4341
|
*/
|
|
3870
4342
|
DestinationParameterName: string | undefined;
|
|
3871
4343
|
/**
|
|
4344
|
+
* @public
|
|
3872
4345
|
* <p>The configuration of destination parameter values.</p>
|
|
3873
4346
|
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
3874
4347
|
*/
|
|
@@ -3880,6 +4353,7 @@ export interface SetParameterValueConfiguration {
|
|
|
3880
4353
|
*/
|
|
3881
4354
|
export interface CustomActionSetParametersOperation {
|
|
3882
4355
|
/**
|
|
4356
|
+
* @public
|
|
3883
4357
|
* <p>The parameter that determines the value configuration.</p>
|
|
3884
4358
|
*/
|
|
3885
4359
|
ParameterValueConfigurations: SetParameterValueConfiguration[] | undefined;
|
|
@@ -3903,10 +4377,12 @@ export type URLTargetConfiguration = (typeof URLTargetConfiguration)[keyof typeo
|
|
|
3903
4377
|
*/
|
|
3904
4378
|
export interface CustomActionURLOperation {
|
|
3905
4379
|
/**
|
|
4380
|
+
* @public
|
|
3906
4381
|
* <p>THe URL link of the <code>CustomActionURLOperation</code>.</p>
|
|
3907
4382
|
*/
|
|
3908
4383
|
URLTemplate: string | undefined;
|
|
3909
4384
|
/**
|
|
4385
|
+
* @public
|
|
3910
4386
|
* <p>The target of the <code>CustomActionURLOperation</code>.</p>
|
|
3911
4387
|
* <p>Valid values are defined as follows:</p>
|
|
3912
4388
|
* <ul>
|
|
@@ -3933,18 +4409,22 @@ export interface CustomActionURLOperation {
|
|
|
3933
4409
|
*/
|
|
3934
4410
|
export interface VisualCustomActionOperation {
|
|
3935
4411
|
/**
|
|
4412
|
+
* @public
|
|
3936
4413
|
* <p>The filter operation that filters data included in a visual or in an entire sheet.</p>
|
|
3937
4414
|
*/
|
|
3938
4415
|
FilterOperation?: CustomActionFilterOperation;
|
|
3939
4416
|
/**
|
|
4417
|
+
* @public
|
|
3940
4418
|
* <p>The navigation operation that navigates between different sheets in the same analysis.</p>
|
|
3941
4419
|
*/
|
|
3942
4420
|
NavigationOperation?: CustomActionNavigationOperation;
|
|
3943
4421
|
/**
|
|
4422
|
+
* @public
|
|
3944
4423
|
* <p>The URL operation that opens a link to another webpage.</p>
|
|
3945
4424
|
*/
|
|
3946
4425
|
URLOperation?: CustomActionURLOperation;
|
|
3947
4426
|
/**
|
|
4427
|
+
* @public
|
|
3948
4428
|
* <p>The set parameter operation that sets parameters in custom action.</p>
|
|
3949
4429
|
*/
|
|
3950
4430
|
SetParametersOperation?: CustomActionSetParametersOperation;
|
|
@@ -3967,18 +4447,22 @@ export type VisualCustomActionTrigger = (typeof VisualCustomActionTrigger)[keyof
|
|
|
3967
4447
|
*/
|
|
3968
4448
|
export interface VisualCustomAction {
|
|
3969
4449
|
/**
|
|
4450
|
+
* @public
|
|
3970
4451
|
* <p>The ID of the <code>VisualCustomAction</code>.</p>
|
|
3971
4452
|
*/
|
|
3972
4453
|
CustomActionId: string | undefined;
|
|
3973
4454
|
/**
|
|
4455
|
+
* @public
|
|
3974
4456
|
* <p>The name of the <code>VisualCustomAction</code>.</p>
|
|
3975
4457
|
*/
|
|
3976
4458
|
Name: string | undefined;
|
|
3977
4459
|
/**
|
|
4460
|
+
* @public
|
|
3978
4461
|
* <p>The status of the <code>VisualCustomAction</code>.</p>
|
|
3979
4462
|
*/
|
|
3980
4463
|
Status?: WidgetStatus | string;
|
|
3981
4464
|
/**
|
|
4465
|
+
* @public
|
|
3982
4466
|
* <p>The trigger of the <code>VisualCustomAction</code>.</p>
|
|
3983
4467
|
* <p>Valid values are defined as follows:</p>
|
|
3984
4468
|
* <ul>
|
|
@@ -3994,6 +4478,7 @@ export interface VisualCustomAction {
|
|
|
3994
4478
|
*/
|
|
3995
4479
|
Trigger: VisualCustomActionTrigger | string | undefined;
|
|
3996
4480
|
/**
|
|
4481
|
+
* @public
|
|
3997
4482
|
* <p>A list of <code>VisualCustomActionOperations</code>.</p>
|
|
3998
4483
|
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
3999
4484
|
*/
|
|
@@ -4018,6 +4503,7 @@ export type BarsArrangement = (typeof BarsArrangement)[keyof typeof BarsArrangem
|
|
|
4018
4503
|
*/
|
|
4019
4504
|
export interface DateAxisOptions {
|
|
4020
4505
|
/**
|
|
4506
|
+
* @public
|
|
4021
4507
|
* <p>Determines whether or not missing dates are displayed.</p>
|
|
4022
4508
|
*/
|
|
4023
4509
|
MissingDateVisibility?: Visibility | string;
|
|
@@ -4034,10 +4520,12 @@ export interface AxisDisplayDataDrivenRange {
|
|
|
4034
4520
|
*/
|
|
4035
4521
|
export interface AxisDisplayMinMaxRange {
|
|
4036
4522
|
/**
|
|
4523
|
+
* @public
|
|
4037
4524
|
* <p>The minimum setup for an axis display range.</p>
|
|
4038
4525
|
*/
|
|
4039
4526
|
Minimum?: number;
|
|
4040
4527
|
/**
|
|
4528
|
+
* @public
|
|
4041
4529
|
* <p>The maximum setup for an axis display range.</p>
|
|
4042
4530
|
*/
|
|
4043
4531
|
Maximum?: number;
|
|
@@ -4049,10 +4537,12 @@ export interface AxisDisplayMinMaxRange {
|
|
|
4049
4537
|
*/
|
|
4050
4538
|
export interface AxisDisplayRange {
|
|
4051
4539
|
/**
|
|
4540
|
+
* @public
|
|
4052
4541
|
* <p>The minimum and maximum setup of an axis display range.</p>
|
|
4053
4542
|
*/
|
|
4054
4543
|
MinMax?: AxisDisplayMinMaxRange;
|
|
4055
4544
|
/**
|
|
4545
|
+
* @public
|
|
4056
4546
|
* <p>The data-driven setup of an axis display range.</p>
|
|
4057
4547
|
*/
|
|
4058
4548
|
DataDriven?: AxisDisplayDataDrivenRange;
|
|
@@ -4064,10 +4554,12 @@ export interface AxisDisplayRange {
|
|
|
4064
4554
|
*/
|
|
4065
4555
|
export interface AxisLinearScale {
|
|
4066
4556
|
/**
|
|
4557
|
+
* @public
|
|
4067
4558
|
* <p>The step count setup of a linear axis.</p>
|
|
4068
4559
|
*/
|
|
4069
4560
|
StepCount?: number;
|
|
4070
4561
|
/**
|
|
4562
|
+
* @public
|
|
4071
4563
|
* <p>The step size setup of a linear axis.</p>
|
|
4072
4564
|
*/
|
|
4073
4565
|
StepSize?: number;
|
|
@@ -4078,6 +4570,7 @@ export interface AxisLinearScale {
|
|
|
4078
4570
|
*/
|
|
4079
4571
|
export interface AxisLogarithmicScale {
|
|
4080
4572
|
/**
|
|
4573
|
+
* @public
|
|
4081
4574
|
* <p>The base setup of a logarithmic axis scale.</p>
|
|
4082
4575
|
*/
|
|
4083
4576
|
Base?: number;
|
|
@@ -4090,10 +4583,12 @@ export interface AxisLogarithmicScale {
|
|
|
4090
4583
|
*/
|
|
4091
4584
|
export interface AxisScale {
|
|
4092
4585
|
/**
|
|
4586
|
+
* @public
|
|
4093
4587
|
* <p>The linear axis scale setup.</p>
|
|
4094
4588
|
*/
|
|
4095
4589
|
Linear?: AxisLinearScale;
|
|
4096
4590
|
/**
|
|
4591
|
+
* @public
|
|
4097
4592
|
* <p>The logarithmic axis scale setup.</p>
|
|
4098
4593
|
*/
|
|
4099
4594
|
Logarithmic?: AxisLogarithmicScale;
|
|
@@ -4104,10 +4599,12 @@ export interface AxisScale {
|
|
|
4104
4599
|
*/
|
|
4105
4600
|
export interface NumericAxisOptions {
|
|
4106
4601
|
/**
|
|
4602
|
+
* @public
|
|
4107
4603
|
* <p>The scale setup of a numeric axis.</p>
|
|
4108
4604
|
*/
|
|
4109
4605
|
Scale?: AxisScale;
|
|
4110
4606
|
/**
|
|
4607
|
+
* @public
|
|
4111
4608
|
* <p>The range setup of a numeric axis.</p>
|
|
4112
4609
|
*/
|
|
4113
4610
|
Range?: AxisDisplayRange;
|
|
@@ -4119,10 +4616,12 @@ export interface NumericAxisOptions {
|
|
|
4119
4616
|
*/
|
|
4120
4617
|
export interface AxisDataOptions {
|
|
4121
4618
|
/**
|
|
4619
|
+
* @public
|
|
4122
4620
|
* <p>The options for an axis with a numeric field.</p>
|
|
4123
4621
|
*/
|
|
4124
4622
|
NumericAxisOptions?: NumericAxisOptions;
|
|
4125
4623
|
/**
|
|
4624
|
+
* @public
|
|
4126
4625
|
* <p>The options for an axis with a date field.</p>
|
|
4127
4626
|
*/
|
|
4128
4627
|
DateAxisOptions?: DateAxisOptions;
|
|
@@ -4133,10 +4632,12 @@ export interface AxisDataOptions {
|
|
|
4133
4632
|
*/
|
|
4134
4633
|
export interface PercentVisibleRange {
|
|
4135
4634
|
/**
|
|
4635
|
+
* @public
|
|
4136
4636
|
* <p>The lower bound of the range.</p>
|
|
4137
4637
|
*/
|
|
4138
4638
|
From?: number;
|
|
4139
4639
|
/**
|
|
4640
|
+
* @public
|
|
4140
4641
|
* <p>The top bound of the range.</p>
|
|
4141
4642
|
*/
|
|
4142
4643
|
To?: number;
|
|
@@ -4147,6 +4648,7 @@ export interface PercentVisibleRange {
|
|
|
4147
4648
|
*/
|
|
4148
4649
|
export interface VisibleRangeOptions {
|
|
4149
4650
|
/**
|
|
4651
|
+
* @public
|
|
4150
4652
|
* <p>The percent range in the visible range.</p>
|
|
4151
4653
|
*/
|
|
4152
4654
|
PercentRange?: PercentVisibleRange;
|
|
@@ -4157,10 +4659,12 @@ export interface VisibleRangeOptions {
|
|
|
4157
4659
|
*/
|
|
4158
4660
|
export interface ScrollBarOptions {
|
|
4159
4661
|
/**
|
|
4662
|
+
* @public
|
|
4160
4663
|
* <p>The visibility of the data zoom scroll bar.</p>
|
|
4161
4664
|
*/
|
|
4162
4665
|
Visibility?: Visibility | string;
|
|
4163
4666
|
/**
|
|
4667
|
+
* @public
|
|
4164
4668
|
* <p>The visibility range for the data zoom scroll bar.</p>
|
|
4165
4669
|
*/
|
|
4166
4670
|
VisibleRange?: VisibleRangeOptions;
|
|
@@ -4171,10 +4675,12 @@ export interface ScrollBarOptions {
|
|
|
4171
4675
|
*/
|
|
4172
4676
|
export interface AxisTickLabelOptions {
|
|
4173
4677
|
/**
|
|
4678
|
+
* @public
|
|
4174
4679
|
* <p>Determines whether or not the axis ticks are visible.</p>
|
|
4175
4680
|
*/
|
|
4176
4681
|
LabelOptions?: LabelOptions;
|
|
4177
4682
|
/**
|
|
4683
|
+
* @public
|
|
4178
4684
|
* <p>The rotation angle of the axis tick labels.</p>
|
|
4179
4685
|
*/
|
|
4180
4686
|
RotationAngle?: number;
|
|
@@ -4185,26 +4691,32 @@ export interface AxisTickLabelOptions {
|
|
|
4185
4691
|
*/
|
|
4186
4692
|
export interface AxisDisplayOptions {
|
|
4187
4693
|
/**
|
|
4694
|
+
* @public
|
|
4188
4695
|
* <p>The tick label options of an axis.</p>
|
|
4189
4696
|
*/
|
|
4190
4697
|
TickLabelOptions?: AxisTickLabelOptions;
|
|
4191
4698
|
/**
|
|
4699
|
+
* @public
|
|
4192
4700
|
* <p>Determines whether or not the axis line is visible.</p>
|
|
4193
4701
|
*/
|
|
4194
4702
|
AxisLineVisibility?: Visibility | string;
|
|
4195
4703
|
/**
|
|
4704
|
+
* @public
|
|
4196
4705
|
* <p>Determines whether or not the grid line is visible.</p>
|
|
4197
4706
|
*/
|
|
4198
4707
|
GridLineVisibility?: Visibility | string;
|
|
4199
4708
|
/**
|
|
4709
|
+
* @public
|
|
4200
4710
|
* <p>The data options for an axis.</p>
|
|
4201
4711
|
*/
|
|
4202
4712
|
DataOptions?: AxisDataOptions;
|
|
4203
4713
|
/**
|
|
4714
|
+
* @public
|
|
4204
4715
|
* <p>The scroll bar options for an axis.</p>
|
|
4205
4716
|
*/
|
|
4206
4717
|
ScrollbarOptions?: ScrollBarOptions;
|
|
4207
4718
|
/**
|
|
4719
|
+
* @public
|
|
4208
4720
|
* <p>The offset value that determines the starting placement of the axis within a visual's bounds.</p>
|
|
4209
4721
|
*/
|
|
4210
4722
|
AxisOffset?: string;
|
|
@@ -4215,10 +4727,12 @@ export interface AxisDisplayOptions {
|
|
|
4215
4727
|
*/
|
|
4216
4728
|
export interface AxisLabelReferenceOptions {
|
|
4217
4729
|
/**
|
|
4730
|
+
* @public
|
|
4218
4731
|
* <p>The field that the axis label is targeted to.</p>
|
|
4219
4732
|
*/
|
|
4220
4733
|
FieldId: string | undefined;
|
|
4221
4734
|
/**
|
|
4735
|
+
* @public
|
|
4222
4736
|
* <p>The column that the axis label is targeted to.</p>
|
|
4223
4737
|
*/
|
|
4224
4738
|
Column: ColumnIdentifier | undefined;
|
|
@@ -4229,14 +4743,17 @@ export interface AxisLabelReferenceOptions {
|
|
|
4229
4743
|
*/
|
|
4230
4744
|
export interface AxisLabelOptions {
|
|
4231
4745
|
/**
|
|
4746
|
+
* @public
|
|
4232
4747
|
* <p>The font configuration of the axis label.</p>
|
|
4233
4748
|
*/
|
|
4234
4749
|
FontConfiguration?: FontConfiguration;
|
|
4235
4750
|
/**
|
|
4751
|
+
* @public
|
|
4236
4752
|
* <p>The text for the axis label.</p>
|
|
4237
4753
|
*/
|
|
4238
4754
|
CustomLabel?: string;
|
|
4239
4755
|
/**
|
|
4756
|
+
* @public
|
|
4240
4757
|
* <p>The options that indicate which field the label belongs to.</p>
|
|
4241
4758
|
*/
|
|
4242
4759
|
ApplyTo?: AxisLabelReferenceOptions;
|
|
@@ -4247,6 +4764,7 @@ export interface AxisLabelOptions {
|
|
|
4247
4764
|
*/
|
|
4248
4765
|
export interface ChartAxisLabelOptions {
|
|
4249
4766
|
/**
|
|
4767
|
+
* @public
|
|
4250
4768
|
* <p>The visibility of an axis label on a chart. Choose one of the following options:</p>
|
|
4251
4769
|
* <ul>
|
|
4252
4770
|
* <li>
|
|
@@ -4261,10 +4779,12 @@ export interface ChartAxisLabelOptions {
|
|
|
4261
4779
|
*/
|
|
4262
4780
|
Visibility?: Visibility | string;
|
|
4263
4781
|
/**
|
|
4782
|
+
* @public
|
|
4264
4783
|
* <p>The visibility configuration of the sort icon on a chart's axis label.</p>
|
|
4265
4784
|
*/
|
|
4266
4785
|
SortIconVisibility?: Visibility | string;
|
|
4267
4786
|
/**
|
|
4787
|
+
* @public
|
|
4268
4788
|
* <p>The label options for a chart axis.</p>
|
|
4269
4789
|
*/
|
|
4270
4790
|
AxisLabelOptions?: AxisLabelOptions[];
|
|
@@ -4275,10 +4795,12 @@ export interface ChartAxisLabelOptions {
|
|
|
4275
4795
|
*/
|
|
4276
4796
|
export interface ContributionAnalysisDefault {
|
|
4277
4797
|
/**
|
|
4798
|
+
* @public
|
|
4278
4799
|
* <p>The measure field that is used in the contribution analysis.</p>
|
|
4279
4800
|
*/
|
|
4280
4801
|
MeasureFieldId: string | undefined;
|
|
4281
4802
|
/**
|
|
4803
|
+
* @public
|
|
4282
4804
|
* <p>The dimensions columns that are used in the contribution analysis,
|
|
4283
4805
|
* usually a list of <code>ColumnIdentifiers</code>.</p>
|
|
4284
4806
|
*/
|
|
@@ -4290,14 +4812,17 @@ export interface ContributionAnalysisDefault {
|
|
|
4290
4812
|
*/
|
|
4291
4813
|
export interface DataPathLabelType {
|
|
4292
4814
|
/**
|
|
4815
|
+
* @public
|
|
4293
4816
|
* <p>The field ID of the field that the data label needs to be applied to.</p>
|
|
4294
4817
|
*/
|
|
4295
4818
|
FieldId?: string;
|
|
4296
4819
|
/**
|
|
4820
|
+
* @public
|
|
4297
4821
|
* <p>The actual value of the field that is labeled.</p>
|
|
4298
4822
|
*/
|
|
4299
4823
|
FieldValue?: string;
|
|
4300
4824
|
/**
|
|
4825
|
+
* @public
|
|
4301
4826
|
* <p>The visibility of the data label.</p>
|
|
4302
4827
|
*/
|
|
4303
4828
|
Visibility?: Visibility | string;
|
|
@@ -4308,11 +4833,13 @@ export interface DataPathLabelType {
|
|
|
4308
4833
|
*/
|
|
4309
4834
|
export interface FieldLabelType {
|
|
4310
4835
|
/**
|
|
4836
|
+
* @public
|
|
4311
4837
|
* <p>Indicates the field that is targeted by the field
|
|
4312
4838
|
* label.</p>
|
|
4313
4839
|
*/
|
|
4314
4840
|
FieldId?: string;
|
|
4315
4841
|
/**
|
|
4842
|
+
* @public
|
|
4316
4843
|
* <p>The visibility of the field label.</p>
|
|
4317
4844
|
*/
|
|
4318
4845
|
Visibility?: Visibility | string;
|
|
@@ -4323,6 +4850,7 @@ export interface FieldLabelType {
|
|
|
4323
4850
|
*/
|
|
4324
4851
|
export interface MaximumLabelType {
|
|
4325
4852
|
/**
|
|
4853
|
+
* @public
|
|
4326
4854
|
* <p>The visibility of the maximum label.</p>
|
|
4327
4855
|
*/
|
|
4328
4856
|
Visibility?: Visibility | string;
|
|
@@ -4333,6 +4861,7 @@ export interface MaximumLabelType {
|
|
|
4333
4861
|
*/
|
|
4334
4862
|
export interface MinimumLabelType {
|
|
4335
4863
|
/**
|
|
4864
|
+
* @public
|
|
4336
4865
|
* <p>The visibility of the minimum label.</p>
|
|
4337
4866
|
*/
|
|
4338
4867
|
Visibility?: Visibility | string;
|
|
@@ -4343,6 +4872,7 @@ export interface MinimumLabelType {
|
|
|
4343
4872
|
*/
|
|
4344
4873
|
export interface RangeEndsLabelType {
|
|
4345
4874
|
/**
|
|
4875
|
+
* @public
|
|
4346
4876
|
* <p>The visibility of the range ends label.</p>
|
|
4347
4877
|
*/
|
|
4348
4878
|
Visibility?: Visibility | string;
|
|
@@ -4354,22 +4884,27 @@ export interface RangeEndsLabelType {
|
|
|
4354
4884
|
*/
|
|
4355
4885
|
export interface DataLabelType {
|
|
4356
4886
|
/**
|
|
4887
|
+
* @public
|
|
4357
4888
|
* <p>Determines the label configuration for the entire field.</p>
|
|
4358
4889
|
*/
|
|
4359
4890
|
FieldLabelType?: FieldLabelType;
|
|
4360
4891
|
/**
|
|
4892
|
+
* @public
|
|
4361
4893
|
* <p>The option that specifies individual data values for labels.</p>
|
|
4362
4894
|
*/
|
|
4363
4895
|
DataPathLabelType?: DataPathLabelType;
|
|
4364
4896
|
/**
|
|
4897
|
+
* @public
|
|
4365
4898
|
* <p>Determines the label configuration for range end value in a visual.</p>
|
|
4366
4899
|
*/
|
|
4367
4900
|
RangeEndsLabelType?: RangeEndsLabelType;
|
|
4368
4901
|
/**
|
|
4902
|
+
* @public
|
|
4369
4903
|
* <p>Determines the label configuration for the minimum value in a visual.</p>
|
|
4370
4904
|
*/
|
|
4371
4905
|
MinimumLabelType?: MinimumLabelType;
|
|
4372
4906
|
/**
|
|
4907
|
+
* @public
|
|
4373
4908
|
* <p>Determines the label configuration for the maximum value in a visual.</p>
|
|
4374
4909
|
*/
|
|
4375
4910
|
MaximumLabelType?: MaximumLabelType;
|
|
@@ -4421,42 +4956,52 @@ export type DataLabelPosition = (typeof DataLabelPosition)[keyof typeof DataLabe
|
|
|
4421
4956
|
*/
|
|
4422
4957
|
export interface DataLabelOptions {
|
|
4423
4958
|
/**
|
|
4959
|
+
* @public
|
|
4424
4960
|
* <p>Determines the visibility of the data labels.</p>
|
|
4425
4961
|
*/
|
|
4426
4962
|
Visibility?: Visibility | string;
|
|
4427
4963
|
/**
|
|
4964
|
+
* @public
|
|
4428
4965
|
* <p>Determines the visibility of the category field labels.</p>
|
|
4429
4966
|
*/
|
|
4430
4967
|
CategoryLabelVisibility?: Visibility | string;
|
|
4431
4968
|
/**
|
|
4969
|
+
* @public
|
|
4432
4970
|
* <p>Determines the visibility of the measure field labels.</p>
|
|
4433
4971
|
*/
|
|
4434
4972
|
MeasureLabelVisibility?: Visibility | string;
|
|
4435
4973
|
/**
|
|
4974
|
+
* @public
|
|
4436
4975
|
* <p>The option that determines the data label type.</p>
|
|
4437
4976
|
*/
|
|
4438
4977
|
DataLabelTypes?: DataLabelType[];
|
|
4439
4978
|
/**
|
|
4979
|
+
* @public
|
|
4440
4980
|
* <p>Determines the position of the data labels.</p>
|
|
4441
4981
|
*/
|
|
4442
4982
|
Position?: DataLabelPosition | string;
|
|
4443
4983
|
/**
|
|
4984
|
+
* @public
|
|
4444
4985
|
* <p>Determines the content of the data labels.</p>
|
|
4445
4986
|
*/
|
|
4446
4987
|
LabelContent?: DataLabelContent | string;
|
|
4447
4988
|
/**
|
|
4989
|
+
* @public
|
|
4448
4990
|
* <p>Determines the font configuration of the data labels.</p>
|
|
4449
4991
|
*/
|
|
4450
4992
|
LabelFontConfiguration?: FontConfiguration;
|
|
4451
4993
|
/**
|
|
4994
|
+
* @public
|
|
4452
4995
|
* <p>Determines the color of the data labels.</p>
|
|
4453
4996
|
*/
|
|
4454
4997
|
LabelColor?: string;
|
|
4455
4998
|
/**
|
|
4999
|
+
* @public
|
|
4456
5000
|
* <p>Determines whether overlap is enabled or disabled for the data labels.</p>
|
|
4457
5001
|
*/
|
|
4458
5002
|
Overlap?: DataLabelOverlap | string;
|
|
4459
5003
|
/**
|
|
5004
|
+
* @public
|
|
4460
5005
|
* <p>Determines the visibility of the total.</p>
|
|
4461
5006
|
*/
|
|
4462
5007
|
TotalsVisibility?: Visibility | string;
|
|
@@ -4467,18 +5012,22 @@ export interface DataLabelOptions {
|
|
|
4467
5012
|
*/
|
|
4468
5013
|
export interface CategoricalDimensionField {
|
|
4469
5014
|
/**
|
|
5015
|
+
* @public
|
|
4470
5016
|
* <p>The custom field ID.</p>
|
|
4471
5017
|
*/
|
|
4472
5018
|
FieldId: string | undefined;
|
|
4473
5019
|
/**
|
|
5020
|
+
* @public
|
|
4474
5021
|
* <p>The column that is used in the <code>CategoricalDimensionField</code>.</p>
|
|
4475
5022
|
*/
|
|
4476
5023
|
Column: ColumnIdentifier | undefined;
|
|
4477
5024
|
/**
|
|
5025
|
+
* @public
|
|
4478
5026
|
* <p>The custom hierarchy ID.</p>
|
|
4479
5027
|
*/
|
|
4480
5028
|
HierarchyId?: string;
|
|
4481
5029
|
/**
|
|
5030
|
+
* @public
|
|
4482
5031
|
* <p>The format configuration of the field.</p>
|
|
4483
5032
|
*/
|
|
4484
5033
|
FormatConfiguration?: StringFormatConfiguration;
|
|
@@ -4489,14 +5038,17 @@ export interface CategoricalDimensionField {
|
|
|
4489
5038
|
*/
|
|
4490
5039
|
export interface DateDimensionField {
|
|
4491
5040
|
/**
|
|
5041
|
+
* @public
|
|
4492
5042
|
* <p>The custom field ID.</p>
|
|
4493
5043
|
*/
|
|
4494
5044
|
FieldId: string | undefined;
|
|
4495
5045
|
/**
|
|
5046
|
+
* @public
|
|
4496
5047
|
* <p>The column that is used in the <code>DateDimensionField</code>.</p>
|
|
4497
5048
|
*/
|
|
4498
5049
|
Column: ColumnIdentifier | undefined;
|
|
4499
5050
|
/**
|
|
5051
|
+
* @public
|
|
4500
5052
|
* <p>The date granularity of the <code>DateDimensionField</code>. Choose one of the following options:</p>
|
|
4501
5053
|
* <ul>
|
|
4502
5054
|
* <li>
|
|
@@ -4548,10 +5100,12 @@ export interface DateDimensionField {
|
|
|
4548
5100
|
*/
|
|
4549
5101
|
DateGranularity?: TimeGranularity | string;
|
|
4550
5102
|
/**
|
|
5103
|
+
* @public
|
|
4551
5104
|
* <p>The custom hierarchy ID.</p>
|
|
4552
5105
|
*/
|
|
4553
5106
|
HierarchyId?: string;
|
|
4554
5107
|
/**
|
|
5108
|
+
* @public
|
|
4555
5109
|
* <p>The format configuration of the field.</p>
|
|
4556
5110
|
*/
|
|
4557
5111
|
FormatConfiguration?: DateTimeFormatConfiguration;
|
|
@@ -4562,18 +5116,22 @@ export interface DateDimensionField {
|
|
|
4562
5116
|
*/
|
|
4563
5117
|
export interface NumericalDimensionField {
|
|
4564
5118
|
/**
|
|
5119
|
+
* @public
|
|
4565
5120
|
* <p>The custom field ID.</p>
|
|
4566
5121
|
*/
|
|
4567
5122
|
FieldId: string | undefined;
|
|
4568
5123
|
/**
|
|
5124
|
+
* @public
|
|
4569
5125
|
* <p>The column that is used in the <code>NumericalDimensionField</code>.</p>
|
|
4570
5126
|
*/
|
|
4571
5127
|
Column: ColumnIdentifier | undefined;
|
|
4572
5128
|
/**
|
|
5129
|
+
* @public
|
|
4573
5130
|
* <p>The custom hierarchy ID.</p>
|
|
4574
5131
|
*/
|
|
4575
5132
|
HierarchyId?: string;
|
|
4576
5133
|
/**
|
|
5134
|
+
* @public
|
|
4577
5135
|
* <p>The format configuration of the field.</p>
|
|
4578
5136
|
*/
|
|
4579
5137
|
FormatConfiguration?: NumberFormatConfiguration;
|
|
@@ -4584,14 +5142,17 @@ export interface NumericalDimensionField {
|
|
|
4584
5142
|
*/
|
|
4585
5143
|
export interface DimensionField {
|
|
4586
5144
|
/**
|
|
5145
|
+
* @public
|
|
4587
5146
|
* <p>The dimension type field with numerical type columns.</p>
|
|
4588
5147
|
*/
|
|
4589
5148
|
NumericalDimensionField?: NumericalDimensionField;
|
|
4590
5149
|
/**
|
|
5150
|
+
* @public
|
|
4591
5151
|
* <p>The dimension type field with categorical type columns.</p>
|
|
4592
5152
|
*/
|
|
4593
5153
|
CategoricalDimensionField?: CategoricalDimensionField;
|
|
4594
5154
|
/**
|
|
5155
|
+
* @public
|
|
4595
5156
|
* <p>The dimension type field with date type columns.</p>
|
|
4596
5157
|
*/
|
|
4597
5158
|
DateDimensionField?: DateDimensionField;
|
|
@@ -4602,10 +5163,12 @@ export interface DimensionField {
|
|
|
4602
5163
|
*/
|
|
4603
5164
|
export interface CalculatedMeasureField {
|
|
4604
5165
|
/**
|
|
5166
|
+
* @public
|
|
4605
5167
|
* <p>The custom field ID.</p>
|
|
4606
5168
|
*/
|
|
4607
5169
|
FieldId: string | undefined;
|
|
4608
5170
|
/**
|
|
5171
|
+
* @public
|
|
4609
5172
|
* <p>The expression in the table calculation.</p>
|
|
4610
5173
|
*/
|
|
4611
5174
|
Expression: string | undefined;
|
|
@@ -4616,18 +5179,22 @@ export interface CalculatedMeasureField {
|
|
|
4616
5179
|
*/
|
|
4617
5180
|
export interface CategoricalMeasureField {
|
|
4618
5181
|
/**
|
|
5182
|
+
* @public
|
|
4619
5183
|
* <p>The custom field ID.</p>
|
|
4620
5184
|
*/
|
|
4621
5185
|
FieldId: string | undefined;
|
|
4622
5186
|
/**
|
|
5187
|
+
* @public
|
|
4623
5188
|
* <p>The column that is used in the <code>CategoricalMeasureField</code>.</p>
|
|
4624
5189
|
*/
|
|
4625
5190
|
Column: ColumnIdentifier | undefined;
|
|
4626
5191
|
/**
|
|
5192
|
+
* @public
|
|
4627
5193
|
* <p>The aggregation function of the measure field.</p>
|
|
4628
5194
|
*/
|
|
4629
5195
|
AggregationFunction?: CategoricalAggregationFunction | string;
|
|
4630
5196
|
/**
|
|
5197
|
+
* @public
|
|
4631
5198
|
* <p>The format configuration of the field.</p>
|
|
4632
5199
|
*/
|
|
4633
5200
|
FormatConfiguration?: StringFormatConfiguration;
|
|
@@ -4638,18 +5205,22 @@ export interface CategoricalMeasureField {
|
|
|
4638
5205
|
*/
|
|
4639
5206
|
export interface DateMeasureField {
|
|
4640
5207
|
/**
|
|
5208
|
+
* @public
|
|
4641
5209
|
* <p>The custom field ID.</p>
|
|
4642
5210
|
*/
|
|
4643
5211
|
FieldId: string | undefined;
|
|
4644
5212
|
/**
|
|
5213
|
+
* @public
|
|
4645
5214
|
* <p>The column that is used in the <code>DateMeasureField</code>.</p>
|
|
4646
5215
|
*/
|
|
4647
5216
|
Column: ColumnIdentifier | undefined;
|
|
4648
5217
|
/**
|
|
5218
|
+
* @public
|
|
4649
5219
|
* <p>The aggregation function of the measure field.</p>
|
|
4650
5220
|
*/
|
|
4651
5221
|
AggregationFunction?: DateAggregationFunction | string;
|
|
4652
5222
|
/**
|
|
5223
|
+
* @public
|
|
4653
5224
|
* <p>The format configuration of the field.</p>
|
|
4654
5225
|
*/
|
|
4655
5226
|
FormatConfiguration?: DateTimeFormatConfiguration;
|
|
@@ -4660,18 +5231,22 @@ export interface DateMeasureField {
|
|
|
4660
5231
|
*/
|
|
4661
5232
|
export interface NumericalMeasureField {
|
|
4662
5233
|
/**
|
|
5234
|
+
* @public
|
|
4663
5235
|
* <p>The custom field ID.</p>
|
|
4664
5236
|
*/
|
|
4665
5237
|
FieldId: string | undefined;
|
|
4666
5238
|
/**
|
|
5239
|
+
* @public
|
|
4667
5240
|
* <p>The column that is used in the <code>NumericalMeasureField</code>.</p>
|
|
4668
5241
|
*/
|
|
4669
5242
|
Column: ColumnIdentifier | undefined;
|
|
4670
5243
|
/**
|
|
5244
|
+
* @public
|
|
4671
5245
|
* <p>The aggregation function of the measure field.</p>
|
|
4672
5246
|
*/
|
|
4673
5247
|
AggregationFunction?: NumericalAggregationFunction;
|
|
4674
5248
|
/**
|
|
5249
|
+
* @public
|
|
4675
5250
|
* <p>The format configuration of the field.</p>
|
|
4676
5251
|
*/
|
|
4677
5252
|
FormatConfiguration?: NumberFormatConfiguration;
|
|
@@ -4682,18 +5257,22 @@ export interface NumericalMeasureField {
|
|
|
4682
5257
|
*/
|
|
4683
5258
|
export interface MeasureField {
|
|
4684
5259
|
/**
|
|
5260
|
+
* @public
|
|
4685
5261
|
* <p>The measure type field with numerical type columns.</p>
|
|
4686
5262
|
*/
|
|
4687
5263
|
NumericalMeasureField?: NumericalMeasureField;
|
|
4688
5264
|
/**
|
|
5265
|
+
* @public
|
|
4689
5266
|
* <p>The measure type field with categorical type columns.</p>
|
|
4690
5267
|
*/
|
|
4691
5268
|
CategoricalMeasureField?: CategoricalMeasureField;
|
|
4692
5269
|
/**
|
|
5270
|
+
* @public
|
|
4693
5271
|
* <p>The measure type field with date type columns.</p>
|
|
4694
5272
|
*/
|
|
4695
5273
|
DateMeasureField?: DateMeasureField;
|
|
4696
5274
|
/**
|
|
5275
|
+
* @public
|
|
4697
5276
|
* <p>The calculated measure field only used in pivot tables.</p>
|
|
4698
5277
|
*/
|
|
4699
5278
|
CalculatedMeasureField?: CalculatedMeasureField;
|
|
@@ -4704,19 +5283,23 @@ export interface MeasureField {
|
|
|
4704
5283
|
*/
|
|
4705
5284
|
export interface BarChartAggregatedFieldWells {
|
|
4706
5285
|
/**
|
|
5286
|
+
* @public
|
|
4707
5287
|
* <p>The category (y-axis) field well of a bar chart.</p>
|
|
4708
5288
|
*/
|
|
4709
5289
|
Category?: DimensionField[];
|
|
4710
5290
|
/**
|
|
5291
|
+
* @public
|
|
4711
5292
|
* <p>The value field wells of a bar chart. Values are aggregated by
|
|
4712
5293
|
* category.</p>
|
|
4713
5294
|
*/
|
|
4714
5295
|
Values?: MeasureField[];
|
|
4715
5296
|
/**
|
|
5297
|
+
* @public
|
|
4716
5298
|
* <p>The color (group/color) field well of a bar chart.</p>
|
|
4717
5299
|
*/
|
|
4718
5300
|
Colors?: DimensionField[];
|
|
4719
5301
|
/**
|
|
5302
|
+
* @public
|
|
4720
5303
|
* <p>The small multiples field well of a bar chart.</p>
|
|
4721
5304
|
*/
|
|
4722
5305
|
SmallMultiples?: DimensionField[];
|
|
@@ -4728,6 +5311,7 @@ export interface BarChartAggregatedFieldWells {
|
|
|
4728
5311
|
*/
|
|
4729
5312
|
export interface BarChartFieldWells {
|
|
4730
5313
|
/**
|
|
5314
|
+
* @public
|
|
4731
5315
|
* <p>The aggregated field wells of a bar chart.</p>
|
|
4732
5316
|
*/
|
|
4733
5317
|
BarChartAggregatedFieldWells?: BarChartAggregatedFieldWells;
|
|
@@ -4752,14 +5336,17 @@ export type LegendPosition = (typeof LegendPosition)[keyof typeof LegendPosition
|
|
|
4752
5336
|
*/
|
|
4753
5337
|
export interface LegendOptions {
|
|
4754
5338
|
/**
|
|
5339
|
+
* @public
|
|
4755
5340
|
* <p>Determines whether or not the legend is visible.</p>
|
|
4756
5341
|
*/
|
|
4757
5342
|
Visibility?: Visibility | string;
|
|
4758
5343
|
/**
|
|
5344
|
+
* @public
|
|
4759
5345
|
* <p>The custom title for the legend.</p>
|
|
4760
5346
|
*/
|
|
4761
5347
|
Title?: LabelOptions;
|
|
4762
5348
|
/**
|
|
5349
|
+
* @public
|
|
4763
5350
|
* <p>The positions for the legend. Choose one of the following
|
|
4764
5351
|
* options:</p>
|
|
4765
5352
|
* <ul>
|
|
@@ -4787,10 +5374,12 @@ export interface LegendOptions {
|
|
|
4787
5374
|
*/
|
|
4788
5375
|
Position?: LegendPosition | string;
|
|
4789
5376
|
/**
|
|
5377
|
+
* @public
|
|
4790
5378
|
* <p>The width of the legend. If this value is omitted, a default width is used when rendering.</p>
|
|
4791
5379
|
*/
|
|
4792
5380
|
Width?: string;
|
|
4793
5381
|
/**
|
|
5382
|
+
* @public
|
|
4794
5383
|
* <p>The height of the legend. If this value is omitted, a default height is used when
|
|
4795
5384
|
* rendering.</p>
|
|
4796
5385
|
*/
|
|
@@ -4826,14 +5415,17 @@ export type AxisBinding = (typeof AxisBinding)[keyof typeof AxisBinding];
|
|
|
4826
5415
|
*/
|
|
4827
5416
|
export interface ReferenceLineDynamicDataConfiguration {
|
|
4828
5417
|
/**
|
|
5418
|
+
* @public
|
|
4829
5419
|
* <p>The column that the dynamic data targets.</p>
|
|
4830
5420
|
*/
|
|
4831
5421
|
Column: ColumnIdentifier | undefined;
|
|
4832
5422
|
/**
|
|
5423
|
+
* @public
|
|
4833
5424
|
* <p>The aggregation function that is used in the dynamic data.</p>
|
|
4834
5425
|
*/
|
|
4835
5426
|
MeasureAggregationFunction?: AggregationFunction;
|
|
4836
5427
|
/**
|
|
5428
|
+
* @public
|
|
4837
5429
|
* <p>The calculation that is used in the dynamic data.</p>
|
|
4838
5430
|
*/
|
|
4839
5431
|
Calculation: NumericalAggregationFunction | undefined;
|
|
@@ -4844,6 +5436,7 @@ export interface ReferenceLineDynamicDataConfiguration {
|
|
|
4844
5436
|
*/
|
|
4845
5437
|
export interface ReferenceLineStaticDataConfiguration {
|
|
4846
5438
|
/**
|
|
5439
|
+
* @public
|
|
4847
5440
|
* <p>The double input of the static data.</p>
|
|
4848
5441
|
*/
|
|
4849
5442
|
Value: number | undefined;
|
|
@@ -4854,15 +5447,18 @@ export interface ReferenceLineStaticDataConfiguration {
|
|
|
4854
5447
|
*/
|
|
4855
5448
|
export interface ReferenceLineDataConfiguration {
|
|
4856
5449
|
/**
|
|
5450
|
+
* @public
|
|
4857
5451
|
* <p>The static data configuration of the reference line data
|
|
4858
5452
|
* configuration.</p>
|
|
4859
5453
|
*/
|
|
4860
5454
|
StaticConfiguration?: ReferenceLineStaticDataConfiguration;
|
|
4861
5455
|
/**
|
|
5456
|
+
* @public
|
|
4862
5457
|
* <p>The dynamic configuration of the reference line data configuration.</p>
|
|
4863
5458
|
*/
|
|
4864
5459
|
DynamicConfiguration?: ReferenceLineDynamicDataConfiguration;
|
|
4865
5460
|
/**
|
|
5461
|
+
* @public
|
|
4866
5462
|
* <p>The axis binding type of the reference line. Choose one of the following options:</p>
|
|
4867
5463
|
* <ul>
|
|
4868
5464
|
* <li>
|
|
@@ -4881,6 +5477,7 @@ export interface ReferenceLineDataConfiguration {
|
|
|
4881
5477
|
*/
|
|
4882
5478
|
export interface ReferenceLineCustomLabelConfiguration {
|
|
4883
5479
|
/**
|
|
5480
|
+
* @public
|
|
4884
5481
|
* <p>The string text of the custom label.</p>
|
|
4885
5482
|
*/
|
|
4886
5483
|
CustomLabel: string | undefined;
|
|
@@ -4916,6 +5513,7 @@ export type ReferenceLineValueLabelRelativePosition = (typeof ReferenceLineValue
|
|
|
4916
5513
|
*/
|
|
4917
5514
|
export interface ReferenceLineValueLabelConfiguration {
|
|
4918
5515
|
/**
|
|
5516
|
+
* @public
|
|
4919
5517
|
* <p>The relative position of the value label. Choose one of the following options:</p>
|
|
4920
5518
|
* <ul>
|
|
4921
5519
|
* <li>
|
|
@@ -4932,6 +5530,7 @@ export interface ReferenceLineValueLabelConfiguration {
|
|
|
4932
5530
|
*/
|
|
4933
5531
|
RelativePosition?: ReferenceLineValueLabelRelativePosition | string;
|
|
4934
5532
|
/**
|
|
5533
|
+
* @public
|
|
4935
5534
|
* <p>The format configuration of the value label.</p>
|
|
4936
5535
|
*/
|
|
4937
5536
|
FormatConfiguration?: NumericFormatConfiguration;
|
|
@@ -4954,22 +5553,27 @@ export type ReferenceLineLabelVerticalPosition = (typeof ReferenceLineLabelVerti
|
|
|
4954
5553
|
*/
|
|
4955
5554
|
export interface ReferenceLineLabelConfiguration {
|
|
4956
5555
|
/**
|
|
5556
|
+
* @public
|
|
4957
5557
|
* <p>The value label configuration of the label in a reference line.</p>
|
|
4958
5558
|
*/
|
|
4959
5559
|
ValueLabelConfiguration?: ReferenceLineValueLabelConfiguration;
|
|
4960
5560
|
/**
|
|
5561
|
+
* @public
|
|
4961
5562
|
* <p>The custom label configuration of the label in a reference line.</p>
|
|
4962
5563
|
*/
|
|
4963
5564
|
CustomLabelConfiguration?: ReferenceLineCustomLabelConfiguration;
|
|
4964
5565
|
/**
|
|
5566
|
+
* @public
|
|
4965
5567
|
* <p>The font configuration of the label in a reference line.</p>
|
|
4966
5568
|
*/
|
|
4967
5569
|
FontConfiguration?: FontConfiguration;
|
|
4968
5570
|
/**
|
|
5571
|
+
* @public
|
|
4969
5572
|
* <p>The font color configuration of the label in a reference line.</p>
|
|
4970
5573
|
*/
|
|
4971
5574
|
FontColor?: string;
|
|
4972
5575
|
/**
|
|
5576
|
+
* @public
|
|
4973
5577
|
* <p>The horizontal position configuration of the label in a reference line. Choose one of
|
|
4974
5578
|
* the following options:</p>
|
|
4975
5579
|
* <ul>
|
|
@@ -4992,6 +5596,7 @@ export interface ReferenceLineLabelConfiguration {
|
|
|
4992
5596
|
*/
|
|
4993
5597
|
HorizontalPosition?: ReferenceLineLabelHorizontalPosition | string;
|
|
4994
5598
|
/**
|
|
5599
|
+
* @public
|
|
4995
5600
|
* <p>The vertical position configuration of the label in a reference line. Choose one of the following options:</p>
|
|
4996
5601
|
* <ul>
|
|
4997
5602
|
* <li>
|
|
@@ -5028,6 +5633,7 @@ export type ReferenceLinePatternType = (typeof ReferenceLinePatternType)[keyof t
|
|
|
5028
5633
|
*/
|
|
5029
5634
|
export interface ReferenceLineStyleConfiguration {
|
|
5030
5635
|
/**
|
|
5636
|
+
* @public
|
|
5031
5637
|
* <p>The pattern type of the line style. Choose one of the following options:</p>
|
|
5032
5638
|
* <ul>
|
|
5033
5639
|
* <li>
|
|
@@ -5049,6 +5655,7 @@ export interface ReferenceLineStyleConfiguration {
|
|
|
5049
5655
|
*/
|
|
5050
5656
|
Pattern?: ReferenceLinePatternType | string;
|
|
5051
5657
|
/**
|
|
5658
|
+
* @public
|
|
5052
5659
|
* <p>The hex color of the reference line.</p>
|
|
5053
5660
|
*/
|
|
5054
5661
|
Color?: string;
|
|
@@ -5059,6 +5666,7 @@ export interface ReferenceLineStyleConfiguration {
|
|
|
5059
5666
|
*/
|
|
5060
5667
|
export interface ReferenceLine {
|
|
5061
5668
|
/**
|
|
5669
|
+
* @public
|
|
5062
5670
|
* <p>The status of the reference line. Choose one of the following options:</p>
|
|
5063
5671
|
* <ul>
|
|
5064
5672
|
* <li>
|
|
@@ -5075,14 +5683,17 @@ export interface ReferenceLine {
|
|
|
5075
5683
|
*/
|
|
5076
5684
|
Status?: WidgetStatus | string;
|
|
5077
5685
|
/**
|
|
5686
|
+
* @public
|
|
5078
5687
|
* <p>The data configuration of the reference line.</p>
|
|
5079
5688
|
*/
|
|
5080
5689
|
DataConfiguration: ReferenceLineDataConfiguration | undefined;
|
|
5081
5690
|
/**
|
|
5691
|
+
* @public
|
|
5082
5692
|
* <p>The style configuration of the reference line.</p>
|
|
5083
5693
|
*/
|
|
5084
5694
|
StyleConfiguration?: ReferenceLineStyleConfiguration;
|
|
5085
5695
|
/**
|
|
5696
|
+
* @public
|
|
5086
5697
|
* <p>The label configuration of the reference line.</p>
|
|
5087
5698
|
*/
|
|
5088
5699
|
LabelConfiguration?: ReferenceLineLabelConfiguration;
|
|
@@ -5121,14 +5732,17 @@ export type HorizontalTextAlignment = (typeof HorizontalTextAlignment)[keyof typ
|
|
|
5121
5732
|
*/
|
|
5122
5733
|
export interface PanelTitleOptions {
|
|
5123
5734
|
/**
|
|
5735
|
+
* @public
|
|
5124
5736
|
* <p>Determines whether or not panel titles are displayed.</p>
|
|
5125
5737
|
*/
|
|
5126
5738
|
Visibility?: Visibility | string;
|
|
5127
5739
|
/**
|
|
5740
|
+
* @public
|
|
5128
5741
|
* <p>Configures the display properties of the given text.</p>
|
|
5129
5742
|
*/
|
|
5130
5743
|
FontConfiguration?: FontConfiguration;
|
|
5131
5744
|
/**
|
|
5745
|
+
* @public
|
|
5132
5746
|
* <p>Sets the horizontal text alignment of the title within each panel.</p>
|
|
5133
5747
|
*/
|
|
5134
5748
|
HorizontalTextAlignment?: HorizontalTextAlignment | string;
|
|
@@ -5139,38 +5753,47 @@ export interface PanelTitleOptions {
|
|
|
5139
5753
|
*/
|
|
5140
5754
|
export interface PanelConfiguration {
|
|
5141
5755
|
/**
|
|
5756
|
+
* @public
|
|
5142
5757
|
* <p>Configures the title display within each small multiples panel.</p>
|
|
5143
5758
|
*/
|
|
5144
5759
|
Title?: PanelTitleOptions;
|
|
5145
5760
|
/**
|
|
5761
|
+
* @public
|
|
5146
5762
|
* <p>Determines whether or not each panel displays a border.</p>
|
|
5147
5763
|
*/
|
|
5148
5764
|
BorderVisibility?: Visibility | string;
|
|
5149
5765
|
/**
|
|
5766
|
+
* @public
|
|
5150
5767
|
* <p>Sets the line thickness of panel borders.</p>
|
|
5151
5768
|
*/
|
|
5152
5769
|
BorderThickness?: string;
|
|
5153
5770
|
/**
|
|
5771
|
+
* @public
|
|
5154
5772
|
* <p>Sets the line style of panel borders.</p>
|
|
5155
5773
|
*/
|
|
5156
5774
|
BorderStyle?: PanelBorderStyle | string;
|
|
5157
5775
|
/**
|
|
5776
|
+
* @public
|
|
5158
5777
|
* <p>Sets the line color of panel borders.</p>
|
|
5159
5778
|
*/
|
|
5160
5779
|
BorderColor?: string;
|
|
5161
5780
|
/**
|
|
5781
|
+
* @public
|
|
5162
5782
|
* <p>Determines whether or not negative space between sibling panels is rendered.</p>
|
|
5163
5783
|
*/
|
|
5164
5784
|
GutterVisibility?: Visibility | string;
|
|
5165
5785
|
/**
|
|
5786
|
+
* @public
|
|
5166
5787
|
* <p>Sets the total amount of negative space to display between sibling panels.</p>
|
|
5167
5788
|
*/
|
|
5168
5789
|
GutterSpacing?: string;
|
|
5169
5790
|
/**
|
|
5791
|
+
* @public
|
|
5170
5792
|
* <p>Determines whether or not a background for each small multiples panel is rendered.</p>
|
|
5171
5793
|
*/
|
|
5172
5794
|
BackgroundVisibility?: Visibility | string;
|
|
5173
5795
|
/**
|
|
5796
|
+
* @public
|
|
5174
5797
|
* <p>Sets the background color for each panel.</p>
|
|
5175
5798
|
*/
|
|
5176
5799
|
BackgroundColor?: string;
|
|
@@ -5205,10 +5828,12 @@ export type SmallMultiplesAxisScale = (typeof SmallMultiplesAxisScale)[keyof typ
|
|
|
5205
5828
|
*/
|
|
5206
5829
|
export interface SmallMultiplesAxisProperties {
|
|
5207
5830
|
/**
|
|
5831
|
+
* @public
|
|
5208
5832
|
* <p>Determines whether scale of the axes are shared or independent. The default value is <code>SHARED</code>.</p>
|
|
5209
5833
|
*/
|
|
5210
5834
|
Scale?: SmallMultiplesAxisScale | string;
|
|
5211
5835
|
/**
|
|
5836
|
+
* @public
|
|
5212
5837
|
* <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>
|
|
5213
5838
|
*/
|
|
5214
5839
|
Placement?: SmallMultiplesAxisPlacement | string;
|
|
@@ -5219,6 +5844,7 @@ export interface SmallMultiplesAxisProperties {
|
|
|
5219
5844
|
*/
|
|
5220
5845
|
export interface SmallMultiplesOptions {
|
|
5221
5846
|
/**
|
|
5847
|
+
* @public
|
|
5222
5848
|
* <p>Sets the maximum number of visible rows to display in the grid of small multiples panels.</p>
|
|
5223
5849
|
* <p>The default value is <code>Auto</code>,
|
|
5224
5850
|
* which automatically adjusts the rows in the grid
|
|
@@ -5226,19 +5852,23 @@ export interface SmallMultiplesOptions {
|
|
|
5226
5852
|
*/
|
|
5227
5853
|
MaxVisibleRows?: number;
|
|
5228
5854
|
/**
|
|
5855
|
+
* @public
|
|
5229
5856
|
* <p>Sets the maximum number of visible columns to display in the grid of small multiples panels.</p>
|
|
5230
5857
|
* <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>
|
|
5231
5858
|
*/
|
|
5232
5859
|
MaxVisibleColumns?: number;
|
|
5233
5860
|
/**
|
|
5861
|
+
* @public
|
|
5234
5862
|
* <p>Configures the display options for each small multiples panel.</p>
|
|
5235
5863
|
*/
|
|
5236
5864
|
PanelConfiguration?: PanelConfiguration;
|
|
5237
5865
|
/**
|
|
5866
|
+
* @public
|
|
5238
5867
|
* <p>The properties of a small multiples X axis.</p>
|
|
5239
5868
|
*/
|
|
5240
5869
|
XAxis?: SmallMultiplesAxisProperties;
|
|
5241
5870
|
/**
|
|
5871
|
+
* @public
|
|
5242
5872
|
* <p>The properties of a small multiples Y axis.</p>
|
|
5243
5873
|
*/
|
|
5244
5874
|
YAxis?: SmallMultiplesAxisProperties;
|
|
@@ -5261,11 +5891,13 @@ export type OtherCategories = (typeof OtherCategories)[keyof typeof OtherCategor
|
|
|
5261
5891
|
*/
|
|
5262
5892
|
export interface ItemsLimitConfiguration {
|
|
5263
5893
|
/**
|
|
5894
|
+
* @public
|
|
5264
5895
|
* <p>The limit on how many items of a field are showed in the chart. For
|
|
5265
5896
|
* example, the number of slices that are displayed in a pie chart.</p>
|
|
5266
5897
|
*/
|
|
5267
5898
|
ItemsLimit?: number;
|
|
5268
5899
|
/**
|
|
5900
|
+
* @public
|
|
5269
5901
|
* <p>The <code>Show
|
|
5270
5902
|
* other</code> of an axis in the chart. Choose one of the following options:</p>
|
|
5271
5903
|
* <ul>
|
|
@@ -5289,14 +5921,17 @@ export interface ItemsLimitConfiguration {
|
|
|
5289
5921
|
*/
|
|
5290
5922
|
export interface ColumnSort {
|
|
5291
5923
|
/**
|
|
5924
|
+
* @public
|
|
5292
5925
|
* <p>A column of a data set.</p>
|
|
5293
5926
|
*/
|
|
5294
5927
|
SortBy: ColumnIdentifier | undefined;
|
|
5295
5928
|
/**
|
|
5929
|
+
* @public
|
|
5296
5930
|
* <p>The sort direction.</p>
|
|
5297
5931
|
*/
|
|
5298
5932
|
Direction: SortDirection | string | undefined;
|
|
5299
5933
|
/**
|
|
5934
|
+
* @public
|
|
5300
5935
|
* <p>The aggregation function that is defined in the column sort.</p>
|
|
5301
5936
|
*/
|
|
5302
5937
|
AggregationFunction?: AggregationFunction;
|
|
@@ -5308,10 +5943,12 @@ export interface ColumnSort {
|
|
|
5308
5943
|
*/
|
|
5309
5944
|
export interface FieldSort {
|
|
5310
5945
|
/**
|
|
5946
|
+
* @public
|
|
5311
5947
|
* <p>The sort configuration target field.</p>
|
|
5312
5948
|
*/
|
|
5313
5949
|
FieldId: string | undefined;
|
|
5314
5950
|
/**
|
|
5951
|
+
* @public
|
|
5315
5952
|
* <p>The sort direction. Choose one of the following
|
|
5316
5953
|
* options:</p>
|
|
5317
5954
|
* <ul>
|
|
@@ -5333,10 +5970,12 @@ export interface FieldSort {
|
|
|
5333
5970
|
*/
|
|
5334
5971
|
export interface FieldSortOptions {
|
|
5335
5972
|
/**
|
|
5973
|
+
* @public
|
|
5336
5974
|
* <p>The sort configuration for a field in a field well.</p>
|
|
5337
5975
|
*/
|
|
5338
5976
|
FieldSort?: FieldSort;
|
|
5339
5977
|
/**
|
|
5978
|
+
* @public
|
|
5340
5979
|
* <p>The sort configuration for a column that is not used in a field well.</p>
|
|
5341
5980
|
*/
|
|
5342
5981
|
ColumnSort?: ColumnSort;
|
|
@@ -5347,26 +5986,32 @@ export interface FieldSortOptions {
|
|
|
5347
5986
|
*/
|
|
5348
5987
|
export interface BarChartSortConfiguration {
|
|
5349
5988
|
/**
|
|
5989
|
+
* @public
|
|
5350
5990
|
* <p>The sort configuration of category fields.</p>
|
|
5351
5991
|
*/
|
|
5352
5992
|
CategorySort?: FieldSortOptions[];
|
|
5353
5993
|
/**
|
|
5994
|
+
* @public
|
|
5354
5995
|
* <p>The limit on the number of categories displayed in a bar chart.</p>
|
|
5355
5996
|
*/
|
|
5356
5997
|
CategoryItemsLimit?: ItemsLimitConfiguration;
|
|
5357
5998
|
/**
|
|
5999
|
+
* @public
|
|
5358
6000
|
* <p>The sort configuration of color fields in a bar chart.</p>
|
|
5359
6001
|
*/
|
|
5360
6002
|
ColorSort?: FieldSortOptions[];
|
|
5361
6003
|
/**
|
|
6004
|
+
* @public
|
|
5362
6005
|
* <p>The limit on the number of values displayed in a bar chart.</p>
|
|
5363
6006
|
*/
|
|
5364
6007
|
ColorItemsLimit?: ItemsLimitConfiguration;
|
|
5365
6008
|
/**
|
|
6009
|
+
* @public
|
|
5366
6010
|
* <p>The sort configuration of the small multiples field.</p>
|
|
5367
6011
|
*/
|
|
5368
6012
|
SmallMultiplesSort?: FieldSortOptions[];
|
|
5369
6013
|
/**
|
|
6014
|
+
* @public
|
|
5370
6015
|
* <p>The limit on the number of small multiples panels that are displayed.</p>
|
|
5371
6016
|
*/
|
|
5372
6017
|
SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
|
|
@@ -5377,18 +6022,22 @@ export interface BarChartSortConfiguration {
|
|
|
5377
6022
|
*/
|
|
5378
6023
|
export interface ColumnTooltipItem {
|
|
5379
6024
|
/**
|
|
6025
|
+
* @public
|
|
5380
6026
|
* <p>The target column of the tooltip item.</p>
|
|
5381
6027
|
*/
|
|
5382
6028
|
Column: ColumnIdentifier | undefined;
|
|
5383
6029
|
/**
|
|
6030
|
+
* @public
|
|
5384
6031
|
* <p>The label of the tooltip item.</p>
|
|
5385
6032
|
*/
|
|
5386
6033
|
Label?: string;
|
|
5387
6034
|
/**
|
|
6035
|
+
* @public
|
|
5388
6036
|
* <p>The visibility of the tooltip item.</p>
|
|
5389
6037
|
*/
|
|
5390
6038
|
Visibility?: Visibility | string;
|
|
5391
6039
|
/**
|
|
6040
|
+
* @public
|
|
5392
6041
|
* <p>The aggregation function of the column tooltip item.</p>
|
|
5393
6042
|
*/
|
|
5394
6043
|
Aggregation?: AggregationFunction;
|
|
@@ -5399,14 +6048,17 @@ export interface ColumnTooltipItem {
|
|
|
5399
6048
|
*/
|
|
5400
6049
|
export interface FieldTooltipItem {
|
|
5401
6050
|
/**
|
|
6051
|
+
* @public
|
|
5402
6052
|
* <p>The unique ID of the field that is targeted by the tooltip.</p>
|
|
5403
6053
|
*/
|
|
5404
6054
|
FieldId: string | undefined;
|
|
5405
6055
|
/**
|
|
6056
|
+
* @public
|
|
5406
6057
|
* <p>The label of the tooltip item.</p>
|
|
5407
6058
|
*/
|
|
5408
6059
|
Label?: string;
|
|
5409
6060
|
/**
|
|
6061
|
+
* @public
|
|
5410
6062
|
* <p>The visibility of the tooltip item.</p>
|
|
5411
6063
|
*/
|
|
5412
6064
|
Visibility?: Visibility | string;
|
|
@@ -5418,10 +6070,12 @@ export interface FieldTooltipItem {
|
|
|
5418
6070
|
*/
|
|
5419
6071
|
export interface TooltipItem {
|
|
5420
6072
|
/**
|
|
6073
|
+
* @public
|
|
5421
6074
|
* <p>The tooltip item for the fields.</p>
|
|
5422
6075
|
*/
|
|
5423
6076
|
FieldTooltipItem?: FieldTooltipItem;
|
|
5424
6077
|
/**
|
|
6078
|
+
* @public
|
|
5425
6079
|
* <p>The tooltip item for the columns that are not part of a field well.</p>
|
|
5426
6080
|
*/
|
|
5427
6081
|
ColumnTooltipItem?: ColumnTooltipItem;
|
|
@@ -5444,10 +6098,12 @@ export type TooltipTitleType = (typeof TooltipTitleType)[keyof typeof TooltipTit
|
|
|
5444
6098
|
*/
|
|
5445
6099
|
export interface FieldBasedTooltip {
|
|
5446
6100
|
/**
|
|
6101
|
+
* @public
|
|
5447
6102
|
* <p>The visibility of <code>Show aggregations</code>.</p>
|
|
5448
6103
|
*/
|
|
5449
6104
|
AggregationVisibility?: Visibility | string;
|
|
5450
6105
|
/**
|
|
6106
|
+
* @public
|
|
5451
6107
|
* <p>The type for the >tooltip title. Choose one of the following options:</p>
|
|
5452
6108
|
* <ul>
|
|
5453
6109
|
* <li>
|
|
@@ -5462,6 +6118,7 @@ export interface FieldBasedTooltip {
|
|
|
5462
6118
|
*/
|
|
5463
6119
|
TooltipTitleType?: TooltipTitleType | string;
|
|
5464
6120
|
/**
|
|
6121
|
+
* @public
|
|
5465
6122
|
* <p>The fields configuration in the
|
|
5466
6123
|
* tooltip.</p>
|
|
5467
6124
|
*/
|
|
@@ -5485,10 +6142,12 @@ export type SelectedTooltipType = (typeof SelectedTooltipType)[keyof typeof Sele
|
|
|
5485
6142
|
*/
|
|
5486
6143
|
export interface TooltipOptions {
|
|
5487
6144
|
/**
|
|
6145
|
+
* @public
|
|
5488
6146
|
* <p>Determines whether or not the tooltip is visible.</p>
|
|
5489
6147
|
*/
|
|
5490
6148
|
TooltipVisibility?: Visibility | string;
|
|
5491
6149
|
/**
|
|
6150
|
+
* @public
|
|
5492
6151
|
* <p>The selected type for the tooltip. Choose one of the following options:</p>
|
|
5493
6152
|
* <ul>
|
|
5494
6153
|
* <li>
|
|
@@ -5503,6 +6162,7 @@ export interface TooltipOptions {
|
|
|
5503
6162
|
*/
|
|
5504
6163
|
SelectedTooltipType?: SelectedTooltipType | string;
|
|
5505
6164
|
/**
|
|
6165
|
+
* @public
|
|
5506
6166
|
* <p>The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.</p>
|
|
5507
6167
|
*/
|
|
5508
6168
|
FieldBasedTooltip?: FieldBasedTooltip;
|
|
@@ -5513,10 +6173,12 @@ export interface TooltipOptions {
|
|
|
5513
6173
|
*/
|
|
5514
6174
|
export interface DataPathValue {
|
|
5515
6175
|
/**
|
|
6176
|
+
* @public
|
|
5516
6177
|
* <p>The field ID of the field that needs to be sorted.</p>
|
|
5517
6178
|
*/
|
|
5518
6179
|
FieldId: string | undefined;
|
|
5519
6180
|
/**
|
|
6181
|
+
* @public
|
|
5520
6182
|
* <p>The actual value of the field that needs to be sorted.</p>
|
|
5521
6183
|
*/
|
|
5522
6184
|
FieldValue: string | undefined;
|
|
@@ -5527,14 +6189,17 @@ export interface DataPathValue {
|
|
|
5527
6189
|
*/
|
|
5528
6190
|
export interface DataPathColor {
|
|
5529
6191
|
/**
|
|
6192
|
+
* @public
|
|
5530
6193
|
* <p>The element that the color needs to be applied to.</p>
|
|
5531
6194
|
*/
|
|
5532
6195
|
Element: DataPathValue | undefined;
|
|
5533
6196
|
/**
|
|
6197
|
+
* @public
|
|
5534
6198
|
* <p>The color that needs to be applied to the element.</p>
|
|
5535
6199
|
*/
|
|
5536
6200
|
Color: string | undefined;
|
|
5537
6201
|
/**
|
|
6202
|
+
* @public
|
|
5538
6203
|
* <p>The time granularity of the field that the color needs to be applied to.</p>
|
|
5539
6204
|
*/
|
|
5540
6205
|
TimeGranularity?: TimeGranularity | string;
|
|
@@ -5545,10 +6210,12 @@ export interface DataPathColor {
|
|
|
5545
6210
|
*/
|
|
5546
6211
|
export interface VisualPalette {
|
|
5547
6212
|
/**
|
|
6213
|
+
* @public
|
|
5548
6214
|
* <p>The chart color options for the visual palette.</p>
|
|
5549
6215
|
*/
|
|
5550
6216
|
ChartColor?: string;
|
|
5551
6217
|
/**
|
|
6218
|
+
* @public
|
|
5552
6219
|
* <p>The color map options for the visual palette.</p>
|
|
5553
6220
|
*/
|
|
5554
6221
|
ColorMap?: DataPathColor[];
|
|
@@ -5559,14 +6226,17 @@ export interface VisualPalette {
|
|
|
5559
6226
|
*/
|
|
5560
6227
|
export interface BarChartConfiguration {
|
|
5561
6228
|
/**
|
|
6229
|
+
* @public
|
|
5562
6230
|
* <p>The field wells of the visual.</p>
|
|
5563
6231
|
*/
|
|
5564
6232
|
FieldWells?: BarChartFieldWells;
|
|
5565
6233
|
/**
|
|
6234
|
+
* @public
|
|
5566
6235
|
* <p>The sort configuration of a <code>BarChartVisual</code>.</p>
|
|
5567
6236
|
*/
|
|
5568
6237
|
SortConfiguration?: BarChartSortConfiguration;
|
|
5569
6238
|
/**
|
|
6239
|
+
* @public
|
|
5570
6240
|
* <p>The orientation of the bars in a bar chart visual. There are two valid values in this structure:</p>
|
|
5571
6241
|
* <ul>
|
|
5572
6242
|
* <li>
|
|
@@ -5581,54 +6251,67 @@ export interface BarChartConfiguration {
|
|
|
5581
6251
|
*/
|
|
5582
6252
|
Orientation?: BarChartOrientation | string;
|
|
5583
6253
|
/**
|
|
6254
|
+
* @public
|
|
5584
6255
|
* <p>Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.</p>
|
|
5585
6256
|
*/
|
|
5586
6257
|
BarsArrangement?: BarsArrangement | string;
|
|
5587
6258
|
/**
|
|
6259
|
+
* @public
|
|
5588
6260
|
* <p>The palette (chart color) display setup of the visual.</p>
|
|
5589
6261
|
*/
|
|
5590
6262
|
VisualPalette?: VisualPalette;
|
|
5591
6263
|
/**
|
|
6264
|
+
* @public
|
|
5592
6265
|
* <p>The small multiples setup for the visual.</p>
|
|
5593
6266
|
*/
|
|
5594
6267
|
SmallMultiplesOptions?: SmallMultiplesOptions;
|
|
5595
6268
|
/**
|
|
6269
|
+
* @public
|
|
5596
6270
|
* <p>The label display options (grid line, range, scale, axis step) for bar chart category.</p>
|
|
5597
6271
|
*/
|
|
5598
6272
|
CategoryAxis?: AxisDisplayOptions;
|
|
5599
6273
|
/**
|
|
6274
|
+
* @public
|
|
5600
6275
|
* <p>The label options (label text, label visibility and sort icon visibility) for a bar chart.</p>
|
|
5601
6276
|
*/
|
|
5602
6277
|
CategoryLabelOptions?: ChartAxisLabelOptions;
|
|
5603
6278
|
/**
|
|
6279
|
+
* @public
|
|
5604
6280
|
* <p>The label display options (grid line, range, scale, axis step) for a bar chart value.</p>
|
|
5605
6281
|
*/
|
|
5606
6282
|
ValueAxis?: AxisDisplayOptions;
|
|
5607
6283
|
/**
|
|
6284
|
+
* @public
|
|
5608
6285
|
* <p>The label options (label text, label visibility and sort icon visibility) for a bar chart value.</p>
|
|
5609
6286
|
*/
|
|
5610
6287
|
ValueLabelOptions?: ChartAxisLabelOptions;
|
|
5611
6288
|
/**
|
|
6289
|
+
* @public
|
|
5612
6290
|
* <p>The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.</p>
|
|
5613
6291
|
*/
|
|
5614
6292
|
ColorLabelOptions?: ChartAxisLabelOptions;
|
|
5615
6293
|
/**
|
|
6294
|
+
* @public
|
|
5616
6295
|
* <p>The legend display setup of the visual.</p>
|
|
5617
6296
|
*/
|
|
5618
6297
|
Legend?: LegendOptions;
|
|
5619
6298
|
/**
|
|
6299
|
+
* @public
|
|
5620
6300
|
* <p>The options that determine if visual data labels are displayed.</p>
|
|
5621
6301
|
*/
|
|
5622
6302
|
DataLabels?: DataLabelOptions;
|
|
5623
6303
|
/**
|
|
6304
|
+
* @public
|
|
5624
6305
|
* <p>The tooltip display setup of the visual.</p>
|
|
5625
6306
|
*/
|
|
5626
6307
|
Tooltip?: TooltipOptions;
|
|
5627
6308
|
/**
|
|
6309
|
+
* @public
|
|
5628
6310
|
* <p>The reference line setup of the visual.</p>
|
|
5629
6311
|
*/
|
|
5630
6312
|
ReferenceLines?: ReferenceLine[];
|
|
5631
6313
|
/**
|
|
6314
|
+
* @public
|
|
5632
6315
|
* <p>The contribution analysis (anomaly configuration) setup of the visual.</p>
|
|
5633
6316
|
*/
|
|
5634
6317
|
ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
|
|
@@ -5639,10 +6322,12 @@ export interface BarChartConfiguration {
|
|
|
5639
6322
|
*/
|
|
5640
6323
|
export interface CategoryDrillDownFilter {
|
|
5641
6324
|
/**
|
|
6325
|
+
* @public
|
|
5642
6326
|
* <p>The column that the filter is applied to.</p>
|
|
5643
6327
|
*/
|
|
5644
6328
|
Column: ColumnIdentifier | undefined;
|
|
5645
6329
|
/**
|
|
6330
|
+
* @public
|
|
5646
6331
|
* <p>A list of the string inputs that are the values of the category drill down filter.</p>
|
|
5647
6332
|
*/
|
|
5648
6333
|
CategoryValues: string[] | undefined;
|
|
@@ -5653,10 +6338,12 @@ export interface CategoryDrillDownFilter {
|
|
|
5653
6338
|
*/
|
|
5654
6339
|
export interface NumericEqualityDrillDownFilter {
|
|
5655
6340
|
/**
|
|
6341
|
+
* @public
|
|
5656
6342
|
* <p>The column that the filter is applied to.</p>
|
|
5657
6343
|
*/
|
|
5658
6344
|
Column: ColumnIdentifier | undefined;
|
|
5659
6345
|
/**
|
|
6346
|
+
* @public
|
|
5660
6347
|
* <p>The value of the double input numeric drill down filter.</p>
|
|
5661
6348
|
*/
|
|
5662
6349
|
Value: number | undefined;
|
|
@@ -5667,18 +6354,22 @@ export interface NumericEqualityDrillDownFilter {
|
|
|
5667
6354
|
*/
|
|
5668
6355
|
export interface TimeRangeDrillDownFilter {
|
|
5669
6356
|
/**
|
|
6357
|
+
* @public
|
|
5670
6358
|
* <p>The column that the filter is applied to.</p>
|
|
5671
6359
|
*/
|
|
5672
6360
|
Column: ColumnIdentifier | undefined;
|
|
5673
6361
|
/**
|
|
6362
|
+
* @public
|
|
5674
6363
|
* <p>The minimum value for the filter value range.</p>
|
|
5675
6364
|
*/
|
|
5676
6365
|
RangeMinimum: Date | undefined;
|
|
5677
6366
|
/**
|
|
6367
|
+
* @public
|
|
5678
6368
|
* <p>The maximum value for the filter value range.</p>
|
|
5679
6369
|
*/
|
|
5680
6370
|
RangeMaximum: Date | undefined;
|
|
5681
6371
|
/**
|
|
6372
|
+
* @public
|
|
5682
6373
|
* <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
|
|
5683
6374
|
*/
|
|
5684
6375
|
TimeGranularity: TimeGranularity | string | undefined;
|
|
@@ -5690,14 +6381,17 @@ export interface TimeRangeDrillDownFilter {
|
|
|
5690
6381
|
*/
|
|
5691
6382
|
export interface DrillDownFilter {
|
|
5692
6383
|
/**
|
|
6384
|
+
* @public
|
|
5693
6385
|
* <p>The numeric equality type drill down filter. This filter is used for number type columns.</p>
|
|
5694
6386
|
*/
|
|
5695
6387
|
NumericEqualityFilter?: NumericEqualityDrillDownFilter;
|
|
5696
6388
|
/**
|
|
6389
|
+
* @public
|
|
5697
6390
|
* <p>The category type drill down filter. This filter is used for string type columns.</p>
|
|
5698
6391
|
*/
|
|
5699
6392
|
CategoryFilter?: CategoryDrillDownFilter;
|
|
5700
6393
|
/**
|
|
6394
|
+
* @public
|
|
5701
6395
|
* <p>The time range drill down filter. This filter is used for date time columns.</p>
|
|
5702
6396
|
*/
|
|
5703
6397
|
TimeRangeFilter?: TimeRangeDrillDownFilter;
|
|
@@ -5708,10 +6402,12 @@ export interface DrillDownFilter {
|
|
|
5708
6402
|
*/
|
|
5709
6403
|
export interface DateTimeHierarchy {
|
|
5710
6404
|
/**
|
|
6405
|
+
* @public
|
|
5711
6406
|
* <p>The hierarchy ID of the <code>DateTime</code> hierarchy.</p>
|
|
5712
6407
|
*/
|
|
5713
6408
|
HierarchyId: string | undefined;
|
|
5714
6409
|
/**
|
|
6410
|
+
* @public
|
|
5715
6411
|
* <p>The option that determines the drill down filters for the
|
|
5716
6412
|
* <code>DateTime</code> hierarchy.</p>
|
|
5717
6413
|
*/
|
|
@@ -5723,14 +6419,17 @@ export interface DateTimeHierarchy {
|
|
|
5723
6419
|
*/
|
|
5724
6420
|
export interface ExplicitHierarchy {
|
|
5725
6421
|
/**
|
|
6422
|
+
* @public
|
|
5726
6423
|
* <p>The hierarchy ID of the explicit hierarchy.</p>
|
|
5727
6424
|
*/
|
|
5728
6425
|
HierarchyId: string | undefined;
|
|
5729
6426
|
/**
|
|
6427
|
+
* @public
|
|
5730
6428
|
* <p>The list of columns that define the explicit hierarchy.</p>
|
|
5731
6429
|
*/
|
|
5732
6430
|
Columns: ColumnIdentifier[] | undefined;
|
|
5733
6431
|
/**
|
|
6432
|
+
* @public
|
|
5734
6433
|
* <p>The option that determines the drill down filters for the explicit hierarchy.</p>
|
|
5735
6434
|
*/
|
|
5736
6435
|
DrillDownFilters?: DrillDownFilter[];
|
|
@@ -5741,14 +6440,17 @@ export interface ExplicitHierarchy {
|
|
|
5741
6440
|
*/
|
|
5742
6441
|
export interface PredefinedHierarchy {
|
|
5743
6442
|
/**
|
|
6443
|
+
* @public
|
|
5744
6444
|
* <p>The hierarchy ID of the predefined hierarchy.</p>
|
|
5745
6445
|
*/
|
|
5746
6446
|
HierarchyId: string | undefined;
|
|
5747
6447
|
/**
|
|
6448
|
+
* @public
|
|
5748
6449
|
* <p>The list of columns that define the predefined hierarchy.</p>
|
|
5749
6450
|
*/
|
|
5750
6451
|
Columns: ColumnIdentifier[] | undefined;
|
|
5751
6452
|
/**
|
|
6453
|
+
* @public
|
|
5752
6454
|
* <p>The option that determines the drill down filters for the predefined hierarchy.</p>
|
|
5753
6455
|
*/
|
|
5754
6456
|
DrillDownFilters?: DrillDownFilter[];
|
|
@@ -5759,14 +6461,17 @@ export interface PredefinedHierarchy {
|
|
|
5759
6461
|
*/
|
|
5760
6462
|
export interface ColumnHierarchy {
|
|
5761
6463
|
/**
|
|
6464
|
+
* @public
|
|
5762
6465
|
* <p>The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.</p>
|
|
5763
6466
|
*/
|
|
5764
6467
|
ExplicitHierarchy?: ExplicitHierarchy;
|
|
5765
6468
|
/**
|
|
6469
|
+
* @public
|
|
5766
6470
|
* <p>The option that determines the hierarchy of any <code>DateTime</code> fields.</p>
|
|
5767
6471
|
*/
|
|
5768
6472
|
DateTimeHierarchy?: DateTimeHierarchy;
|
|
5769
6473
|
/**
|
|
6474
|
+
* @public
|
|
5770
6475
|
* <p>The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.</p>
|
|
5771
6476
|
*/
|
|
5772
6477
|
PredefinedHierarchy?: PredefinedHierarchy;
|
|
@@ -5778,10 +6483,12 @@ export interface ColumnHierarchy {
|
|
|
5778
6483
|
*/
|
|
5779
6484
|
export interface LongFormatText {
|
|
5780
6485
|
/**
|
|
6486
|
+
* @public
|
|
5781
6487
|
* <p>Plain text format.</p>
|
|
5782
6488
|
*/
|
|
5783
6489
|
PlainText?: string;
|
|
5784
6490
|
/**
|
|
6491
|
+
* @public
|
|
5785
6492
|
* <p>Rich text. Examples of rich text include bold, underline, and italics.</p>
|
|
5786
6493
|
*/
|
|
5787
6494
|
RichText?: string;
|
|
@@ -5792,10 +6499,12 @@ export interface LongFormatText {
|
|
|
5792
6499
|
*/
|
|
5793
6500
|
export interface VisualSubtitleLabelOptions {
|
|
5794
6501
|
/**
|
|
6502
|
+
* @public
|
|
5795
6503
|
* <p>The visibility of the subtitle label.</p>
|
|
5796
6504
|
*/
|
|
5797
6505
|
Visibility?: Visibility | string;
|
|
5798
6506
|
/**
|
|
6507
|
+
* @public
|
|
5799
6508
|
* <p>The long text format of the subtitle label, such as plain text or rich text.</p>
|
|
5800
6509
|
*/
|
|
5801
6510
|
FormatText?: LongFormatText;
|
|
@@ -5807,10 +6516,12 @@ export interface VisualSubtitleLabelOptions {
|
|
|
5807
6516
|
*/
|
|
5808
6517
|
export interface ShortFormatText {
|
|
5809
6518
|
/**
|
|
6519
|
+
* @public
|
|
5810
6520
|
* <p>Plain text format.</p>
|
|
5811
6521
|
*/
|
|
5812
6522
|
PlainText?: string;
|
|
5813
6523
|
/**
|
|
6524
|
+
* @public
|
|
5814
6525
|
* <p>Rich text. Examples of rich text include bold, underline, and italics.</p>
|
|
5815
6526
|
*/
|
|
5816
6527
|
RichText?: string;
|
|
@@ -5821,10 +6532,12 @@ export interface ShortFormatText {
|
|
|
5821
6532
|
*/
|
|
5822
6533
|
export interface VisualTitleLabelOptions {
|
|
5823
6534
|
/**
|
|
6535
|
+
* @public
|
|
5824
6536
|
* <p>The visibility of the title label.</p>
|
|
5825
6537
|
*/
|
|
5826
6538
|
Visibility?: Visibility | string;
|
|
5827
6539
|
/**
|
|
6540
|
+
* @public
|
|
5828
6541
|
* <p>The short text format of the title label, such as plain text or rich text.</p>
|
|
5829
6542
|
*/
|
|
5830
6543
|
FormatText?: ShortFormatText;
|
|
@@ -5857,26 +6570,32 @@ export interface VisualTitleLabelOptions {
|
|
|
5857
6570
|
*/
|
|
5858
6571
|
export interface BarChartVisual {
|
|
5859
6572
|
/**
|
|
6573
|
+
* @public
|
|
5860
6574
|
* <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>
|
|
5861
6575
|
*/
|
|
5862
6576
|
VisualId: string | undefined;
|
|
5863
6577
|
/**
|
|
6578
|
+
* @public
|
|
5864
6579
|
* <p>The title that is displayed on the visual.</p>
|
|
5865
6580
|
*/
|
|
5866
6581
|
Title?: VisualTitleLabelOptions;
|
|
5867
6582
|
/**
|
|
6583
|
+
* @public
|
|
5868
6584
|
* <p>The subtitle that is displayed on the visual.</p>
|
|
5869
6585
|
*/
|
|
5870
6586
|
Subtitle?: VisualSubtitleLabelOptions;
|
|
5871
6587
|
/**
|
|
6588
|
+
* @public
|
|
5872
6589
|
* <p>The configuration settings of the visual.</p>
|
|
5873
6590
|
*/
|
|
5874
6591
|
ChartConfiguration?: BarChartConfiguration;
|
|
5875
6592
|
/**
|
|
6593
|
+
* @public
|
|
5876
6594
|
* <p>The list of custom actions that are configured for a visual.</p>
|
|
5877
6595
|
*/
|
|
5878
6596
|
Actions?: VisualCustomAction[];
|
|
5879
6597
|
/**
|
|
6598
|
+
* @public
|
|
5880
6599
|
* <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
|
|
5881
6600
|
*/
|
|
5882
6601
|
ColumnHierarchies?: ColumnHierarchy[];
|
|
@@ -5899,6 +6618,7 @@ export type BoxPlotFillStyle = (typeof BoxPlotFillStyle)[keyof typeof BoxPlotFil
|
|
|
5899
6618
|
*/
|
|
5900
6619
|
export interface BoxPlotStyleOptions {
|
|
5901
6620
|
/**
|
|
6621
|
+
* @public
|
|
5902
6622
|
* <p>The fill styles (solid, transparent) of the box plot.</p>
|
|
5903
6623
|
*/
|
|
5904
6624
|
FillStyle?: BoxPlotFillStyle | string;
|
|
@@ -5909,14 +6629,17 @@ export interface BoxPlotStyleOptions {
|
|
|
5909
6629
|
*/
|
|
5910
6630
|
export interface BoxPlotOptions {
|
|
5911
6631
|
/**
|
|
6632
|
+
* @public
|
|
5912
6633
|
* <p>The style options of the box plot.</p>
|
|
5913
6634
|
*/
|
|
5914
6635
|
StyleOptions?: BoxPlotStyleOptions;
|
|
5915
6636
|
/**
|
|
6637
|
+
* @public
|
|
5916
6638
|
* <p>Determines the visibility of the outlier in a box plot.</p>
|
|
5917
6639
|
*/
|
|
5918
6640
|
OutlierVisibility?: Visibility | string;
|
|
5919
6641
|
/**
|
|
6642
|
+
* @public
|
|
5920
6643
|
* <p>Determines the visibility of all data points of the box plot.</p>
|
|
5921
6644
|
*/
|
|
5922
6645
|
AllDataPointsVisibility?: Visibility | string;
|