@aws-sdk/client-quicksight 3.556.0 → 3.558.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +16644 -16530
- package/dist-es/models/models_0.js +31 -51
- package/dist-es/models/models_1.js +21 -53
- package/dist-es/models/models_2.js +54 -25
- package/dist-es/models/models_3.js +25 -0
- package/dist-es/protocols/Aws_restJson1.js +115 -4
- package/dist-types/commands/CreateAnalysisCommand.d.ts +300 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +300 -0
- package/dist-types/commands/CreateTemplateCommand.d.ts +300 -0
- package/dist-types/commands/CreateThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/CreateThemeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +300 -0
- package/dist-types/commands/DescribeAssetBundleExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +6 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +300 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +300 -0
- package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist-types/commands/ListIdentityPropagationConfigsCommand.d.ts +1 -1
- package/dist-types/commands/ListIngestionsCommand.d.ts +1 -1
- package/dist-types/commands/ListNamespacesCommand.d.ts +1 -2
- package/dist-types/commands/StartAssetBundleExportJobCommand.d.ts +1 -1
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +52 -5
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +300 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +300 -0
- package/dist-types/commands/UpdateTemplateCommand.d.ts +300 -0
- package/dist-types/models/models_0.d.ts +717 -725
- package/dist-types/models/models_1.d.ts +286 -446
- package/dist-types/models/models_2.d.ts +463 -302
- package/dist-types/models/models_3.d.ts +316 -280
- package/dist-types/models/models_4.d.ts +280 -4
- package/dist-types/ts3.4/commands/CreateThemeAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIdentityPropagationConfigsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIngestionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListNamespacesCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +174 -190
- package/dist-types/ts3.4/models/models_1.d.ts +77 -134
- package/dist-types/ts3.4/models/models_2.d.ts +159 -91
- package/dist-types/ts3.4/models/models_3.d.ts +91 -72
- package/dist-types/ts3.4/models/models_4.d.ts +76 -3
- package/package.json +1 -1
|
@@ -1579,6 +1579,599 @@ export interface CategoryFilterConfiguration {
|
|
|
1579
1579
|
*/
|
|
1580
1580
|
CustomFilterConfiguration?: CustomFilterConfiguration;
|
|
1581
1581
|
}
|
|
1582
|
+
/**
|
|
1583
|
+
* <p>A control to display info icons for filters and parameters.</p>
|
|
1584
|
+
* @public
|
|
1585
|
+
*/
|
|
1586
|
+
export interface SheetControlInfoIconLabelOptions {
|
|
1587
|
+
/**
|
|
1588
|
+
* <p>The visibility configuration of info icon label options.</p>
|
|
1589
|
+
* @public
|
|
1590
|
+
*/
|
|
1591
|
+
Visibility?: Visibility;
|
|
1592
|
+
/**
|
|
1593
|
+
* <p> The text content of info icon.</p>
|
|
1594
|
+
* @public
|
|
1595
|
+
*/
|
|
1596
|
+
InfoIconText?: string;
|
|
1597
|
+
}
|
|
1598
|
+
/**
|
|
1599
|
+
* @public
|
|
1600
|
+
* @enum
|
|
1601
|
+
*/
|
|
1602
|
+
export declare const FontDecoration: {
|
|
1603
|
+
readonly NONE: "NONE";
|
|
1604
|
+
readonly UNDERLINE: "UNDERLINE";
|
|
1605
|
+
};
|
|
1606
|
+
/**
|
|
1607
|
+
* @public
|
|
1608
|
+
*/
|
|
1609
|
+
export type FontDecoration = (typeof FontDecoration)[keyof typeof FontDecoration];
|
|
1610
|
+
/**
|
|
1611
|
+
* @public
|
|
1612
|
+
* @enum
|
|
1613
|
+
*/
|
|
1614
|
+
export declare const RelativeFontSize: {
|
|
1615
|
+
readonly EXTRA_LARGE: "EXTRA_LARGE";
|
|
1616
|
+
readonly EXTRA_SMALL: "EXTRA_SMALL";
|
|
1617
|
+
readonly LARGE: "LARGE";
|
|
1618
|
+
readonly MEDIUM: "MEDIUM";
|
|
1619
|
+
readonly SMALL: "SMALL";
|
|
1620
|
+
};
|
|
1621
|
+
/**
|
|
1622
|
+
* @public
|
|
1623
|
+
*/
|
|
1624
|
+
export type RelativeFontSize = (typeof RelativeFontSize)[keyof typeof RelativeFontSize];
|
|
1625
|
+
/**
|
|
1626
|
+
* <p>The option that determines the text display size.</p>
|
|
1627
|
+
* @public
|
|
1628
|
+
*/
|
|
1629
|
+
export interface FontSize {
|
|
1630
|
+
/**
|
|
1631
|
+
* <p>The lexical name for the text size, proportional to its surrounding context.</p>
|
|
1632
|
+
* @public
|
|
1633
|
+
*/
|
|
1634
|
+
Relative?: RelativeFontSize;
|
|
1635
|
+
}
|
|
1636
|
+
/**
|
|
1637
|
+
* @public
|
|
1638
|
+
* @enum
|
|
1639
|
+
*/
|
|
1640
|
+
export declare const FontStyle: {
|
|
1641
|
+
readonly ITALIC: "ITALIC";
|
|
1642
|
+
readonly NORMAL: "NORMAL";
|
|
1643
|
+
};
|
|
1644
|
+
/**
|
|
1645
|
+
* @public
|
|
1646
|
+
*/
|
|
1647
|
+
export type FontStyle = (typeof FontStyle)[keyof typeof FontStyle];
|
|
1648
|
+
/**
|
|
1649
|
+
* @public
|
|
1650
|
+
* @enum
|
|
1651
|
+
*/
|
|
1652
|
+
export declare const FontWeightName: {
|
|
1653
|
+
readonly BOLD: "BOLD";
|
|
1654
|
+
readonly NORMAL: "NORMAL";
|
|
1655
|
+
};
|
|
1656
|
+
/**
|
|
1657
|
+
* @public
|
|
1658
|
+
*/
|
|
1659
|
+
export type FontWeightName = (typeof FontWeightName)[keyof typeof FontWeightName];
|
|
1660
|
+
/**
|
|
1661
|
+
* <p>The option that determines the text display weight, or boldness.</p>
|
|
1662
|
+
* @public
|
|
1663
|
+
*/
|
|
1664
|
+
export interface FontWeight {
|
|
1665
|
+
/**
|
|
1666
|
+
* <p>The lexical name for the level of boldness of the text display.</p>
|
|
1667
|
+
* @public
|
|
1668
|
+
*/
|
|
1669
|
+
Name?: FontWeightName;
|
|
1670
|
+
}
|
|
1671
|
+
/**
|
|
1672
|
+
* <p>Configures the display properties of the given text.</p>
|
|
1673
|
+
* @public
|
|
1674
|
+
*/
|
|
1675
|
+
export interface FontConfiguration {
|
|
1676
|
+
/**
|
|
1677
|
+
* <p>The option that determines the text display size.</p>
|
|
1678
|
+
* @public
|
|
1679
|
+
*/
|
|
1680
|
+
FontSize?: FontSize;
|
|
1681
|
+
/**
|
|
1682
|
+
* <p>Determines the appearance of decorative lines on the text.</p>
|
|
1683
|
+
* @public
|
|
1684
|
+
*/
|
|
1685
|
+
FontDecoration?: FontDecoration;
|
|
1686
|
+
/**
|
|
1687
|
+
* <p>Determines the color of the text.</p>
|
|
1688
|
+
* @public
|
|
1689
|
+
*/
|
|
1690
|
+
FontColor?: string;
|
|
1691
|
+
/**
|
|
1692
|
+
* <p>The option that determines the text display weight, or boldness.</p>
|
|
1693
|
+
* @public
|
|
1694
|
+
*/
|
|
1695
|
+
FontWeight?: FontWeight;
|
|
1696
|
+
/**
|
|
1697
|
+
* <p>Determines the text display face that is inherited by the given font family.</p>
|
|
1698
|
+
* @public
|
|
1699
|
+
*/
|
|
1700
|
+
FontStyle?: FontStyle;
|
|
1701
|
+
}
|
|
1702
|
+
/**
|
|
1703
|
+
* <p>The share label options for the labels.</p>
|
|
1704
|
+
* @public
|
|
1705
|
+
*/
|
|
1706
|
+
export interface LabelOptions {
|
|
1707
|
+
/**
|
|
1708
|
+
* <p>Determines whether or not the label is visible.</p>
|
|
1709
|
+
* @public
|
|
1710
|
+
*/
|
|
1711
|
+
Visibility?: Visibility;
|
|
1712
|
+
/**
|
|
1713
|
+
* <p>The font configuration of the label.</p>
|
|
1714
|
+
* @public
|
|
1715
|
+
*/
|
|
1716
|
+
FontConfiguration?: FontConfiguration;
|
|
1717
|
+
/**
|
|
1718
|
+
* <p>The text for the label.</p>
|
|
1719
|
+
* @public
|
|
1720
|
+
*/
|
|
1721
|
+
CustomLabel?: string;
|
|
1722
|
+
}
|
|
1723
|
+
/**
|
|
1724
|
+
* <p>The display options of a control.</p>
|
|
1725
|
+
* @public
|
|
1726
|
+
*/
|
|
1727
|
+
export interface DateTimePickerControlDisplayOptions {
|
|
1728
|
+
/**
|
|
1729
|
+
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
1730
|
+
* @public
|
|
1731
|
+
*/
|
|
1732
|
+
TitleOptions?: LabelOptions;
|
|
1733
|
+
/**
|
|
1734
|
+
* <p>Customize how dates are formatted in controls.</p>
|
|
1735
|
+
* @public
|
|
1736
|
+
*/
|
|
1737
|
+
DateTimeFormat?: string;
|
|
1738
|
+
/**
|
|
1739
|
+
* <p>The configuration of info icon label options.</p>
|
|
1740
|
+
* @public
|
|
1741
|
+
*/
|
|
1742
|
+
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
1743
|
+
}
|
|
1744
|
+
/**
|
|
1745
|
+
* @public
|
|
1746
|
+
* @enum
|
|
1747
|
+
*/
|
|
1748
|
+
export declare const SheetControlDateTimePickerType: {
|
|
1749
|
+
readonly DATE_RANGE: "DATE_RANGE";
|
|
1750
|
+
readonly SINGLE_VALUED: "SINGLE_VALUED";
|
|
1751
|
+
};
|
|
1752
|
+
/**
|
|
1753
|
+
* @public
|
|
1754
|
+
*/
|
|
1755
|
+
export type SheetControlDateTimePickerType = (typeof SheetControlDateTimePickerType)[keyof typeof SheetControlDateTimePickerType];
|
|
1756
|
+
/**
|
|
1757
|
+
* <p>The default options that correspond to the filter control type of a <code>DateTimePicker</code>.</p>
|
|
1758
|
+
* @public
|
|
1759
|
+
*/
|
|
1760
|
+
export interface DefaultDateTimePickerControlOptions {
|
|
1761
|
+
/**
|
|
1762
|
+
* <p>The date time picker type of the <code>DefaultDateTimePickerControlOptions</code>. Choose one of the following options:</p>
|
|
1763
|
+
* <ul>
|
|
1764
|
+
* <li>
|
|
1765
|
+
* <p>
|
|
1766
|
+
* <code>SINGLE_VALUED</code>: The filter condition is a fixed date.</p>
|
|
1767
|
+
* </li>
|
|
1768
|
+
* <li>
|
|
1769
|
+
* <p>
|
|
1770
|
+
* <code>DATE_RANGE</code>: The filter condition is a date time range.</p>
|
|
1771
|
+
* </li>
|
|
1772
|
+
* </ul>
|
|
1773
|
+
* @public
|
|
1774
|
+
*/
|
|
1775
|
+
Type?: SheetControlDateTimePickerType;
|
|
1776
|
+
/**
|
|
1777
|
+
* <p>The display options of a control.</p>
|
|
1778
|
+
* @public
|
|
1779
|
+
*/
|
|
1780
|
+
DisplayOptions?: DateTimePickerControlDisplayOptions;
|
|
1781
|
+
}
|
|
1782
|
+
/**
|
|
1783
|
+
* <p>The configuration of the <code>Select all</code> options in a list control.</p>
|
|
1784
|
+
* @public
|
|
1785
|
+
*/
|
|
1786
|
+
export interface ListControlSelectAllOptions {
|
|
1787
|
+
/**
|
|
1788
|
+
* <p>The visibility configuration of the <code>Select all</code> options in a list control.</p>
|
|
1789
|
+
* @public
|
|
1790
|
+
*/
|
|
1791
|
+
Visibility?: Visibility;
|
|
1792
|
+
}
|
|
1793
|
+
/**
|
|
1794
|
+
* <p>The display options of a control.</p>
|
|
1795
|
+
* @public
|
|
1796
|
+
*/
|
|
1797
|
+
export interface DropDownControlDisplayOptions {
|
|
1798
|
+
/**
|
|
1799
|
+
* <p>The configuration of the <code>Select all</code> options in a
|
|
1800
|
+
* dropdown control.</p>
|
|
1801
|
+
* @public
|
|
1802
|
+
*/
|
|
1803
|
+
SelectAllOptions?: ListControlSelectAllOptions;
|
|
1804
|
+
/**
|
|
1805
|
+
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
1806
|
+
* @public
|
|
1807
|
+
*/
|
|
1808
|
+
TitleOptions?: LabelOptions;
|
|
1809
|
+
/**
|
|
1810
|
+
* <p>The configuration of info icon label options.</p>
|
|
1811
|
+
* @public
|
|
1812
|
+
*/
|
|
1813
|
+
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
1814
|
+
}
|
|
1815
|
+
/**
|
|
1816
|
+
* <p>A list of selectable values that are used in a control.</p>
|
|
1817
|
+
* @public
|
|
1818
|
+
*/
|
|
1819
|
+
export interface FilterSelectableValues {
|
|
1820
|
+
/**
|
|
1821
|
+
* <p>The values that are used in the <code>FilterSelectableValues</code>.</p>
|
|
1822
|
+
* @public
|
|
1823
|
+
*/
|
|
1824
|
+
Values?: string[];
|
|
1825
|
+
}
|
|
1826
|
+
/**
|
|
1827
|
+
* @public
|
|
1828
|
+
* @enum
|
|
1829
|
+
*/
|
|
1830
|
+
export declare const SheetControlListType: {
|
|
1831
|
+
readonly MULTI_SELECT: "MULTI_SELECT";
|
|
1832
|
+
readonly SINGLE_SELECT: "SINGLE_SELECT";
|
|
1833
|
+
};
|
|
1834
|
+
/**
|
|
1835
|
+
* @public
|
|
1836
|
+
*/
|
|
1837
|
+
export type SheetControlListType = (typeof SheetControlListType)[keyof typeof SheetControlListType];
|
|
1838
|
+
/**
|
|
1839
|
+
* <p>The default options that correspond to the <code>Dropdown</code> filter control type.</p>
|
|
1840
|
+
* @public
|
|
1841
|
+
*/
|
|
1842
|
+
export interface DefaultFilterDropDownControlOptions {
|
|
1843
|
+
/**
|
|
1844
|
+
* <p>The display options of a control.</p>
|
|
1845
|
+
* @public
|
|
1846
|
+
*/
|
|
1847
|
+
DisplayOptions?: DropDownControlDisplayOptions;
|
|
1848
|
+
/**
|
|
1849
|
+
* <p>The type of the <code>FilterDropDownControl</code>. Choose one of the following options:</p>
|
|
1850
|
+
* <ul>
|
|
1851
|
+
* <li>
|
|
1852
|
+
* <p>
|
|
1853
|
+
* <code>MULTI_SELECT</code>: The user can select multiple entries from a dropdown menu.</p>
|
|
1854
|
+
* </li>
|
|
1855
|
+
* <li>
|
|
1856
|
+
* <p>
|
|
1857
|
+
* <code>SINGLE_SELECT</code>: The user can select a single entry from a dropdown menu.</p>
|
|
1858
|
+
* </li>
|
|
1859
|
+
* </ul>
|
|
1860
|
+
* @public
|
|
1861
|
+
*/
|
|
1862
|
+
Type?: SheetControlListType;
|
|
1863
|
+
/**
|
|
1864
|
+
* <p>A list of selectable values that are used in a control.</p>
|
|
1865
|
+
* @public
|
|
1866
|
+
*/
|
|
1867
|
+
SelectableValues?: FilterSelectableValues;
|
|
1868
|
+
}
|
|
1869
|
+
/**
|
|
1870
|
+
* <p>The configuration of the search options in a list control.</p>
|
|
1871
|
+
* @public
|
|
1872
|
+
*/
|
|
1873
|
+
export interface ListControlSearchOptions {
|
|
1874
|
+
/**
|
|
1875
|
+
* <p>The visibility configuration of the search options in a list control.</p>
|
|
1876
|
+
* @public
|
|
1877
|
+
*/
|
|
1878
|
+
Visibility?: Visibility;
|
|
1879
|
+
}
|
|
1880
|
+
/**
|
|
1881
|
+
* <p>The display options of a control.</p>
|
|
1882
|
+
* @public
|
|
1883
|
+
*/
|
|
1884
|
+
export interface ListControlDisplayOptions {
|
|
1885
|
+
/**
|
|
1886
|
+
* <p>The configuration of the search options in a list control.</p>
|
|
1887
|
+
* @public
|
|
1888
|
+
*/
|
|
1889
|
+
SearchOptions?: ListControlSearchOptions;
|
|
1890
|
+
/**
|
|
1891
|
+
* <p>The configuration of the <code>Select all</code> options in a list control.</p>
|
|
1892
|
+
* @public
|
|
1893
|
+
*/
|
|
1894
|
+
SelectAllOptions?: ListControlSelectAllOptions;
|
|
1895
|
+
/**
|
|
1896
|
+
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
1897
|
+
* @public
|
|
1898
|
+
*/
|
|
1899
|
+
TitleOptions?: LabelOptions;
|
|
1900
|
+
/**
|
|
1901
|
+
* <p>The configuration of info icon label options.</p>
|
|
1902
|
+
* @public
|
|
1903
|
+
*/
|
|
1904
|
+
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
1905
|
+
}
|
|
1906
|
+
/**
|
|
1907
|
+
* <p>The default options that correspond to the <code>List</code> filter control type.</p>
|
|
1908
|
+
* @public
|
|
1909
|
+
*/
|
|
1910
|
+
export interface DefaultFilterListControlOptions {
|
|
1911
|
+
/**
|
|
1912
|
+
* <p>The display options of a control.</p>
|
|
1913
|
+
* @public
|
|
1914
|
+
*/
|
|
1915
|
+
DisplayOptions?: ListControlDisplayOptions;
|
|
1916
|
+
/**
|
|
1917
|
+
* <p>The type of the <code>DefaultFilterListControlOptions</code>. Choose one of the following options:</p>
|
|
1918
|
+
* <ul>
|
|
1919
|
+
* <li>
|
|
1920
|
+
* <p>
|
|
1921
|
+
* <code>MULTI_SELECT</code>: The user can select multiple entries from the list.</p>
|
|
1922
|
+
* </li>
|
|
1923
|
+
* <li>
|
|
1924
|
+
* <p>
|
|
1925
|
+
* <code>SINGLE_SELECT</code>: The user can select a single entry from the list.</p>
|
|
1926
|
+
* </li>
|
|
1927
|
+
* </ul>
|
|
1928
|
+
* @public
|
|
1929
|
+
*/
|
|
1930
|
+
Type?: SheetControlListType;
|
|
1931
|
+
/**
|
|
1932
|
+
* <p>A list of selectable values that are used in a control.</p>
|
|
1933
|
+
* @public
|
|
1934
|
+
*/
|
|
1935
|
+
SelectableValues?: FilterSelectableValues;
|
|
1936
|
+
}
|
|
1937
|
+
/**
|
|
1938
|
+
* <p>The display options of a control.</p>
|
|
1939
|
+
* @public
|
|
1940
|
+
*/
|
|
1941
|
+
export interface RelativeDateTimeControlDisplayOptions {
|
|
1942
|
+
/**
|
|
1943
|
+
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
1944
|
+
* @public
|
|
1945
|
+
*/
|
|
1946
|
+
TitleOptions?: LabelOptions;
|
|
1947
|
+
/**
|
|
1948
|
+
* <p>Customize how dates are formatted in controls.</p>
|
|
1949
|
+
* @public
|
|
1950
|
+
*/
|
|
1951
|
+
DateTimeFormat?: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* <p>The configuration of info icon label options.</p>
|
|
1954
|
+
* @public
|
|
1955
|
+
*/
|
|
1956
|
+
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
1957
|
+
}
|
|
1958
|
+
/**
|
|
1959
|
+
* <p>The default options that correspond to the <code>RelativeDateTime</code> filter control type.</p>
|
|
1960
|
+
* @public
|
|
1961
|
+
*/
|
|
1962
|
+
export interface DefaultRelativeDateTimeControlOptions {
|
|
1963
|
+
/**
|
|
1964
|
+
* <p>The display options of a control.</p>
|
|
1965
|
+
* @public
|
|
1966
|
+
*/
|
|
1967
|
+
DisplayOptions?: RelativeDateTimeControlDisplayOptions;
|
|
1968
|
+
}
|
|
1969
|
+
/**
|
|
1970
|
+
* <p>The display options of a control.</p>
|
|
1971
|
+
* @public
|
|
1972
|
+
*/
|
|
1973
|
+
export interface SliderControlDisplayOptions {
|
|
1974
|
+
/**
|
|
1975
|
+
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
1976
|
+
* @public
|
|
1977
|
+
*/
|
|
1978
|
+
TitleOptions?: LabelOptions;
|
|
1979
|
+
/**
|
|
1980
|
+
* <p>The configuration of info icon label options.</p>
|
|
1981
|
+
* @public
|
|
1982
|
+
*/
|
|
1983
|
+
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
1984
|
+
}
|
|
1985
|
+
/**
|
|
1986
|
+
* @public
|
|
1987
|
+
* @enum
|
|
1988
|
+
*/
|
|
1989
|
+
export declare const SheetControlSliderType: {
|
|
1990
|
+
readonly RANGE: "RANGE";
|
|
1991
|
+
readonly SINGLE_POINT: "SINGLE_POINT";
|
|
1992
|
+
};
|
|
1993
|
+
/**
|
|
1994
|
+
* @public
|
|
1995
|
+
*/
|
|
1996
|
+
export type SheetControlSliderType = (typeof SheetControlSliderType)[keyof typeof SheetControlSliderType];
|
|
1997
|
+
/**
|
|
1998
|
+
* <p>The default options that correspond to the <code>Slider</code> filter control type.</p>
|
|
1999
|
+
* @public
|
|
2000
|
+
*/
|
|
2001
|
+
export interface DefaultSliderControlOptions {
|
|
2002
|
+
/**
|
|
2003
|
+
* <p>The display options of a control.</p>
|
|
2004
|
+
* @public
|
|
2005
|
+
*/
|
|
2006
|
+
DisplayOptions?: SliderControlDisplayOptions;
|
|
2007
|
+
/**
|
|
2008
|
+
* <p>The type of the <code>DefaultSliderControlOptions</code>. Choose one of the following options:</p>
|
|
2009
|
+
* <ul>
|
|
2010
|
+
* <li>
|
|
2011
|
+
* <p>
|
|
2012
|
+
* <code>SINGLE_POINT</code>: Filter against(equals) a single data point.</p>
|
|
2013
|
+
* </li>
|
|
2014
|
+
* <li>
|
|
2015
|
+
* <p>
|
|
2016
|
+
* <code>RANGE</code>: Filter data that is in a specified range.</p>
|
|
2017
|
+
* </li>
|
|
2018
|
+
* </ul>
|
|
2019
|
+
* @public
|
|
2020
|
+
*/
|
|
2021
|
+
Type?: SheetControlSliderType;
|
|
2022
|
+
/**
|
|
2023
|
+
* <p>The larger value that is displayed at the right of the slider.</p>
|
|
2024
|
+
* @public
|
|
2025
|
+
*/
|
|
2026
|
+
MaximumValue: number | undefined;
|
|
2027
|
+
/**
|
|
2028
|
+
* <p>The smaller value that is displayed at the left of the slider.</p>
|
|
2029
|
+
* @public
|
|
2030
|
+
*/
|
|
2031
|
+
MinimumValue: number | undefined;
|
|
2032
|
+
/**
|
|
2033
|
+
* <p>The number of increments that the slider bar is divided into.</p>
|
|
2034
|
+
* @public
|
|
2035
|
+
*/
|
|
2036
|
+
StepSize: number | undefined;
|
|
2037
|
+
}
|
|
2038
|
+
/**
|
|
2039
|
+
* <p>The configuration of the placeholder options in a text control.</p>
|
|
2040
|
+
* @public
|
|
2041
|
+
*/
|
|
2042
|
+
export interface TextControlPlaceholderOptions {
|
|
2043
|
+
/**
|
|
2044
|
+
* <p>The visibility configuration of the placeholder options in a text control.</p>
|
|
2045
|
+
* @public
|
|
2046
|
+
*/
|
|
2047
|
+
Visibility?: Visibility;
|
|
2048
|
+
}
|
|
2049
|
+
/**
|
|
2050
|
+
* <p>The display options of a control.</p>
|
|
2051
|
+
* @public
|
|
2052
|
+
*/
|
|
2053
|
+
export interface TextAreaControlDisplayOptions {
|
|
2054
|
+
/**
|
|
2055
|
+
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
2056
|
+
* @public
|
|
2057
|
+
*/
|
|
2058
|
+
TitleOptions?: LabelOptions;
|
|
2059
|
+
/**
|
|
2060
|
+
* <p>The configuration of the placeholder options in a text area control.</p>
|
|
2061
|
+
* @public
|
|
2062
|
+
*/
|
|
2063
|
+
PlaceholderOptions?: TextControlPlaceholderOptions;
|
|
2064
|
+
/**
|
|
2065
|
+
* <p>The configuration of info icon label options.</p>
|
|
2066
|
+
* @public
|
|
2067
|
+
*/
|
|
2068
|
+
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
2069
|
+
}
|
|
2070
|
+
/**
|
|
2071
|
+
* <p>The default options that correspond to the <code>TextArea</code> filter control type.</p>
|
|
2072
|
+
* @public
|
|
2073
|
+
*/
|
|
2074
|
+
export interface DefaultTextAreaControlOptions {
|
|
2075
|
+
/**
|
|
2076
|
+
* <p>The delimiter that is used to separate the lines in text.</p>
|
|
2077
|
+
* @public
|
|
2078
|
+
*/
|
|
2079
|
+
Delimiter?: string;
|
|
2080
|
+
/**
|
|
2081
|
+
* <p>The display options of a control.</p>
|
|
2082
|
+
* @public
|
|
2083
|
+
*/
|
|
2084
|
+
DisplayOptions?: TextAreaControlDisplayOptions;
|
|
2085
|
+
}
|
|
2086
|
+
/**
|
|
2087
|
+
* <p>The display options of a control.</p>
|
|
2088
|
+
* @public
|
|
2089
|
+
*/
|
|
2090
|
+
export interface TextFieldControlDisplayOptions {
|
|
2091
|
+
/**
|
|
2092
|
+
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
2093
|
+
* @public
|
|
2094
|
+
*/
|
|
2095
|
+
TitleOptions?: LabelOptions;
|
|
2096
|
+
/**
|
|
2097
|
+
* <p>The configuration of the placeholder options in a text field control.</p>
|
|
2098
|
+
* @public
|
|
2099
|
+
*/
|
|
2100
|
+
PlaceholderOptions?: TextControlPlaceholderOptions;
|
|
2101
|
+
/**
|
|
2102
|
+
* <p>The configuration of info icon label options.</p>
|
|
2103
|
+
* @public
|
|
2104
|
+
*/
|
|
2105
|
+
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
2106
|
+
}
|
|
2107
|
+
/**
|
|
2108
|
+
* <p>The default options that correspond to the <code>TextField</code> filter control type.</p>
|
|
2109
|
+
* @public
|
|
2110
|
+
*/
|
|
2111
|
+
export interface DefaultTextFieldControlOptions {
|
|
2112
|
+
/**
|
|
2113
|
+
* <p>The display options of a control.</p>
|
|
2114
|
+
* @public
|
|
2115
|
+
*/
|
|
2116
|
+
DisplayOptions?: TextFieldControlDisplayOptions;
|
|
2117
|
+
}
|
|
2118
|
+
/**
|
|
2119
|
+
* <p>The option that corresponds to the control type of the filter.</p>
|
|
2120
|
+
* @public
|
|
2121
|
+
*/
|
|
2122
|
+
export interface DefaultFilterControlOptions {
|
|
2123
|
+
/**
|
|
2124
|
+
* <p>The default options that correspond to the filter control type of a <code>DateTimePicker</code>.</p>
|
|
2125
|
+
* @public
|
|
2126
|
+
*/
|
|
2127
|
+
DefaultDateTimePickerOptions?: DefaultDateTimePickerControlOptions;
|
|
2128
|
+
/**
|
|
2129
|
+
* <p>The default options that correspond to the <code>List</code> filter control type.</p>
|
|
2130
|
+
* @public
|
|
2131
|
+
*/
|
|
2132
|
+
DefaultListOptions?: DefaultFilterListControlOptions;
|
|
2133
|
+
/**
|
|
2134
|
+
* <p>The default options that correspond to the <code>Dropdown</code> filter control type.</p>
|
|
2135
|
+
* @public
|
|
2136
|
+
*/
|
|
2137
|
+
DefaultDropdownOptions?: DefaultFilterDropDownControlOptions;
|
|
2138
|
+
/**
|
|
2139
|
+
* <p>The default options that correspond to the <code>TextField</code> filter control type.</p>
|
|
2140
|
+
* @public
|
|
2141
|
+
*/
|
|
2142
|
+
DefaultTextFieldOptions?: DefaultTextFieldControlOptions;
|
|
2143
|
+
/**
|
|
2144
|
+
* <p>The default options that correspond to the <code>TextArea</code> filter control type.</p>
|
|
2145
|
+
* @public
|
|
2146
|
+
*/
|
|
2147
|
+
DefaultTextAreaOptions?: DefaultTextAreaControlOptions;
|
|
2148
|
+
/**
|
|
2149
|
+
* <p>The default options that correspond to the <code>Slider</code> filter control type.</p>
|
|
2150
|
+
* @public
|
|
2151
|
+
*/
|
|
2152
|
+
DefaultSliderOptions?: DefaultSliderControlOptions;
|
|
2153
|
+
/**
|
|
2154
|
+
* <p>The default options that correspond to the <code>RelativeDateTime</code> filter control type.</p>
|
|
2155
|
+
* @public
|
|
2156
|
+
*/
|
|
2157
|
+
DefaultRelativeDateTimeOptions?: DefaultRelativeDateTimeControlOptions;
|
|
2158
|
+
}
|
|
2159
|
+
/**
|
|
2160
|
+
* <p>The default configuration for all dependent controls of the filter.</p>
|
|
2161
|
+
* @public
|
|
2162
|
+
*/
|
|
2163
|
+
export interface DefaultFilterControlConfiguration {
|
|
2164
|
+
/**
|
|
2165
|
+
* <p>The title of the <code>DefaultFilterControlConfiguration</code>. This title is shared by all controls that are tied to this filter.</p>
|
|
2166
|
+
* @public
|
|
2167
|
+
*/
|
|
2168
|
+
Title: string | undefined;
|
|
2169
|
+
/**
|
|
2170
|
+
* <p>The control option for the <code>DefaultFilterControlConfiguration</code>.</p>
|
|
2171
|
+
* @public
|
|
2172
|
+
*/
|
|
2173
|
+
ControlOptions: DefaultFilterControlOptions | undefined;
|
|
2174
|
+
}
|
|
1582
2175
|
/**
|
|
1583
2176
|
* <p>A <code>CategoryFilter</code> filters text values.</p>
|
|
1584
2177
|
* <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>
|
|
@@ -1600,6 +2193,11 @@ export interface CategoryFilter {
|
|
|
1600
2193
|
* @public
|
|
1601
2194
|
*/
|
|
1602
2195
|
Configuration: CategoryFilterConfiguration | undefined;
|
|
2196
|
+
/**
|
|
2197
|
+
* <p>The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.</p>
|
|
2198
|
+
* @public
|
|
2199
|
+
*/
|
|
2200
|
+
DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
|
|
1603
2201
|
}
|
|
1604
2202
|
/**
|
|
1605
2203
|
* @public
|
|
@@ -1690,6 +2288,11 @@ export interface NumericEqualityFilter {
|
|
|
1690
2288
|
* @public
|
|
1691
2289
|
*/
|
|
1692
2290
|
NullOption: FilterNullOption | undefined;
|
|
2291
|
+
/**
|
|
2292
|
+
* <p>The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.</p>
|
|
2293
|
+
* @public
|
|
2294
|
+
*/
|
|
2295
|
+
DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
|
|
1693
2296
|
}
|
|
1694
2297
|
/**
|
|
1695
2298
|
* <p>The value input pf the numeric range filter.</p>
|
|
@@ -1778,6 +2381,11 @@ export interface NumericRangeFilter {
|
|
|
1778
2381
|
* @public
|
|
1779
2382
|
*/
|
|
1780
2383
|
NullOption: FilterNullOption | undefined;
|
|
2384
|
+
/**
|
|
2385
|
+
* <p>The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.</p>
|
|
2386
|
+
* @public
|
|
2387
|
+
*/
|
|
2388
|
+
DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
|
|
1781
2389
|
}
|
|
1782
2390
|
/**
|
|
1783
2391
|
* @public
|
|
@@ -1988,6 +2596,11 @@ export interface RelativeDatesFilter {
|
|
|
1988
2596
|
* @public
|
|
1989
2597
|
*/
|
|
1990
2598
|
ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
|
|
2599
|
+
/**
|
|
2600
|
+
* <p>The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.</p>
|
|
2601
|
+
* @public
|
|
2602
|
+
*/
|
|
2603
|
+
DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
|
|
1991
2604
|
}
|
|
1992
2605
|
/**
|
|
1993
2606
|
* <p>The rolling date configuration of a date time filter.</p>
|
|
@@ -2043,6 +2656,11 @@ export interface TimeEqualityFilter {
|
|
|
2043
2656
|
* @public
|
|
2044
2657
|
*/
|
|
2045
2658
|
RollingDate?: RollingDateConfiguration;
|
|
2659
|
+
/**
|
|
2660
|
+
* <p>The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.</p>
|
|
2661
|
+
* @public
|
|
2662
|
+
*/
|
|
2663
|
+
DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
|
|
2046
2664
|
}
|
|
2047
2665
|
/**
|
|
2048
2666
|
* <p>The value of a time range filter.</p>
|
|
@@ -2130,6 +2748,11 @@ export interface TimeRangeFilter {
|
|
|
2130
2748
|
* @public
|
|
2131
2749
|
*/
|
|
2132
2750
|
TimeGranularity?: TimeGranularity;
|
|
2751
|
+
/**
|
|
2752
|
+
* <p>The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.</p>
|
|
2753
|
+
* @public
|
|
2754
|
+
*/
|
|
2755
|
+
DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
|
|
2133
2756
|
}
|
|
2134
2757
|
/**
|
|
2135
2758
|
* <p>A <code>TopBottomFilter</code> filters values that are at the top or the bottom.</p>
|
|
@@ -2166,6 +2789,11 @@ export interface TopBottomFilter {
|
|
|
2166
2789
|
* @public
|
|
2167
2790
|
*/
|
|
2168
2791
|
ParameterName?: string;
|
|
2792
|
+
/**
|
|
2793
|
+
* <p>The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.</p>
|
|
2794
|
+
* @public
|
|
2795
|
+
*/
|
|
2796
|
+
DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
|
|
2169
2797
|
}
|
|
2170
2798
|
/**
|
|
2171
2799
|
* <p>With a <code>Filter</code>, you can remove portions of data from a particular visual or view.</p>
|
|
@@ -2699,271 +3327,56 @@ export interface StringParameterDeclaration {
|
|
|
2699
3327
|
/**
|
|
2700
3328
|
* <p>The value type determines whether the parameter is a single-value or multi-value parameter.</p>
|
|
2701
3329
|
* @public
|
|
2702
|
-
*/
|
|
2703
|
-
ParameterValueType: ParameterValueType | undefined;
|
|
2704
|
-
/**
|
|
2705
|
-
* <p>The name of the parameter that is being declared.</p>
|
|
2706
|
-
* @public
|
|
2707
|
-
*/
|
|
2708
|
-
Name: string | undefined;
|
|
2709
|
-
/**
|
|
2710
|
-
* <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>
|
|
2711
|
-
* @public
|
|
2712
|
-
*/
|
|
2713
|
-
DefaultValues?: StringDefaultValues;
|
|
2714
|
-
/**
|
|
2715
|
-
* <p>The configuration that defines the default value of a <code>String</code> parameter when a value has not been set.</p>
|
|
2716
|
-
* @public
|
|
2717
|
-
*/
|
|
2718
|
-
ValueWhenUnset?: StringValueWhenUnsetConfiguration;
|
|
2719
|
-
/**
|
|
2720
|
-
* <p>A list of dataset parameters that are mapped to an analysis parameter.</p>
|
|
2721
|
-
* @public
|
|
2722
|
-
*/
|
|
2723
|
-
MappedDataSetParameters?: MappedDataSetParameter[];
|
|
2724
|
-
}
|
|
2725
|
-
/**
|
|
2726
|
-
* <p>The declaration definition of a parameter.</p>
|
|
2727
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
2728
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
2729
|
-
* @public
|
|
2730
|
-
*/
|
|
2731
|
-
export interface ParameterDeclaration {
|
|
2732
|
-
/**
|
|
2733
|
-
* <p>A parameter declaration for the <code>String</code> data type.</p>
|
|
2734
|
-
* @public
|
|
2735
|
-
*/
|
|
2736
|
-
StringParameterDeclaration?: StringParameterDeclaration;
|
|
2737
|
-
/**
|
|
2738
|
-
* <p>A parameter declaration for the <code>Decimal</code> data type.</p>
|
|
2739
|
-
* @public
|
|
2740
|
-
*/
|
|
2741
|
-
DecimalParameterDeclaration?: DecimalParameterDeclaration;
|
|
2742
|
-
/**
|
|
2743
|
-
* <p>A parameter declaration for the <code>Integer</code> data type.</p>
|
|
2744
|
-
* @public
|
|
2745
|
-
*/
|
|
2746
|
-
IntegerParameterDeclaration?: IntegerParameterDeclaration;
|
|
2747
|
-
/**
|
|
2748
|
-
* <p>A parameter declaration for the <code>DateTime</code> data type.</p>
|
|
2749
|
-
* @public
|
|
2750
|
-
*/
|
|
2751
|
-
DateTimeParameterDeclaration?: DateTimeParameterDeclaration;
|
|
2752
|
-
}
|
|
2753
|
-
/**
|
|
2754
|
-
* <p>A control to display info icons for filters and parameters.</p>
|
|
2755
|
-
* @public
|
|
2756
|
-
*/
|
|
2757
|
-
export interface SheetControlInfoIconLabelOptions {
|
|
2758
|
-
/**
|
|
2759
|
-
* <p>The visibility configuration of info icon label options.</p>
|
|
2760
|
-
* @public
|
|
2761
|
-
*/
|
|
2762
|
-
Visibility?: Visibility;
|
|
2763
|
-
/**
|
|
2764
|
-
* <p> The text content of info icon.</p>
|
|
2765
|
-
* @public
|
|
2766
|
-
*/
|
|
2767
|
-
InfoIconText?: string;
|
|
2768
|
-
}
|
|
2769
|
-
/**
|
|
2770
|
-
* @public
|
|
2771
|
-
* @enum
|
|
2772
|
-
*/
|
|
2773
|
-
export declare const FontDecoration: {
|
|
2774
|
-
readonly NONE: "NONE";
|
|
2775
|
-
readonly UNDERLINE: "UNDERLINE";
|
|
2776
|
-
};
|
|
2777
|
-
/**
|
|
2778
|
-
* @public
|
|
2779
|
-
*/
|
|
2780
|
-
export type FontDecoration = (typeof FontDecoration)[keyof typeof FontDecoration];
|
|
2781
|
-
/**
|
|
2782
|
-
* @public
|
|
2783
|
-
* @enum
|
|
2784
|
-
*/
|
|
2785
|
-
export declare const RelativeFontSize: {
|
|
2786
|
-
readonly EXTRA_LARGE: "EXTRA_LARGE";
|
|
2787
|
-
readonly EXTRA_SMALL: "EXTRA_SMALL";
|
|
2788
|
-
readonly LARGE: "LARGE";
|
|
2789
|
-
readonly MEDIUM: "MEDIUM";
|
|
2790
|
-
readonly SMALL: "SMALL";
|
|
2791
|
-
};
|
|
2792
|
-
/**
|
|
2793
|
-
* @public
|
|
2794
|
-
*/
|
|
2795
|
-
export type RelativeFontSize = (typeof RelativeFontSize)[keyof typeof RelativeFontSize];
|
|
2796
|
-
/**
|
|
2797
|
-
* <p>The option that determines the text display size.</p>
|
|
2798
|
-
* @public
|
|
2799
|
-
*/
|
|
2800
|
-
export interface FontSize {
|
|
2801
|
-
/**
|
|
2802
|
-
* <p>The lexical name for the text size, proportional to its surrounding context.</p>
|
|
2803
|
-
* @public
|
|
2804
|
-
*/
|
|
2805
|
-
Relative?: RelativeFontSize;
|
|
2806
|
-
}
|
|
2807
|
-
/**
|
|
2808
|
-
* @public
|
|
2809
|
-
* @enum
|
|
2810
|
-
*/
|
|
2811
|
-
export declare const FontStyle: {
|
|
2812
|
-
readonly ITALIC: "ITALIC";
|
|
2813
|
-
readonly NORMAL: "NORMAL";
|
|
2814
|
-
};
|
|
2815
|
-
/**
|
|
2816
|
-
* @public
|
|
2817
|
-
*/
|
|
2818
|
-
export type FontStyle = (typeof FontStyle)[keyof typeof FontStyle];
|
|
2819
|
-
/**
|
|
2820
|
-
* @public
|
|
2821
|
-
* @enum
|
|
2822
|
-
*/
|
|
2823
|
-
export declare const FontWeightName: {
|
|
2824
|
-
readonly BOLD: "BOLD";
|
|
2825
|
-
readonly NORMAL: "NORMAL";
|
|
2826
|
-
};
|
|
2827
|
-
/**
|
|
2828
|
-
* @public
|
|
2829
|
-
*/
|
|
2830
|
-
export type FontWeightName = (typeof FontWeightName)[keyof typeof FontWeightName];
|
|
2831
|
-
/**
|
|
2832
|
-
* <p>The option that determines the text display weight, or boldness.</p>
|
|
2833
|
-
* @public
|
|
2834
|
-
*/
|
|
2835
|
-
export interface FontWeight {
|
|
2836
|
-
/**
|
|
2837
|
-
* <p>The lexical name for the level of boldness of the text display.</p>
|
|
2838
|
-
* @public
|
|
2839
|
-
*/
|
|
2840
|
-
Name?: FontWeightName;
|
|
2841
|
-
}
|
|
2842
|
-
/**
|
|
2843
|
-
* <p>Configures the display properties of the given text.</p>
|
|
2844
|
-
* @public
|
|
2845
|
-
*/
|
|
2846
|
-
export interface FontConfiguration {
|
|
2847
|
-
/**
|
|
2848
|
-
* <p>The option that determines the text display size.</p>
|
|
2849
|
-
* @public
|
|
2850
|
-
*/
|
|
2851
|
-
FontSize?: FontSize;
|
|
2852
|
-
/**
|
|
2853
|
-
* <p>Determines the appearance of decorative lines on the text.</p>
|
|
2854
|
-
* @public
|
|
2855
|
-
*/
|
|
2856
|
-
FontDecoration?: FontDecoration;
|
|
2857
|
-
/**
|
|
2858
|
-
* <p>Determines the color of the text.</p>
|
|
2859
|
-
* @public
|
|
2860
|
-
*/
|
|
2861
|
-
FontColor?: string;
|
|
2862
|
-
/**
|
|
2863
|
-
* <p>The option that determines the text display weight, or boldness.</p>
|
|
2864
|
-
* @public
|
|
2865
|
-
*/
|
|
2866
|
-
FontWeight?: FontWeight;
|
|
2867
|
-
/**
|
|
2868
|
-
* <p>Determines the text display face that is inherited by the given font family.</p>
|
|
2869
|
-
* @public
|
|
2870
|
-
*/
|
|
2871
|
-
FontStyle?: FontStyle;
|
|
2872
|
-
}
|
|
2873
|
-
/**
|
|
2874
|
-
* <p>The share label options for the labels.</p>
|
|
2875
|
-
* @public
|
|
2876
|
-
*/
|
|
2877
|
-
export interface LabelOptions {
|
|
2878
|
-
/**
|
|
2879
|
-
* <p>Determines whether or not the label is visible.</p>
|
|
2880
|
-
* @public
|
|
2881
|
-
*/
|
|
2882
|
-
Visibility?: Visibility;
|
|
2883
|
-
/**
|
|
2884
|
-
* <p>The font configuration of the label.</p>
|
|
2885
|
-
* @public
|
|
2886
|
-
*/
|
|
2887
|
-
FontConfiguration?: FontConfiguration;
|
|
2888
|
-
/**
|
|
2889
|
-
* <p>The text for the label.</p>
|
|
2890
|
-
* @public
|
|
2891
|
-
*/
|
|
2892
|
-
CustomLabel?: string;
|
|
2893
|
-
}
|
|
2894
|
-
/**
|
|
2895
|
-
* <p>The display options of a control.</p>
|
|
2896
|
-
* @public
|
|
2897
|
-
*/
|
|
2898
|
-
export interface DateTimePickerControlDisplayOptions {
|
|
3330
|
+
*/
|
|
3331
|
+
ParameterValueType: ParameterValueType | undefined;
|
|
2899
3332
|
/**
|
|
2900
|
-
* <p>The
|
|
3333
|
+
* <p>The name of the parameter that is being declared.</p>
|
|
2901
3334
|
* @public
|
|
2902
3335
|
*/
|
|
2903
|
-
|
|
3336
|
+
Name: string | undefined;
|
|
2904
3337
|
/**
|
|
2905
|
-
* <p>
|
|
3338
|
+
* <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>
|
|
2906
3339
|
* @public
|
|
2907
3340
|
*/
|
|
2908
|
-
|
|
3341
|
+
DefaultValues?: StringDefaultValues;
|
|
2909
3342
|
/**
|
|
2910
|
-
* <p>The configuration of
|
|
3343
|
+
* <p>The configuration that defines the default value of a <code>String</code> parameter when a value has not been set.</p>
|
|
2911
3344
|
* @public
|
|
2912
3345
|
*/
|
|
2913
|
-
|
|
3346
|
+
ValueWhenUnset?: StringValueWhenUnsetConfiguration;
|
|
3347
|
+
/**
|
|
3348
|
+
* <p>A list of dataset parameters that are mapped to an analysis parameter.</p>
|
|
3349
|
+
* @public
|
|
3350
|
+
*/
|
|
3351
|
+
MappedDataSetParameters?: MappedDataSetParameter[];
|
|
2914
3352
|
}
|
|
2915
3353
|
/**
|
|
2916
|
-
*
|
|
2917
|
-
*
|
|
2918
|
-
|
|
2919
|
-
export declare const SheetControlDateTimePickerType: {
|
|
2920
|
-
readonly DATE_RANGE: "DATE_RANGE";
|
|
2921
|
-
readonly SINGLE_VALUED: "SINGLE_VALUED";
|
|
2922
|
-
};
|
|
2923
|
-
/**
|
|
2924
|
-
* @public
|
|
2925
|
-
*/
|
|
2926
|
-
export type SheetControlDateTimePickerType = (typeof SheetControlDateTimePickerType)[keyof typeof SheetControlDateTimePickerType];
|
|
2927
|
-
/**
|
|
2928
|
-
* <p>A control from a date filter that is used to specify date and time.</p>
|
|
3354
|
+
* <p>The declaration definition of a parameter.</p>
|
|
3355
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
3356
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
2929
3357
|
* @public
|
|
2930
3358
|
*/
|
|
2931
|
-
export interface
|
|
2932
|
-
/**
|
|
2933
|
-
* <p>The ID of the <code>FilterDateTimePickerControl</code>.</p>
|
|
2934
|
-
* @public
|
|
2935
|
-
*/
|
|
2936
|
-
FilterControlId: string | undefined;
|
|
3359
|
+
export interface ParameterDeclaration {
|
|
2937
3360
|
/**
|
|
2938
|
-
* <p>
|
|
3361
|
+
* <p>A parameter declaration for the <code>String</code> data type.</p>
|
|
2939
3362
|
* @public
|
|
2940
3363
|
*/
|
|
2941
|
-
|
|
3364
|
+
StringParameterDeclaration?: StringParameterDeclaration;
|
|
2942
3365
|
/**
|
|
2943
|
-
* <p>
|
|
3366
|
+
* <p>A parameter declaration for the <code>Decimal</code> data type.</p>
|
|
2944
3367
|
* @public
|
|
2945
3368
|
*/
|
|
2946
|
-
|
|
3369
|
+
DecimalParameterDeclaration?: DecimalParameterDeclaration;
|
|
2947
3370
|
/**
|
|
2948
|
-
* <p>
|
|
3371
|
+
* <p>A parameter declaration for the <code>Integer</code> data type.</p>
|
|
2949
3372
|
* @public
|
|
2950
3373
|
*/
|
|
2951
|
-
|
|
3374
|
+
IntegerParameterDeclaration?: IntegerParameterDeclaration;
|
|
2952
3375
|
/**
|
|
2953
|
-
* <p>
|
|
2954
|
-
* <ul>
|
|
2955
|
-
* <li>
|
|
2956
|
-
* <p>
|
|
2957
|
-
* <code>SINGLE_VALUED</code>: The filter condition is a fixed date.</p>
|
|
2958
|
-
* </li>
|
|
2959
|
-
* <li>
|
|
2960
|
-
* <p>
|
|
2961
|
-
* <code>DATE_RANGE</code>: The filter condition is a date time range.</p>
|
|
2962
|
-
* </li>
|
|
2963
|
-
* </ul>
|
|
3376
|
+
* <p>A parameter declaration for the <code>DateTime</code> data type.</p>
|
|
2964
3377
|
* @public
|
|
2965
3378
|
*/
|
|
2966
|
-
|
|
3379
|
+
DateTimeParameterDeclaration?: DateTimeParameterDeclaration;
|
|
2967
3380
|
}
|
|
2968
3381
|
/**
|
|
2969
3382
|
* <p>The source controls that are used in a <code>CascadingControlConfiguration</code>.</p>
|
|
@@ -2993,61 +3406,67 @@ export interface CascadingControlConfiguration {
|
|
|
2993
3406
|
SourceControls?: CascadingControlSource[];
|
|
2994
3407
|
}
|
|
2995
3408
|
/**
|
|
2996
|
-
* <p>
|
|
3409
|
+
* <p>A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet</p>
|
|
2997
3410
|
* @public
|
|
2998
3411
|
*/
|
|
2999
|
-
export interface
|
|
3412
|
+
export interface FilterCrossSheetControl {
|
|
3000
3413
|
/**
|
|
3001
|
-
* <p>The
|
|
3414
|
+
* <p>The ID of the <code>FilterCrossSheetControl</code>.</p>
|
|
3002
3415
|
* @public
|
|
3003
3416
|
*/
|
|
3004
|
-
|
|
3417
|
+
FilterControlId: string | undefined;
|
|
3418
|
+
/**
|
|
3419
|
+
* <p>The source filter ID of the <code>FilterCrossSheetControl</code>.</p>
|
|
3420
|
+
* @public
|
|
3421
|
+
*/
|
|
3422
|
+
SourceFilterId: string | undefined;
|
|
3423
|
+
/**
|
|
3424
|
+
* <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>
|
|
3425
|
+
* @public
|
|
3426
|
+
*/
|
|
3427
|
+
CascadingControlConfiguration?: CascadingControlConfiguration;
|
|
3005
3428
|
}
|
|
3006
3429
|
/**
|
|
3007
|
-
* <p>
|
|
3430
|
+
* <p>A control from a date filter that is used to specify date and time.</p>
|
|
3008
3431
|
* @public
|
|
3009
3432
|
*/
|
|
3010
|
-
export interface
|
|
3433
|
+
export interface FilterDateTimePickerControl {
|
|
3011
3434
|
/**
|
|
3012
|
-
* <p>The
|
|
3013
|
-
* dropdown control.</p>
|
|
3435
|
+
* <p>The ID of the <code>FilterDateTimePickerControl</code>.</p>
|
|
3014
3436
|
* @public
|
|
3015
3437
|
*/
|
|
3016
|
-
|
|
3438
|
+
FilterControlId: string | undefined;
|
|
3017
3439
|
/**
|
|
3018
|
-
* <p>The
|
|
3440
|
+
* <p>The title of the <code>FilterDateTimePickerControl</code>.</p>
|
|
3019
3441
|
* @public
|
|
3020
3442
|
*/
|
|
3021
|
-
|
|
3443
|
+
Title: string | undefined;
|
|
3022
3444
|
/**
|
|
3023
|
-
* <p>The
|
|
3445
|
+
* <p>The source filter ID of the <code>FilterDateTimePickerControl</code>.</p>
|
|
3024
3446
|
* @public
|
|
3025
3447
|
*/
|
|
3026
|
-
|
|
3027
|
-
}
|
|
3028
|
-
/**
|
|
3029
|
-
* <p>A list of selectable values that are used in a control.</p>
|
|
3030
|
-
* @public
|
|
3031
|
-
*/
|
|
3032
|
-
export interface FilterSelectableValues {
|
|
3448
|
+
SourceFilterId: string | undefined;
|
|
3033
3449
|
/**
|
|
3034
|
-
* <p>The
|
|
3450
|
+
* <p>The display options of a control.</p>
|
|
3035
3451
|
* @public
|
|
3036
3452
|
*/
|
|
3037
|
-
|
|
3453
|
+
DisplayOptions?: DateTimePickerControlDisplayOptions;
|
|
3454
|
+
/**
|
|
3455
|
+
* <p>The type of the <code>FilterDropDownControl</code>. Choose one of the following options:</p>
|
|
3456
|
+
* <ul>
|
|
3457
|
+
* <li>
|
|
3458
|
+
* <p>
|
|
3459
|
+
* <code>MULTI_SELECT</code>: The user can select multiple entries from a dropdown menu.</p>
|
|
3460
|
+
* </li>
|
|
3461
|
+
* <li>
|
|
3462
|
+
* <p>
|
|
3463
|
+
* <code>SINGLE_SELECT</code>: The user can select a single entry from a dropdown menu.</p>
|
|
3464
|
+
* </li>
|
|
3465
|
+
* </ul>
|
|
3466
|
+
* @public
|
|
3467
|
+
*/
|
|
3468
|
+
Type?: SheetControlDateTimePickerType;
|
|
3038
3469
|
}
|
|
3039
|
-
/**
|
|
3040
|
-
* @public
|
|
3041
|
-
* @enum
|
|
3042
|
-
*/
|
|
3043
|
-
export declare const SheetControlListType: {
|
|
3044
|
-
readonly MULTI_SELECT: "MULTI_SELECT";
|
|
3045
|
-
readonly SINGLE_SELECT: "SINGLE_SELECT";
|
|
3046
|
-
};
|
|
3047
|
-
/**
|
|
3048
|
-
* @public
|
|
3049
|
-
*/
|
|
3050
|
-
export type SheetControlListType = (typeof SheetControlListType)[keyof typeof SheetControlListType];
|
|
3051
3470
|
/**
|
|
3052
3471
|
* <p>A control to display a dropdown list with buttons that are used to select a single value.</p>
|
|
3053
3472
|
* @public
|
|
@@ -3099,43 +3518,6 @@ export interface FilterDropDownControl {
|
|
|
3099
3518
|
*/
|
|
3100
3519
|
CascadingControlConfiguration?: CascadingControlConfiguration;
|
|
3101
3520
|
}
|
|
3102
|
-
/**
|
|
3103
|
-
* <p>The configuration of the search options in a list control.</p>
|
|
3104
|
-
* @public
|
|
3105
|
-
*/
|
|
3106
|
-
export interface ListControlSearchOptions {
|
|
3107
|
-
/**
|
|
3108
|
-
* <p>The visibility configuration of the search options in a list control.</p>
|
|
3109
|
-
* @public
|
|
3110
|
-
*/
|
|
3111
|
-
Visibility?: Visibility;
|
|
3112
|
-
}
|
|
3113
|
-
/**
|
|
3114
|
-
* <p>The display options of a control.</p>
|
|
3115
|
-
* @public
|
|
3116
|
-
*/
|
|
3117
|
-
export interface ListControlDisplayOptions {
|
|
3118
|
-
/**
|
|
3119
|
-
* <p>The configuration of the search options in a list control.</p>
|
|
3120
|
-
* @public
|
|
3121
|
-
*/
|
|
3122
|
-
SearchOptions?: ListControlSearchOptions;
|
|
3123
|
-
/**
|
|
3124
|
-
* <p>The configuration of the <code>Select all</code> options in a list control.</p>
|
|
3125
|
-
* @public
|
|
3126
|
-
*/
|
|
3127
|
-
SelectAllOptions?: ListControlSelectAllOptions;
|
|
3128
|
-
/**
|
|
3129
|
-
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
3130
|
-
* @public
|
|
3131
|
-
*/
|
|
3132
|
-
TitleOptions?: LabelOptions;
|
|
3133
|
-
/**
|
|
3134
|
-
* <p>The configuration of info icon label options.</p>
|
|
3135
|
-
* @public
|
|
3136
|
-
*/
|
|
3137
|
-
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
3138
|
-
}
|
|
3139
3521
|
/**
|
|
3140
3522
|
* <p>A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.</p>
|
|
3141
3523
|
* @public
|
|
@@ -3162,7 +3544,7 @@ export interface FilterListControl {
|
|
|
3162
3544
|
*/
|
|
3163
3545
|
DisplayOptions?: ListControlDisplayOptions;
|
|
3164
3546
|
/**
|
|
3165
|
-
* <p>The type of <code>FilterListControl</code>. Choose one of the following options:</p>
|
|
3547
|
+
* <p>The type of the <code>FilterListControl</code>. Choose one of the following options:</p>
|
|
3166
3548
|
* <ul>
|
|
3167
3549
|
* <li>
|
|
3168
3550
|
* <p>
|
|
@@ -3187,27 +3569,6 @@ export interface FilterListControl {
|
|
|
3187
3569
|
*/
|
|
3188
3570
|
CascadingControlConfiguration?: CascadingControlConfiguration;
|
|
3189
3571
|
}
|
|
3190
|
-
/**
|
|
3191
|
-
* <p>The display options of a control.</p>
|
|
3192
|
-
* @public
|
|
3193
|
-
*/
|
|
3194
|
-
export interface RelativeDateTimeControlDisplayOptions {
|
|
3195
|
-
/**
|
|
3196
|
-
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
3197
|
-
* @public
|
|
3198
|
-
*/
|
|
3199
|
-
TitleOptions?: LabelOptions;
|
|
3200
|
-
/**
|
|
3201
|
-
* <p>Customize how dates are formatted in controls.</p>
|
|
3202
|
-
* @public
|
|
3203
|
-
*/
|
|
3204
|
-
DateTimeFormat?: string;
|
|
3205
|
-
/**
|
|
3206
|
-
* <p>The configuration of info icon label options.</p>
|
|
3207
|
-
* @public
|
|
3208
|
-
*/
|
|
3209
|
-
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
3210
|
-
}
|
|
3211
3572
|
/**
|
|
3212
3573
|
* <p>A control from a date filter that is used to specify the relative date.</p>
|
|
3213
3574
|
* @public
|
|
@@ -3234,34 +3595,6 @@ export interface FilterRelativeDateTimeControl {
|
|
|
3234
3595
|
*/
|
|
3235
3596
|
DisplayOptions?: RelativeDateTimeControlDisplayOptions;
|
|
3236
3597
|
}
|
|
3237
|
-
/**
|
|
3238
|
-
* <p>The display options of a control.</p>
|
|
3239
|
-
* @public
|
|
3240
|
-
*/
|
|
3241
|
-
export interface SliderControlDisplayOptions {
|
|
3242
|
-
/**
|
|
3243
|
-
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
3244
|
-
* @public
|
|
3245
|
-
*/
|
|
3246
|
-
TitleOptions?: LabelOptions;
|
|
3247
|
-
/**
|
|
3248
|
-
* <p>The configuration of info icon label options.</p>
|
|
3249
|
-
* @public
|
|
3250
|
-
*/
|
|
3251
|
-
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
3252
|
-
}
|
|
3253
|
-
/**
|
|
3254
|
-
* @public
|
|
3255
|
-
* @enum
|
|
3256
|
-
*/
|
|
3257
|
-
export declare const SheetControlSliderType: {
|
|
3258
|
-
readonly RANGE: "RANGE";
|
|
3259
|
-
readonly SINGLE_POINT: "SINGLE_POINT";
|
|
3260
|
-
};
|
|
3261
|
-
/**
|
|
3262
|
-
* @public
|
|
3263
|
-
*/
|
|
3264
|
-
export type SheetControlSliderType = (typeof SheetControlSliderType)[keyof typeof SheetControlSliderType];
|
|
3265
3598
|
/**
|
|
3266
3599
|
* <p>A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.</p>
|
|
3267
3600
|
* @public
|
|
@@ -3288,67 +3621,35 @@ export interface FilterSliderControl {
|
|
|
3288
3621
|
*/
|
|
3289
3622
|
DisplayOptions?: SliderControlDisplayOptions;
|
|
3290
3623
|
/**
|
|
3291
|
-
* <p>The type of <code>FilterSliderControl</code>. Choose one of the following options:</p>
|
|
3624
|
+
* <p>The type of the <code>FilterSliderControl</code>. Choose one of the following options:</p>
|
|
3292
3625
|
* <ul>
|
|
3293
|
-
* <li>
|
|
3294
|
-
* <p>
|
|
3295
|
-
* <code>SINGLE_POINT</code>: Filter against(equals) a single data point.</p>
|
|
3296
|
-
* </li>
|
|
3297
|
-
* <li>
|
|
3298
|
-
* <p>
|
|
3299
|
-
* <code>RANGE</code>: Filter data that is in a specified range.</p>
|
|
3300
|
-
* </li>
|
|
3301
|
-
* </ul>
|
|
3302
|
-
* @public
|
|
3303
|
-
*/
|
|
3304
|
-
Type?: SheetControlSliderType;
|
|
3305
|
-
/**
|
|
3306
|
-
* <p>The smaller value that is displayed at the left of the slider.</p>
|
|
3307
|
-
* @public
|
|
3308
|
-
*/
|
|
3309
|
-
MaximumValue: number | undefined;
|
|
3310
|
-
/**
|
|
3311
|
-
* <p>The larger value that is displayed at the right of the slider.</p>
|
|
3312
|
-
* @public
|
|
3313
|
-
*/
|
|
3314
|
-
MinimumValue: number | undefined;
|
|
3315
|
-
/**
|
|
3316
|
-
* <p>The number of increments that the slider bar is divided into.</p>
|
|
3317
|
-
* @public
|
|
3318
|
-
*/
|
|
3319
|
-
StepSize: number | undefined;
|
|
3320
|
-
}
|
|
3321
|
-
/**
|
|
3322
|
-
* <p>The configuration of the placeholder options in a text control.</p>
|
|
3323
|
-
* @public
|
|
3324
|
-
*/
|
|
3325
|
-
export interface TextControlPlaceholderOptions {
|
|
3326
|
-
/**
|
|
3327
|
-
* <p>The visibility configuration of the placeholder options in a text control.</p>
|
|
3626
|
+
* <li>
|
|
3627
|
+
* <p>
|
|
3628
|
+
* <code>SINGLE_POINT</code>: Filter against(equals) a single data point.</p>
|
|
3629
|
+
* </li>
|
|
3630
|
+
* <li>
|
|
3631
|
+
* <p>
|
|
3632
|
+
* <code>RANGE</code>: Filter data that is in a specified range.</p>
|
|
3633
|
+
* </li>
|
|
3634
|
+
* </ul>
|
|
3328
3635
|
* @public
|
|
3329
3636
|
*/
|
|
3330
|
-
|
|
3331
|
-
}
|
|
3332
|
-
/**
|
|
3333
|
-
* <p>The display options of a control.</p>
|
|
3334
|
-
* @public
|
|
3335
|
-
*/
|
|
3336
|
-
export interface TextAreaControlDisplayOptions {
|
|
3637
|
+
Type?: SheetControlSliderType;
|
|
3337
3638
|
/**
|
|
3338
|
-
* <p>The
|
|
3639
|
+
* <p>The larger value that is displayed at the right of the slider.</p>
|
|
3339
3640
|
* @public
|
|
3340
3641
|
*/
|
|
3341
|
-
|
|
3642
|
+
MaximumValue: number | undefined;
|
|
3342
3643
|
/**
|
|
3343
|
-
* <p>The
|
|
3644
|
+
* <p>The smaller value that is displayed at the left of the slider.</p>
|
|
3344
3645
|
* @public
|
|
3345
3646
|
*/
|
|
3346
|
-
|
|
3647
|
+
MinimumValue: number | undefined;
|
|
3347
3648
|
/**
|
|
3348
|
-
* <p>The
|
|
3649
|
+
* <p>The number of increments that the slider bar is divided into.</p>
|
|
3349
3650
|
* @public
|
|
3350
3651
|
*/
|
|
3351
|
-
|
|
3652
|
+
StepSize: number | undefined;
|
|
3352
3653
|
}
|
|
3353
3654
|
/**
|
|
3354
3655
|
* <p>A control to display a text box that is used to enter multiple entries.</p>
|
|
@@ -3381,27 +3682,6 @@ export interface FilterTextAreaControl {
|
|
|
3381
3682
|
*/
|
|
3382
3683
|
DisplayOptions?: TextAreaControlDisplayOptions;
|
|
3383
3684
|
}
|
|
3384
|
-
/**
|
|
3385
|
-
* <p>The display options of a control.</p>
|
|
3386
|
-
* @public
|
|
3387
|
-
*/
|
|
3388
|
-
export interface TextFieldControlDisplayOptions {
|
|
3389
|
-
/**
|
|
3390
|
-
* <p>The options to configure the title visibility, name, and font size.</p>
|
|
3391
|
-
* @public
|
|
3392
|
-
*/
|
|
3393
|
-
TitleOptions?: LabelOptions;
|
|
3394
|
-
/**
|
|
3395
|
-
* <p>The configuration of the placeholder options in a text field control.</p>
|
|
3396
|
-
* @public
|
|
3397
|
-
*/
|
|
3398
|
-
PlaceholderOptions?: TextControlPlaceholderOptions;
|
|
3399
|
-
/**
|
|
3400
|
-
* <p>The configuration of info icon label options.</p>
|
|
3401
|
-
* @public
|
|
3402
|
-
*/
|
|
3403
|
-
InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
|
|
3404
|
-
}
|
|
3405
3685
|
/**
|
|
3406
3686
|
* <p>A control to display a text box that is used to enter a single entry.</p>
|
|
3407
3687
|
* @public
|
|
@@ -3469,6 +3749,11 @@ export interface FilterControl {
|
|
|
3469
3749
|
* @public
|
|
3470
3750
|
*/
|
|
3471
3751
|
RelativeDateTime?: FilterRelativeDateTimeControl;
|
|
3752
|
+
/**
|
|
3753
|
+
* <p>A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet</p>
|
|
3754
|
+
* @public
|
|
3755
|
+
*/
|
|
3756
|
+
CrossSheet?: FilterCrossSheetControl;
|
|
3472
3757
|
}
|
|
3473
3758
|
/**
|
|
3474
3759
|
* <p>The background style configuration of a free-form layout element.</p>
|
|
@@ -4045,12 +4330,12 @@ export interface ParameterSliderControl {
|
|
|
4045
4330
|
*/
|
|
4046
4331
|
DisplayOptions?: SliderControlDisplayOptions;
|
|
4047
4332
|
/**
|
|
4048
|
-
* <p>The
|
|
4333
|
+
* <p>The larger value that is displayed at the right of the slider.</p>
|
|
4049
4334
|
* @public
|
|
4050
4335
|
*/
|
|
4051
4336
|
MaximumValue: number | undefined;
|
|
4052
4337
|
/**
|
|
4053
|
-
* <p>The
|
|
4338
|
+
* <p>The smaller value that is displayed at the left of the slider.</p>
|
|
4054
4339
|
* @public
|
|
4055
4340
|
*/
|
|
4056
4341
|
MinimumValue: number | undefined;
|
|
@@ -6378,283 +6663,6 @@ export interface DataPathType {
|
|
|
6378
6663
|
*/
|
|
6379
6664
|
PivotTableDataPathType?: PivotTableDataPathType;
|
|
6380
6665
|
}
|
|
6381
|
-
/**
|
|
6382
|
-
* <p>The data path that needs to be sorted.</p>
|
|
6383
|
-
* @public
|
|
6384
|
-
*/
|
|
6385
|
-
export interface DataPathValue {
|
|
6386
|
-
/**
|
|
6387
|
-
* <p>The field ID of the field that needs to be sorted.</p>
|
|
6388
|
-
* @public
|
|
6389
|
-
*/
|
|
6390
|
-
FieldId?: string;
|
|
6391
|
-
/**
|
|
6392
|
-
* <p>The actual value of the field that needs to be sorted.</p>
|
|
6393
|
-
* @public
|
|
6394
|
-
*/
|
|
6395
|
-
FieldValue?: string;
|
|
6396
|
-
/**
|
|
6397
|
-
* <p>The type configuration of the field.</p>
|
|
6398
|
-
* @public
|
|
6399
|
-
*/
|
|
6400
|
-
DataPathType?: DataPathType;
|
|
6401
|
-
}
|
|
6402
|
-
/**
|
|
6403
|
-
* <p>The color map that determines the color options for a particular element.</p>
|
|
6404
|
-
* @public
|
|
6405
|
-
*/
|
|
6406
|
-
export interface DataPathColor {
|
|
6407
|
-
/**
|
|
6408
|
-
* <p>The element that the color needs to be applied to.</p>
|
|
6409
|
-
* @public
|
|
6410
|
-
*/
|
|
6411
|
-
Element: DataPathValue | undefined;
|
|
6412
|
-
/**
|
|
6413
|
-
* <p>The color that needs to be applied to the element.</p>
|
|
6414
|
-
* @public
|
|
6415
|
-
*/
|
|
6416
|
-
Color: string | undefined;
|
|
6417
|
-
/**
|
|
6418
|
-
* <p>The time granularity of the field that the color needs to be applied to.</p>
|
|
6419
|
-
* @public
|
|
6420
|
-
*/
|
|
6421
|
-
TimeGranularity?: TimeGranularity;
|
|
6422
|
-
}
|
|
6423
|
-
/**
|
|
6424
|
-
* <p>The visual display options for the visual palette.</p>
|
|
6425
|
-
* @public
|
|
6426
|
-
*/
|
|
6427
|
-
export interface VisualPalette {
|
|
6428
|
-
/**
|
|
6429
|
-
* <p>The chart color options for the visual palette.</p>
|
|
6430
|
-
* @public
|
|
6431
|
-
*/
|
|
6432
|
-
ChartColor?: string;
|
|
6433
|
-
/**
|
|
6434
|
-
* <p>The color map options for the visual palette.</p>
|
|
6435
|
-
* @public
|
|
6436
|
-
*/
|
|
6437
|
-
ColorMap?: DataPathColor[];
|
|
6438
|
-
}
|
|
6439
|
-
/**
|
|
6440
|
-
* <p>The configuration of a <code>BarChartVisual</code>.</p>
|
|
6441
|
-
* @public
|
|
6442
|
-
*/
|
|
6443
|
-
export interface BarChartConfiguration {
|
|
6444
|
-
/**
|
|
6445
|
-
* <p>The field wells of the visual.</p>
|
|
6446
|
-
* @public
|
|
6447
|
-
*/
|
|
6448
|
-
FieldWells?: BarChartFieldWells;
|
|
6449
|
-
/**
|
|
6450
|
-
* <p>The sort configuration of a <code>BarChartVisual</code>.</p>
|
|
6451
|
-
* @public
|
|
6452
|
-
*/
|
|
6453
|
-
SortConfiguration?: BarChartSortConfiguration;
|
|
6454
|
-
/**
|
|
6455
|
-
* <p>The orientation of the bars in a bar chart visual. There are two valid values in this structure:</p>
|
|
6456
|
-
* <ul>
|
|
6457
|
-
* <li>
|
|
6458
|
-
* <p>
|
|
6459
|
-
* <code>HORIZONTAL</code>: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.</p>
|
|
6460
|
-
* </li>
|
|
6461
|
-
* <li>
|
|
6462
|
-
* <p>
|
|
6463
|
-
* <code>VERTICAL</code>: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.</p>
|
|
6464
|
-
* </li>
|
|
6465
|
-
* </ul>
|
|
6466
|
-
* @public
|
|
6467
|
-
*/
|
|
6468
|
-
Orientation?: BarChartOrientation;
|
|
6469
|
-
/**
|
|
6470
|
-
* <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>
|
|
6471
|
-
* @public
|
|
6472
|
-
*/
|
|
6473
|
-
BarsArrangement?: BarsArrangement;
|
|
6474
|
-
/**
|
|
6475
|
-
* <p>The palette (chart color) display setup of the visual.</p>
|
|
6476
|
-
* @public
|
|
6477
|
-
*/
|
|
6478
|
-
VisualPalette?: VisualPalette;
|
|
6479
|
-
/**
|
|
6480
|
-
* <p>The small multiples setup for the visual.</p>
|
|
6481
|
-
* @public
|
|
6482
|
-
*/
|
|
6483
|
-
SmallMultiplesOptions?: SmallMultiplesOptions;
|
|
6484
|
-
/**
|
|
6485
|
-
* <p>The label display options (grid line, range, scale, axis step) for bar chart category.</p>
|
|
6486
|
-
* @public
|
|
6487
|
-
*/
|
|
6488
|
-
CategoryAxis?: AxisDisplayOptions;
|
|
6489
|
-
/**
|
|
6490
|
-
* <p>The label options (label text, label visibility and sort icon visibility) for a bar chart.</p>
|
|
6491
|
-
* @public
|
|
6492
|
-
*/
|
|
6493
|
-
CategoryLabelOptions?: ChartAxisLabelOptions;
|
|
6494
|
-
/**
|
|
6495
|
-
* <p>The label display options (grid line, range, scale, axis step) for a bar chart value.</p>
|
|
6496
|
-
* @public
|
|
6497
|
-
*/
|
|
6498
|
-
ValueAxis?: AxisDisplayOptions;
|
|
6499
|
-
/**
|
|
6500
|
-
* <p>The label options (label text, label visibility and sort icon visibility) for a bar chart value.</p>
|
|
6501
|
-
* @public
|
|
6502
|
-
*/
|
|
6503
|
-
ValueLabelOptions?: ChartAxisLabelOptions;
|
|
6504
|
-
/**
|
|
6505
|
-
* <p>The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.</p>
|
|
6506
|
-
* @public
|
|
6507
|
-
*/
|
|
6508
|
-
ColorLabelOptions?: ChartAxisLabelOptions;
|
|
6509
|
-
/**
|
|
6510
|
-
* <p>The legend display setup of the visual.</p>
|
|
6511
|
-
* @public
|
|
6512
|
-
*/
|
|
6513
|
-
Legend?: LegendOptions;
|
|
6514
|
-
/**
|
|
6515
|
-
* <p>The options that determine if visual data labels are displayed.</p>
|
|
6516
|
-
* @public
|
|
6517
|
-
*/
|
|
6518
|
-
DataLabels?: DataLabelOptions;
|
|
6519
|
-
/**
|
|
6520
|
-
* <p>The tooltip display setup of the visual.</p>
|
|
6521
|
-
* @public
|
|
6522
|
-
*/
|
|
6523
|
-
Tooltip?: TooltipOptions;
|
|
6524
|
-
/**
|
|
6525
|
-
* <p>The reference line setup of the visual.</p>
|
|
6526
|
-
* @public
|
|
6527
|
-
*/
|
|
6528
|
-
ReferenceLines?: ReferenceLine[];
|
|
6529
|
-
/**
|
|
6530
|
-
* <p>The contribution analysis (anomaly configuration) setup of the visual.</p>
|
|
6531
|
-
* @public
|
|
6532
|
-
*/
|
|
6533
|
-
ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
|
|
6534
|
-
/**
|
|
6535
|
-
* <p>The general visual interactions setup for a visual.</p>
|
|
6536
|
-
* @public
|
|
6537
|
-
*/
|
|
6538
|
-
Interactions?: VisualInteractionOptions;
|
|
6539
|
-
}
|
|
6540
|
-
/**
|
|
6541
|
-
* <p>The numeric equality type drill down filter.</p>
|
|
6542
|
-
* @public
|
|
6543
|
-
*/
|
|
6544
|
-
export interface CategoryDrillDownFilter {
|
|
6545
|
-
/**
|
|
6546
|
-
* <p>The column that the filter is applied to.</p>
|
|
6547
|
-
* @public
|
|
6548
|
-
*/
|
|
6549
|
-
Column: ColumnIdentifier | undefined;
|
|
6550
|
-
/**
|
|
6551
|
-
* <p>A list of the string inputs that are the values of the category drill down filter.</p>
|
|
6552
|
-
* @public
|
|
6553
|
-
*/
|
|
6554
|
-
CategoryValues: string[] | undefined;
|
|
6555
|
-
}
|
|
6556
|
-
/**
|
|
6557
|
-
* <p>The category drill down filter.</p>
|
|
6558
|
-
* @public
|
|
6559
|
-
*/
|
|
6560
|
-
export interface NumericEqualityDrillDownFilter {
|
|
6561
|
-
/**
|
|
6562
|
-
* <p>The column that the filter is applied to.</p>
|
|
6563
|
-
* @public
|
|
6564
|
-
*/
|
|
6565
|
-
Column: ColumnIdentifier | undefined;
|
|
6566
|
-
/**
|
|
6567
|
-
* <p>The value of the double input numeric drill down filter.</p>
|
|
6568
|
-
* @public
|
|
6569
|
-
*/
|
|
6570
|
-
Value: number | undefined;
|
|
6571
|
-
}
|
|
6572
|
-
/**
|
|
6573
|
-
* <p>The time range drill down filter.</p>
|
|
6574
|
-
* @public
|
|
6575
|
-
*/
|
|
6576
|
-
export interface TimeRangeDrillDownFilter {
|
|
6577
|
-
/**
|
|
6578
|
-
* <p>The column that the filter is applied to.</p>
|
|
6579
|
-
* @public
|
|
6580
|
-
*/
|
|
6581
|
-
Column: ColumnIdentifier | undefined;
|
|
6582
|
-
/**
|
|
6583
|
-
* <p>The minimum value for the filter value range.</p>
|
|
6584
|
-
* @public
|
|
6585
|
-
*/
|
|
6586
|
-
RangeMinimum: Date | undefined;
|
|
6587
|
-
/**
|
|
6588
|
-
* <p>The maximum value for the filter value range.</p>
|
|
6589
|
-
* @public
|
|
6590
|
-
*/
|
|
6591
|
-
RangeMaximum: Date | undefined;
|
|
6592
|
-
/**
|
|
6593
|
-
* <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
|
|
6594
|
-
* @public
|
|
6595
|
-
*/
|
|
6596
|
-
TimeGranularity: TimeGranularity | undefined;
|
|
6597
|
-
}
|
|
6598
|
-
/**
|
|
6599
|
-
* <p>The drill down filter for the column hierarchies.</p>
|
|
6600
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
6601
|
-
* @public
|
|
6602
|
-
*/
|
|
6603
|
-
export interface DrillDownFilter {
|
|
6604
|
-
/**
|
|
6605
|
-
* <p>The numeric equality type drill down filter. This filter is used for number type columns.</p>
|
|
6606
|
-
* @public
|
|
6607
|
-
*/
|
|
6608
|
-
NumericEqualityFilter?: NumericEqualityDrillDownFilter;
|
|
6609
|
-
/**
|
|
6610
|
-
* <p>The category type drill down filter. This filter is used for string type columns.</p>
|
|
6611
|
-
* @public
|
|
6612
|
-
*/
|
|
6613
|
-
CategoryFilter?: CategoryDrillDownFilter;
|
|
6614
|
-
/**
|
|
6615
|
-
* <p>The time range drill down filter. This filter is used for date time columns.</p>
|
|
6616
|
-
* @public
|
|
6617
|
-
*/
|
|
6618
|
-
TimeRangeFilter?: TimeRangeDrillDownFilter;
|
|
6619
|
-
}
|
|
6620
|
-
/**
|
|
6621
|
-
* <p>The option that determines the hierarchy of any <code>DateTime</code> fields.</p>
|
|
6622
|
-
* @public
|
|
6623
|
-
*/
|
|
6624
|
-
export interface DateTimeHierarchy {
|
|
6625
|
-
/**
|
|
6626
|
-
* <p>The hierarchy ID of the <code>DateTime</code> hierarchy.</p>
|
|
6627
|
-
* @public
|
|
6628
|
-
*/
|
|
6629
|
-
HierarchyId: string | undefined;
|
|
6630
|
-
/**
|
|
6631
|
-
* <p>The option that determines the drill down filters for the
|
|
6632
|
-
* <code>DateTime</code> hierarchy.</p>
|
|
6633
|
-
* @public
|
|
6634
|
-
*/
|
|
6635
|
-
DrillDownFilters?: DrillDownFilter[];
|
|
6636
|
-
}
|
|
6637
|
-
/**
|
|
6638
|
-
* <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>
|
|
6639
|
-
* @public
|
|
6640
|
-
*/
|
|
6641
|
-
export interface ExplicitHierarchy {
|
|
6642
|
-
/**
|
|
6643
|
-
* <p>The hierarchy ID of the explicit hierarchy.</p>
|
|
6644
|
-
* @public
|
|
6645
|
-
*/
|
|
6646
|
-
HierarchyId: string | undefined;
|
|
6647
|
-
/**
|
|
6648
|
-
* <p>The list of columns that define the explicit hierarchy.</p>
|
|
6649
|
-
* @public
|
|
6650
|
-
*/
|
|
6651
|
-
Columns: ColumnIdentifier[] | undefined;
|
|
6652
|
-
/**
|
|
6653
|
-
* <p>The option that determines the drill down filters for the explicit hierarchy.</p>
|
|
6654
|
-
* @public
|
|
6655
|
-
*/
|
|
6656
|
-
DrillDownFilters?: DrillDownFilter[];
|
|
6657
|
-
}
|
|
6658
6666
|
/**
|
|
6659
6667
|
* @internal
|
|
6660
6668
|
*/
|
|
@@ -6931,19 +6939,3 @@ export declare const ReferenceLineLabelConfigurationFilterSensitiveLog: (obj: Re
|
|
|
6931
6939
|
* @internal
|
|
6932
6940
|
*/
|
|
6933
6941
|
export declare const ReferenceLineFilterSensitiveLog: (obj: ReferenceLine) => any;
|
|
6934
|
-
/**
|
|
6935
|
-
* @internal
|
|
6936
|
-
*/
|
|
6937
|
-
export declare const DataPathValueFilterSensitiveLog: (obj: DataPathValue) => any;
|
|
6938
|
-
/**
|
|
6939
|
-
* @internal
|
|
6940
|
-
*/
|
|
6941
|
-
export declare const DataPathColorFilterSensitiveLog: (obj: DataPathColor) => any;
|
|
6942
|
-
/**
|
|
6943
|
-
* @internal
|
|
6944
|
-
*/
|
|
6945
|
-
export declare const VisualPaletteFilterSensitiveLog: (obj: VisualPalette) => any;
|
|
6946
|
-
/**
|
|
6947
|
-
* @internal
|
|
6948
|
-
*/
|
|
6949
|
-
export declare const BarChartConfigurationFilterSensitiveLog: (obj: BarChartConfiguration) => any;
|