2023/11/16 - Amazon QuickSight - 6 new 11 updated api methods
Changes Custom permission support for QuickSight roles; Three new datasources STARBURST, TRINO, BIGQUERY; Lenient mode changes the default behavior to allow for exporting and importing with certain UI allowed errors, Support for permissions and tags export and import.
Removes custom permissions from the role.
See also: AWS API Documentation
Request Syntax
client.delete_role_custom_permission(
Role='ADMIN'|'AUTHOR'|'READER',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The role that you want to remove permissions from.
string
[REQUIRED]
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that includes the role.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Removes a group from a role.
See also: AWS API Documentation
Request Syntax
client.delete_role_membership(
MemberName='string',
Role='ADMIN'|'AUTHOR'|'READER',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the group.
string
[REQUIRED]
The role that you want to remove permissions from.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that contains the role.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.
See also: AWS API Documentation
Request Syntax
client.create_role_membership(
MemberName='string',
AwsAccountId='string',
Namespace='string',
Role='ADMIN'|'AUTHOR'|'READER'
)
string
[REQUIRED]
The name of the group that you want to add to the role.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that the role belongs to.
string
[REQUIRED]
The role that you want to add a group to.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Lists all groups that are associated with a role.
See also: AWS API Documentation
Request Syntax
client.list_role_memberships(
Role='ADMIN'|'AUTHOR'|'READER',
NextToken='string',
MaxResults=123,
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the role.
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to return.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that includes the role.
dict
Response Syntax
{
'MembersList': [
'string',
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
MembersList (list) --
The list of groups associated with a role
(string) --
NextToken (string) --
A pagination token that can be used in a subsequent request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Updates the custom permissions that are associated with a role.
See also: AWS API Documentation
Request Syntax
client.update_role_custom_permission(
CustomPermissionsName='string',
Role='ADMIN'|'AUTHOR'|'READER',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the custom permission that you want to update the role with.
string
[REQUIRED]
The name of role tht you want to update.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that contains the role that you want to update.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Describes all custom permissions that are mapped to a role.
See also: AWS API Documentation
Request Syntax
client.describe_role_custom_permission(
Role='ADMIN'|'AUTHOR'|'READER',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the role whose permissions you want described.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that contains the role.
dict
Response Syntax
{
'CustomPermissionsName': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
CustomPermissionsName (string) --
The name of the custom permission that is described.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'LinkSharingConfiguration': {'Permissions': [{'Actions': ['string'],
'Principal': 'string'}]}}
Creates a dashboard from either a template or directly with a DashboardDefinition . To first create a template, see the `` CreateTemplate `` API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.create_dashboard(
AwsAccountId='string',
DashboardId='string',
Name='string',
Parameters={
'StringParameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
],
'IntegerParameters': [
{
'Name': 'string',
'Values': [
123,
]
},
],
'DecimalParameters': [
{
'Name': 'string',
'Values': [
123.0,
]
},
],
'DateTimeParameters': [
{
'Name': 'string',
'Values': [
datetime(2015, 1, 1),
]
},
]
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
SourceEntity={
'SourceTemplate': {
'DataSetReferences': [
{
'DataSetPlaceholder': 'string',
'DataSetArn': 'string'
},
],
'Arn': 'string'
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
VersionDescription='string',
DashboardPublishOptions={
'AdHocFilteringOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'ExportToCSVOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'SheetControlsOption': {
'VisibilityState': 'EXPANDED'|'COLLAPSED'
},
'VisualPublishOptions': {
'ExportHiddenFieldsOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
}
},
'SheetLayoutElementMaximizationOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'VisualMenuOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'VisualAxisSortOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'ExportWithHiddenFieldsOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'DataPointDrillUpDownOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'DataPointMenuLabelOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
},
'DataPointTooltipOption': {
'AvailabilityStatus': 'ENABLED'|'DISABLED'
}
},
ThemeArn='string',
Definition={
'DataSetIdentifierDeclarations': [
{
'Identifier': 'string',
'DataSetArn': 'string'
},
],
'Sheets': [
{
'SheetId': 'string',
'Title': 'string',
'Description': 'string',
'Name': 'string',
'ParameterControls': [
{
'DateTimePicker': {
'ParameterControlId': 'string',
'Title': 'string',
'SourceParameterName': 'string',
'DisplayOptions': {
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'DateTimeFormat': 'string',
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
}
},
'List': {
'ParameterControlId': 'string',
'Title': 'string',
'SourceParameterName': 'string',
'DisplayOptions': {
'SearchOptions': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'SelectAllOptions': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
},
'Type': 'MULTI_SELECT'|'SINGLE_SELECT',
'SelectableValues': {
'Values': [
'string',
],
'LinkToDataSetColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
},
'CascadingControlConfiguration': {
'SourceControls': [
{
'SourceSheetControlId': 'string',
'ColumnToMatch': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
},
]
}
},
'Dropdown': {
'ParameterControlId': 'string',
'Title': 'string',
'SourceParameterName': 'string',
'DisplayOptions': {
'SelectAllOptions': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
},
'Type': 'MULTI_SELECT'|'SINGLE_SELECT',
'SelectableValues': {
'Values': [
'string',
],
'LinkToDataSetColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
},
'CascadingControlConfiguration': {
'SourceControls': [
{
'SourceSheetControlId': 'string',
'ColumnToMatch': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
},
]
}
},
'TextField': {
'ParameterControlId': 'string',
'Title': 'string',
'SourceParameterName': 'string',
'DisplayOptions': {
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'PlaceholderOptions': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
}
},
'TextArea': {
'ParameterControlId': 'string',
'Title': 'string',
'SourceParameterName': 'string',
'Delimiter': 'string',
'DisplayOptions': {
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'PlaceholderOptions': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
}
},
'Slider': {
'ParameterControlId': 'string',
'Title': 'string',
'SourceParameterName': 'string',
'DisplayOptions': {
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
},
'MaximumValue': 123.0,
'MinimumValue': 123.0,
'StepSize': 123.0
}
},
],
'FilterControls': [
{
'DateTimePicker': {
'FilterControlId': 'string',
'Title': 'string',
'SourceFilterId': 'string',
'DisplayOptions': {
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'DateTimeFormat': 'string',
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
},
'Type': 'SINGLE_VALUED'|'DATE_RANGE'
},
'List': {
'FilterControlId': 'string',
'Title': 'string',
'SourceFilterId': 'string',
'DisplayOptions': {
'SearchOptions': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'SelectAllOptions': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
},
'Type': 'MULTI_SELECT'|'SINGLE_SELECT',
'SelectableValues': {
'Values': [
'string',
]
},
'CascadingControlConfiguration': {
'SourceControls': [
{
'SourceSheetControlId': 'string',
'ColumnToMatch': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
},
]
}
},
'Dropdown': {
'FilterControlId': 'string',
'Title': 'string',
'SourceFilterId': 'string',
'DisplayOptions': {
'SelectAllOptions': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
},
'Type': 'MULTI_SELECT'|'SINGLE_SELECT',
'SelectableValues': {
'Values': [
'string',
]
},
'CascadingControlConfiguration': {
'SourceControls': [
{
'SourceSheetControlId': 'string',
'ColumnToMatch': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
},
]
}
},
'TextField': {
'FilterControlId': 'string',
'Title': 'string',
'SourceFilterId': 'string',
'DisplayOptions': {
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'PlaceholderOptions': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
}
},
'TextArea': {
'FilterControlId': 'string',
'Title': 'string',
'SourceFilterId': 'string',
'Delimiter': 'string',
'DisplayOptions': {
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'PlaceholderOptions': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
}
},
'Slider': {
'FilterControlId': 'string',
'Title': 'string',
'SourceFilterId': 'string',
'DisplayOptions': {
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
},
'Type': 'SINGLE_POINT'|'RANGE',
'MaximumValue': 123.0,
'MinimumValue': 123.0,
'StepSize': 123.0
},
'RelativeDateTime': {
'FilterControlId': 'string',
'Title': 'string',
'SourceFilterId': 'string',
'DisplayOptions': {
'TitleOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'DateTimeFormat': 'string',
'InfoIconLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'InfoIconText': 'string'
}
}
}
},
],
'Visuals': [
{
'TableVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'TableAggregatedFieldWells': {
'GroupBy': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
},
'TableUnaggregatedFieldWells': {
'Values': [
{
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'FormatConfiguration': {
'StringFormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
},
'NumberFormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
},
'DateTimeFormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
]
}
},
'SortConfiguration': {
'RowSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'PaginationConfiguration': {
'PageSize': 123,
'PageNumber': 123
}
},
'TableOptions': {
'Orientation': 'VERTICAL'|'HORIZONTAL',
'HeaderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'CellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'RowAlternateColorOptions': {
'Status': 'ENABLED'|'DISABLED',
'RowAlternateColors': [
'string',
],
'UsePrimaryBackgroundColor': 'ENABLED'|'DISABLED'
}
},
'TotalOptions': {
'TotalsVisibility': 'HIDDEN'|'VISIBLE',
'Placement': 'START'|'END'|'AUTO',
'ScrollStatus': 'PINNED'|'SCROLLED',
'CustomLabel': 'string',
'TotalCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'TotalAggregationOptions': [
{
'FieldId': 'string',
'TotalAggregationFunction': {
'SimpleTotalAggregationFunction': 'DEFAULT'|'SUM'|'AVERAGE'|'MIN'|'MAX'|'NONE'
}
},
]
},
'FieldOptions': {
'SelectedFieldOptions': [
{
'FieldId': 'string',
'Width': 'string',
'CustomLabel': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'URLStyling': {
'LinkConfiguration': {
'Target': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB',
'Content': {
'CustomTextContent': {
'Value': 'string',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
}
},
'CustomIconContent': {
'Icon': 'LINK'
}
}
},
'ImageConfiguration': {
'SizingOptions': {
'TableCellImageScalingConfiguration': 'FIT_TO_CELL_HEIGHT'|'FIT_TO_CELL_WIDTH'|'DO_NOT_SCALE'
}
}
}
},
],
'Order': [
'string',
],
'PinnedFieldOptions': {
'PinnedLeftFields': [
'string',
]
}
},
'PaginatedReportOptions': {
'VerticalOverflowVisibility': 'HIDDEN'|'VISIBLE',
'OverflowColumnHeaderVisibility': 'HIDDEN'|'VISIBLE'
},
'TableInlineVisualizations': [
{
'DataBars': {
'FieldId': 'string',
'PositiveColor': 'string',
'NegativeColor': 'string'
}
},
]
},
'ConditionalFormatting': {
'ConditionalFormattingOptions': [
{
'Cell': {
'FieldId': 'string',
'TextFormat': {
'BackgroundColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
},
'TextColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
},
'Icon': {
'IconSet': {
'Expression': 'string',
'IconSetType': 'PLUS_MINUS'|'CHECK_X'|'THREE_COLOR_ARROW'|'THREE_GRAY_ARROW'|'CARET_UP_MINUS_DOWN'|'THREE_SHAPE'|'THREE_CIRCLE'|'FLAGS'|'BARS'|'FOUR_COLOR_ARROW'|'FOUR_GRAY_ARROW'
},
'CustomCondition': {
'Expression': 'string',
'IconOptions': {
'Icon': 'CARET_UP'|'CARET_DOWN'|'PLUS'|'MINUS'|'ARROW_UP'|'ARROW_DOWN'|'ARROW_LEFT'|'ARROW_UP_LEFT'|'ARROW_DOWN_LEFT'|'ARROW_RIGHT'|'ARROW_UP_RIGHT'|'ARROW_DOWN_RIGHT'|'FACE_UP'|'FACE_DOWN'|'FACE_FLAT'|'ONE_BAR'|'TWO_BAR'|'THREE_BAR'|'CIRCLE'|'TRIANGLE'|'SQUARE'|'FLAG'|'THUMBS_UP'|'THUMBS_DOWN'|'CHECKMARK'|'X',
'UnicodeIcon': 'string'
},
'Color': 'string',
'DisplayConfiguration': {
'IconDisplayOption': 'ICON_ONLY'
}
}
}
}
},
'Row': {
'BackgroundColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
},
'TextColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
}
}
},
]
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
]
},
'PivotTableVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'PivotTableAggregatedFieldWells': {
'Rows': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Columns': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'SortConfiguration': {
'FieldSortOptions': [
{
'FieldId': 'string',
'SortBy': {
'Field': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'Column': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
},
'DataPath': {
'Direction': 'ASC'|'DESC',
'SortPaths': [
{
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
]
}
}
},
]
},
'TableOptions': {
'MetricPlacement': 'ROW'|'COLUMN',
'SingleMetricVisibility': 'HIDDEN'|'VISIBLE',
'ColumnNamesVisibility': 'HIDDEN'|'VISIBLE',
'ToggleButtonsVisibility': 'HIDDEN'|'VISIBLE',
'ColumnHeaderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'RowHeaderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'CellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'RowFieldNamesStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'RowAlternateColorOptions': {
'Status': 'ENABLED'|'DISABLED',
'RowAlternateColors': [
'string',
],
'UsePrimaryBackgroundColor': 'ENABLED'|'DISABLED'
},
'CollapsedRowDimensionsVisibility': 'HIDDEN'|'VISIBLE',
'RowsLayout': 'TABULAR'|'HIERARCHY',
'RowsLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CustomLabel': 'string'
},
'DefaultCellWidth': 'string'
},
'TotalOptions': {
'RowSubtotalOptions': {
'TotalsVisibility': 'HIDDEN'|'VISIBLE',
'CustomLabel': 'string',
'FieldLevel': 'ALL'|'CUSTOM'|'LAST',
'FieldLevelOptions': [
{
'FieldId': 'string'
},
],
'TotalCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'ValueCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'MetricHeaderCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'StyleTargets': [
{
'CellType': 'TOTAL'|'METRIC_HEADER'|'VALUE'
},
]
},
'ColumnSubtotalOptions': {
'TotalsVisibility': 'HIDDEN'|'VISIBLE',
'CustomLabel': 'string',
'FieldLevel': 'ALL'|'CUSTOM'|'LAST',
'FieldLevelOptions': [
{
'FieldId': 'string'
},
],
'TotalCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'ValueCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'MetricHeaderCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'StyleTargets': [
{
'CellType': 'TOTAL'|'METRIC_HEADER'|'VALUE'
},
]
},
'RowTotalOptions': {
'TotalsVisibility': 'HIDDEN'|'VISIBLE',
'Placement': 'START'|'END'|'AUTO',
'ScrollStatus': 'PINNED'|'SCROLLED',
'CustomLabel': 'string',
'TotalCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'ValueCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'MetricHeaderCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'TotalAggregationOptions': [
{
'FieldId': 'string',
'TotalAggregationFunction': {
'SimpleTotalAggregationFunction': 'DEFAULT'|'SUM'|'AVERAGE'|'MIN'|'MAX'|'NONE'
}
},
]
},
'ColumnTotalOptions': {
'TotalsVisibility': 'HIDDEN'|'VISIBLE',
'Placement': 'START'|'END'|'AUTO',
'ScrollStatus': 'PINNED'|'SCROLLED',
'CustomLabel': 'string',
'TotalCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'ValueCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'MetricHeaderCellStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'TextWrap': 'NONE'|'WRAP',
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO',
'VerticalTextAlignment': 'TOP'|'MIDDLE'|'BOTTOM'|'AUTO',
'BackgroundColor': 'string',
'Height': 123,
'Border': {
'UniformBorder': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'SideSpecificBorder': {
'InnerVertical': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'InnerHorizontal': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Left': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Right': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Top': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
},
'Bottom': {
'Color': 'string',
'Thickness': 123,
'Style': 'NONE'|'SOLID'
}
}
}
},
'TotalAggregationOptions': [
{
'FieldId': 'string',
'TotalAggregationFunction': {
'SimpleTotalAggregationFunction': 'DEFAULT'|'SUM'|'AVERAGE'|'MIN'|'MAX'|'NONE'
}
},
]
}
},
'FieldOptions': {
'SelectedFieldOptions': [
{
'FieldId': 'string',
'CustomLabel': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
],
'DataPathOptions': [
{
'DataPathList': [
{
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
],
'Width': 'string'
},
],
'CollapseStateOptions': [
{
'Target': {
'FieldId': 'string',
'FieldDataPathValues': [
{
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
]
},
'State': 'COLLAPSED'|'EXPANDED'
},
]
},
'PaginatedReportOptions': {
'VerticalOverflowVisibility': 'HIDDEN'|'VISIBLE',
'OverflowColumnHeaderVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ConditionalFormatting': {
'ConditionalFormattingOptions': [
{
'Cell': {
'FieldId': 'string',
'TextFormat': {
'BackgroundColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
},
'TextColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
},
'Icon': {
'IconSet': {
'Expression': 'string',
'IconSetType': 'PLUS_MINUS'|'CHECK_X'|'THREE_COLOR_ARROW'|'THREE_GRAY_ARROW'|'CARET_UP_MINUS_DOWN'|'THREE_SHAPE'|'THREE_CIRCLE'|'FLAGS'|'BARS'|'FOUR_COLOR_ARROW'|'FOUR_GRAY_ARROW'
},
'CustomCondition': {
'Expression': 'string',
'IconOptions': {
'Icon': 'CARET_UP'|'CARET_DOWN'|'PLUS'|'MINUS'|'ARROW_UP'|'ARROW_DOWN'|'ARROW_LEFT'|'ARROW_UP_LEFT'|'ARROW_DOWN_LEFT'|'ARROW_RIGHT'|'ARROW_UP_RIGHT'|'ARROW_DOWN_RIGHT'|'FACE_UP'|'FACE_DOWN'|'FACE_FLAT'|'ONE_BAR'|'TWO_BAR'|'THREE_BAR'|'CIRCLE'|'TRIANGLE'|'SQUARE'|'FLAG'|'THUMBS_UP'|'THUMBS_DOWN'|'CHECKMARK'|'X',
'UnicodeIcon': 'string'
},
'Color': 'string',
'DisplayConfiguration': {
'IconDisplayOption': 'ICON_ONLY'
}
}
}
},
'Scope': {
'Role': 'FIELD'|'FIELD_TOTAL'|'GRAND_TOTAL'
},
'Scopes': [
{
'Role': 'FIELD'|'FIELD_TOTAL'|'GRAND_TOTAL'
},
]
}
},
]
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
]
},
'BarChartVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'BarChartAggregatedFieldWells': {
'Category': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'Colors': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'SmallMultiples': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
]
}
},
'SortConfiguration': {
'CategorySort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'CategoryItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
},
'ColorSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'ColorItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
},
'SmallMultiplesSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'SmallMultiplesLimitConfiguration': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
}
},
'Orientation': 'HORIZONTAL'|'VERTICAL',
'BarsArrangement': 'CLUSTERED'|'STACKED'|'STACKED_PERCENT',
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
},
'SmallMultiplesOptions': {
'MaxVisibleRows': 123,
'MaxVisibleColumns': 123,
'PanelConfiguration': {
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO'
},
'BorderVisibility': 'HIDDEN'|'VISIBLE',
'BorderThickness': 'string',
'BorderStyle': 'SOLID'|'DASHED'|'DOTTED',
'BorderColor': 'string',
'GutterVisibility': 'HIDDEN'|'VISIBLE',
'GutterSpacing': 'string',
'BackgroundVisibility': 'HIDDEN'|'VISIBLE',
'BackgroundColor': 'string'
},
'XAxis': {
'Scale': 'SHARED'|'INDEPENDENT',
'Placement': 'OUTSIDE'|'INSIDE'
},
'YAxis': {
'Scale': 'SHARED'|'INDEPENDENT',
'Placement': 'OUTSIDE'|'INSIDE'
}
},
'CategoryAxis': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'CategoryLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'ValueAxis': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'ValueLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'ColorLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'DataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'ReferenceLines': [
{
'Status': 'ENABLED'|'DISABLED',
'DataConfiguration': {
'StaticConfiguration': {
'Value': 123.0
},
'DynamicConfiguration': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'MeasureAggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
},
'Calculation': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
}
},
'AxisBinding': 'PRIMARY_YAXIS'|'SECONDARY_YAXIS',
'SeriesType': 'BAR'|'LINE'
},
'StyleConfiguration': {
'Pattern': 'SOLID'|'DASHED'|'DOTTED',
'Color': 'string'
},
'LabelConfiguration': {
'ValueLabelConfiguration': {
'RelativePosition': 'BEFORE_CUSTOM_LABEL'|'AFTER_CUSTOM_LABEL',
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
},
'CustomLabelConfiguration': {
'CustomLabel': 'string'
},
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'FontColor': 'string',
'HorizontalPosition': 'LEFT'|'CENTER'|'RIGHT',
'VerticalPosition': 'ABOVE'|'BELOW'
}
},
],
'ContributionAnalysisDefaults': [
{
'MeasureFieldId': 'string',
'ContributorDimensions': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
]
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'KPIVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'TargetValues': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'TrendGroups': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
]
},
'SortConfiguration': {
'TrendGroupSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
},
'KPIOptions': {
'ProgressBar': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'TrendArrows': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'SecondaryValue': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'Comparison': {
'ComparisonMethod': 'DIFFERENCE'|'PERCENT_DIFFERENCE'|'PERCENT',
'ComparisonFormat': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
},
'PrimaryValueDisplayType': 'HIDDEN'|'COMPARISON'|'ACTUAL',
'PrimaryValueFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'SecondaryValueFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'Sparkline': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Type': 'LINE'|'AREA',
'Color': 'string',
'TooltipVisibility': 'HIDDEN'|'VISIBLE'
},
'VisualLayoutOptions': {
'StandardLayout': {
'Type': 'CLASSIC'|'VERTICAL'
}
}
}
},
'ConditionalFormatting': {
'ConditionalFormattingOptions': [
{
'PrimaryValue': {
'TextColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
},
'Icon': {
'IconSet': {
'Expression': 'string',
'IconSetType': 'PLUS_MINUS'|'CHECK_X'|'THREE_COLOR_ARROW'|'THREE_GRAY_ARROW'|'CARET_UP_MINUS_DOWN'|'THREE_SHAPE'|'THREE_CIRCLE'|'FLAGS'|'BARS'|'FOUR_COLOR_ARROW'|'FOUR_GRAY_ARROW'
},
'CustomCondition': {
'Expression': 'string',
'IconOptions': {
'Icon': 'CARET_UP'|'CARET_DOWN'|'PLUS'|'MINUS'|'ARROW_UP'|'ARROW_DOWN'|'ARROW_LEFT'|'ARROW_UP_LEFT'|'ARROW_DOWN_LEFT'|'ARROW_RIGHT'|'ARROW_UP_RIGHT'|'ARROW_DOWN_RIGHT'|'FACE_UP'|'FACE_DOWN'|'FACE_FLAT'|'ONE_BAR'|'TWO_BAR'|'THREE_BAR'|'CIRCLE'|'TRIANGLE'|'SQUARE'|'FLAG'|'THUMBS_UP'|'THUMBS_DOWN'|'CHECKMARK'|'X',
'UnicodeIcon': 'string'
},
'Color': 'string',
'DisplayConfiguration': {
'IconDisplayOption': 'ICON_ONLY'
}
}
}
},
'ProgressBar': {
'ForegroundColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
}
},
'ActualValue': {
'TextColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
},
'Icon': {
'IconSet': {
'Expression': 'string',
'IconSetType': 'PLUS_MINUS'|'CHECK_X'|'THREE_COLOR_ARROW'|'THREE_GRAY_ARROW'|'CARET_UP_MINUS_DOWN'|'THREE_SHAPE'|'THREE_CIRCLE'|'FLAGS'|'BARS'|'FOUR_COLOR_ARROW'|'FOUR_GRAY_ARROW'
},
'CustomCondition': {
'Expression': 'string',
'IconOptions': {
'Icon': 'CARET_UP'|'CARET_DOWN'|'PLUS'|'MINUS'|'ARROW_UP'|'ARROW_DOWN'|'ARROW_LEFT'|'ARROW_UP_LEFT'|'ARROW_DOWN_LEFT'|'ARROW_RIGHT'|'ARROW_UP_RIGHT'|'ARROW_DOWN_RIGHT'|'FACE_UP'|'FACE_DOWN'|'FACE_FLAT'|'ONE_BAR'|'TWO_BAR'|'THREE_BAR'|'CIRCLE'|'TRIANGLE'|'SQUARE'|'FLAG'|'THUMBS_UP'|'THUMBS_DOWN'|'CHECKMARK'|'X',
'UnicodeIcon': 'string'
},
'Color': 'string',
'DisplayConfiguration': {
'IconDisplayOption': 'ICON_ONLY'
}
}
}
},
'ComparisonValue': {
'TextColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
},
'Icon': {
'IconSet': {
'Expression': 'string',
'IconSetType': 'PLUS_MINUS'|'CHECK_X'|'THREE_COLOR_ARROW'|'THREE_GRAY_ARROW'|'CARET_UP_MINUS_DOWN'|'THREE_SHAPE'|'THREE_CIRCLE'|'FLAGS'|'BARS'|'FOUR_COLOR_ARROW'|'FOUR_GRAY_ARROW'
},
'CustomCondition': {
'Expression': 'string',
'IconOptions': {
'Icon': 'CARET_UP'|'CARET_DOWN'|'PLUS'|'MINUS'|'ARROW_UP'|'ARROW_DOWN'|'ARROW_LEFT'|'ARROW_UP_LEFT'|'ARROW_DOWN_LEFT'|'ARROW_RIGHT'|'ARROW_UP_RIGHT'|'ARROW_DOWN_RIGHT'|'FACE_UP'|'FACE_DOWN'|'FACE_FLAT'|'ONE_BAR'|'TWO_BAR'|'THREE_BAR'|'CIRCLE'|'TRIANGLE'|'SQUARE'|'FLAG'|'THUMBS_UP'|'THUMBS_DOWN'|'CHECKMARK'|'X',
'UnicodeIcon': 'string'
},
'Color': 'string',
'DisplayConfiguration': {
'IconDisplayOption': 'ICON_ONLY'
}
}
}
}
},
]
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'PieChartVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'PieChartAggregatedFieldWells': {
'Category': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'SmallMultiples': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
]
}
},
'SortConfiguration': {
'CategorySort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'CategoryItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
},
'SmallMultiplesSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'SmallMultiplesLimitConfiguration': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
}
},
'DonutOptions': {
'ArcOptions': {
'ArcThickness': 'SMALL'|'MEDIUM'|'LARGE'|'WHOLE'
},
'DonutCenterOptions': {
'LabelVisibility': 'HIDDEN'|'VISIBLE'
}
},
'SmallMultiplesOptions': {
'MaxVisibleRows': 123,
'MaxVisibleColumns': 123,
'PanelConfiguration': {
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO'
},
'BorderVisibility': 'HIDDEN'|'VISIBLE',
'BorderThickness': 'string',
'BorderStyle': 'SOLID'|'DASHED'|'DOTTED',
'BorderColor': 'string',
'GutterVisibility': 'HIDDEN'|'VISIBLE',
'GutterSpacing': 'string',
'BackgroundVisibility': 'HIDDEN'|'VISIBLE',
'BackgroundColor': 'string'
},
'XAxis': {
'Scale': 'SHARED'|'INDEPENDENT',
'Placement': 'OUTSIDE'|'INSIDE'
},
'YAxis': {
'Scale': 'SHARED'|'INDEPENDENT',
'Placement': 'OUTSIDE'|'INSIDE'
}
},
'CategoryLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'ValueLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'DataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
},
'ContributionAnalysisDefaults': [
{
'MeasureFieldId': 'string',
'ContributorDimensions': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
]
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'GaugeChartVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'TargetValues': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
},
'GaugeChartOptions': {
'PrimaryValueDisplayType': 'HIDDEN'|'COMPARISON'|'ACTUAL',
'Comparison': {
'ComparisonMethod': 'DIFFERENCE'|'PERCENT_DIFFERENCE'|'PERCENT',
'ComparisonFormat': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
},
'ArcAxis': {
'Range': {
'Min': 123.0,
'Max': 123.0
},
'ReserveRange': 123
},
'Arc': {
'ArcAngle': 123.0,
'ArcThickness': 'SMALL'|'MEDIUM'|'LARGE'
},
'PrimaryValueFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
}
},
'DataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'TooltipOptions': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
}
},
'ConditionalFormatting': {
'ConditionalFormattingOptions': [
{
'PrimaryValue': {
'TextColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
},
'Icon': {
'IconSet': {
'Expression': 'string',
'IconSetType': 'PLUS_MINUS'|'CHECK_X'|'THREE_COLOR_ARROW'|'THREE_GRAY_ARROW'|'CARET_UP_MINUS_DOWN'|'THREE_SHAPE'|'THREE_CIRCLE'|'FLAGS'|'BARS'|'FOUR_COLOR_ARROW'|'FOUR_GRAY_ARROW'
},
'CustomCondition': {
'Expression': 'string',
'IconOptions': {
'Icon': 'CARET_UP'|'CARET_DOWN'|'PLUS'|'MINUS'|'ARROW_UP'|'ARROW_DOWN'|'ARROW_LEFT'|'ARROW_UP_LEFT'|'ARROW_DOWN_LEFT'|'ARROW_RIGHT'|'ARROW_UP_RIGHT'|'ARROW_DOWN_RIGHT'|'FACE_UP'|'FACE_DOWN'|'FACE_FLAT'|'ONE_BAR'|'TWO_BAR'|'THREE_BAR'|'CIRCLE'|'TRIANGLE'|'SQUARE'|'FLAG'|'THUMBS_UP'|'THUMBS_DOWN'|'CHECKMARK'|'X',
'UnicodeIcon': 'string'
},
'Color': 'string',
'DisplayConfiguration': {
'IconDisplayOption': 'ICON_ONLY'
}
}
}
},
'Arc': {
'ForegroundColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
}
}
},
]
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
]
},
'LineChartVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'LineChartAggregatedFieldWells': {
'Category': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'Colors': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'SmallMultiples': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
]
}
},
'SortConfiguration': {
'CategorySort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'CategoryItemsLimitConfiguration': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
},
'ColorItemsLimitConfiguration': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
},
'SmallMultiplesSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'SmallMultiplesLimitConfiguration': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
}
},
'ForecastConfigurations': [
{
'ForecastProperties': {
'PeriodsForward': 123,
'PeriodsBackward': 123,
'UpperBoundary': 123.0,
'LowerBoundary': 123.0,
'PredictionInterval': 123,
'Seasonality': 123
},
'Scenario': {
'WhatIfPointScenario': {
'Date': datetime(2015, 1, 1),
'Value': 123.0
},
'WhatIfRangeScenario': {
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'Value': 123.0
}
}
},
],
'Type': 'LINE'|'AREA'|'STACKED_AREA',
'SmallMultiplesOptions': {
'MaxVisibleRows': 123,
'MaxVisibleColumns': 123,
'PanelConfiguration': {
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'HorizontalTextAlignment': 'LEFT'|'CENTER'|'RIGHT'|'AUTO'
},
'BorderVisibility': 'HIDDEN'|'VISIBLE',
'BorderThickness': 'string',
'BorderStyle': 'SOLID'|'DASHED'|'DOTTED',
'BorderColor': 'string',
'GutterVisibility': 'HIDDEN'|'VISIBLE',
'GutterSpacing': 'string',
'BackgroundVisibility': 'HIDDEN'|'VISIBLE',
'BackgroundColor': 'string'
},
'XAxis': {
'Scale': 'SHARED'|'INDEPENDENT',
'Placement': 'OUTSIDE'|'INSIDE'
},
'YAxis': {
'Scale': 'SHARED'|'INDEPENDENT',
'Placement': 'OUTSIDE'|'INSIDE'
}
},
'XAxisDisplayOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'XAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'PrimaryYAxisDisplayOptions': {
'AxisOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'MissingDataConfigurations': [
{
'TreatmentOption': 'INTERPOLATE'|'SHOW_AS_ZERO'|'SHOW_AS_BLANK'
},
]
},
'PrimaryYAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'SecondaryYAxisDisplayOptions': {
'AxisOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'MissingDataConfigurations': [
{
'TreatmentOption': 'INTERPOLATE'|'SHOW_AS_ZERO'|'SHOW_AS_BLANK'
},
]
},
'SecondaryYAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'DefaultSeriesSettings': {
'AxisBinding': 'PRIMARY_YAXIS'|'SECONDARY_YAXIS',
'LineStyleSettings': {
'LineVisibility': 'HIDDEN'|'VISIBLE',
'LineInterpolation': 'LINEAR'|'SMOOTH'|'STEPPED',
'LineStyle': 'SOLID'|'DOTTED'|'DASHED',
'LineWidth': 'string'
},
'MarkerStyleSettings': {
'MarkerVisibility': 'HIDDEN'|'VISIBLE',
'MarkerShape': 'CIRCLE'|'TRIANGLE'|'SQUARE'|'DIAMOND'|'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerColor': 'string'
}
},
'Series': [
{
'FieldSeriesItem': {
'FieldId': 'string',
'AxisBinding': 'PRIMARY_YAXIS'|'SECONDARY_YAXIS',
'Settings': {
'LineStyleSettings': {
'LineVisibility': 'HIDDEN'|'VISIBLE',
'LineInterpolation': 'LINEAR'|'SMOOTH'|'STEPPED',
'LineStyle': 'SOLID'|'DOTTED'|'DASHED',
'LineWidth': 'string'
},
'MarkerStyleSettings': {
'MarkerVisibility': 'HIDDEN'|'VISIBLE',
'MarkerShape': 'CIRCLE'|'TRIANGLE'|'SQUARE'|'DIAMOND'|'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerColor': 'string'
}
}
},
'DataFieldSeriesItem': {
'FieldId': 'string',
'FieldValue': 'string',
'AxisBinding': 'PRIMARY_YAXIS'|'SECONDARY_YAXIS',
'Settings': {
'LineStyleSettings': {
'LineVisibility': 'HIDDEN'|'VISIBLE',
'LineInterpolation': 'LINEAR'|'SMOOTH'|'STEPPED',
'LineStyle': 'SOLID'|'DOTTED'|'DASHED',
'LineWidth': 'string'
},
'MarkerStyleSettings': {
'MarkerVisibility': 'HIDDEN'|'VISIBLE',
'MarkerShape': 'CIRCLE'|'TRIANGLE'|'SQUARE'|'DIAMOND'|'ROUNDED_SQUARE',
'MarkerSize': 'string',
'MarkerColor': 'string'
}
}
}
},
],
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'DataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'ReferenceLines': [
{
'Status': 'ENABLED'|'DISABLED',
'DataConfiguration': {
'StaticConfiguration': {
'Value': 123.0
},
'DynamicConfiguration': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'MeasureAggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
},
'Calculation': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
}
},
'AxisBinding': 'PRIMARY_YAXIS'|'SECONDARY_YAXIS',
'SeriesType': 'BAR'|'LINE'
},
'StyleConfiguration': {
'Pattern': 'SOLID'|'DASHED'|'DOTTED',
'Color': 'string'
},
'LabelConfiguration': {
'ValueLabelConfiguration': {
'RelativePosition': 'BEFORE_CUSTOM_LABEL'|'AFTER_CUSTOM_LABEL',
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
},
'CustomLabelConfiguration': {
'CustomLabel': 'string'
},
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'FontColor': 'string',
'HorizontalPosition': 'LEFT'|'CENTER'|'RIGHT',
'VerticalPosition': 'ABOVE'|'BELOW'
}
},
],
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'ContributionAnalysisDefaults': [
{
'MeasureFieldId': 'string',
'ContributorDimensions': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
],
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'HeatMapVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'HeatMapAggregatedFieldWells': {
'Rows': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Columns': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'SortConfiguration': {
'HeatMapRowSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'HeatMapColumnSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'HeatMapRowItemsLimitConfiguration': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
},
'HeatMapColumnItemsLimitConfiguration': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
}
},
'RowLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'ColumnLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'ColorScale': {
'Colors': [
{
'Color': 'string',
'DataValue': 123.0
},
],
'ColorFillType': 'DISCRETE'|'GRADIENT',
'NullValueColor': {
'Color': 'string',
'DataValue': 123.0
}
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'DataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
}
},
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
],
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
]
},
'TreeMapVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'TreeMapAggregatedFieldWells': {
'Groups': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Sizes': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'Colors': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'SortConfiguration': {
'TreeMapSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'TreeMapGroupItemsLimitConfiguration': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
}
},
'GroupLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'SizeLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'ColorLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'ColorScale': {
'Colors': [
{
'Color': 'string',
'DataValue': 123.0
},
],
'ColorFillType': 'DISCRETE'|'GRADIENT',
'NullValueColor': {
'Color': 'string',
'DataValue': 123.0
}
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'DataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'GeospatialMapVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'GeospatialMapAggregatedFieldWells': {
'Geospatial': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'Colors': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
]
}
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'WindowOptions': {
'Bounds': {
'North': 123.0,
'South': 123.0,
'West': 123.0,
'East': 123.0
},
'MapZoomMode': 'AUTO'|'MANUAL'
},
'MapStyleOptions': {
'BaseMapStyle': 'LIGHT_GRAY'|'DARK_GRAY'|'STREET'|'IMAGERY'
},
'PointStyleOptions': {
'SelectedPointStyle': 'POINT'|'CLUSTER'|'HEATMAP',
'ClusterMarkerConfiguration': {
'ClusterMarker': {
'SimpleClusterMarker': {
'Color': 'string'
}
}
},
'HeatmapConfiguration': {
'HeatmapColor': {
'Colors': [
{
'Color': 'string'
},
]
}
}
},
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
}
},
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
],
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
]
},
'FilledMapVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'FilledMapAggregatedFieldWells': {
'Geospatial': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'SortConfiguration': {
'CategorySort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'WindowOptions': {
'Bounds': {
'North': 123.0,
'South': 123.0,
'West': 123.0,
'East': 123.0
},
'MapZoomMode': 'AUTO'|'MANUAL'
},
'MapStyleOptions': {
'BaseMapStyle': 'LIGHT_GRAY'|'DARK_GRAY'|'STREET'|'IMAGERY'
}
},
'ConditionalFormatting': {
'ConditionalFormattingOptions': [
{
'Shape': {
'FieldId': 'string',
'Format': {
'BackgroundColor': {
'Solid': {
'Expression': 'string',
'Color': 'string'
},
'Gradient': {
'Expression': 'string',
'Color': {
'Stops': [
{
'GradientOffset': 123.0,
'DataValue': 123.0,
'Color': 'string'
},
]
}
}
}
}
}
},
]
},
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
],
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
]
},
'FunnelChartVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'FunnelChartAggregatedFieldWells': {
'Category': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'SortConfiguration': {
'CategorySort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'CategoryItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
}
},
'CategoryLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'ValueLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'DataLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'MeasureDataLabelStyle': 'VALUE_ONLY'|'PERCENTAGE_BY_FIRST_STAGE'|'PERCENTAGE_BY_PREVIOUS_STAGE'|'VALUE_AND_PERCENTAGE_BY_FIRST_STAGE'|'VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE'
},
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'ScatterPlotVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'ScatterPlotCategoricallyAggregatedFieldWells': {
'XAxis': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'YAxis': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'Category': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Size': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'Label': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
]
},
'ScatterPlotUnaggregatedFieldWells': {
'XAxis': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'YAxis': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Size': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'Category': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Label': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
]
}
},
'XAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'XAxisDisplayOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'YAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'YAxisDisplayOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'DataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'ComboChartVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'ComboChartAggregatedFieldWells': {
'Category': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'BarValues': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'Colors': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'LineValues': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'SortConfiguration': {
'CategorySort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'CategoryItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
},
'ColorSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'ColorItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
}
},
'BarsArrangement': 'CLUSTERED'|'STACKED'|'STACKED_PERCENT',
'CategoryAxis': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'CategoryLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'PrimaryYAxisDisplayOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'PrimaryYAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'SecondaryYAxisDisplayOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'SecondaryYAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'ColorLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'BarDataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'LineDataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'ReferenceLines': [
{
'Status': 'ENABLED'|'DISABLED',
'DataConfiguration': {
'StaticConfiguration': {
'Value': 123.0
},
'DynamicConfiguration': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'MeasureAggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
},
'Calculation': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
}
},
'AxisBinding': 'PRIMARY_YAXIS'|'SECONDARY_YAXIS',
'SeriesType': 'BAR'|'LINE'
},
'StyleConfiguration': {
'Pattern': 'SOLID'|'DASHED'|'DOTTED',
'Color': 'string'
},
'LabelConfiguration': {
'ValueLabelConfiguration': {
'RelativePosition': 'BEFORE_CUSTOM_LABEL'|'AFTER_CUSTOM_LABEL',
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
},
'CustomLabelConfiguration': {
'CustomLabel': 'string'
},
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'FontColor': 'string',
'HorizontalPosition': 'LEFT'|'CENTER'|'RIGHT',
'VerticalPosition': 'ABOVE'|'BELOW'
}
},
],
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'BoxPlotVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'BoxPlotAggregatedFieldWells': {
'GroupBy': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'SortConfiguration': {
'CategorySort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'PaginationConfiguration': {
'PageSize': 123,
'PageNumber': 123
}
},
'BoxPlotOptions': {
'StyleOptions': {
'FillStyle': 'SOLID'|'TRANSPARENT'
},
'OutlierVisibility': 'HIDDEN'|'VISIBLE',
'AllDataPointsVisibility': 'HIDDEN'|'VISIBLE'
},
'CategoryAxis': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'CategoryLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'PrimaryYAxisDisplayOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'PrimaryYAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'ReferenceLines': [
{
'Status': 'ENABLED'|'DISABLED',
'DataConfiguration': {
'StaticConfiguration': {
'Value': 123.0
},
'DynamicConfiguration': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'MeasureAggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
},
'Calculation': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
}
},
'AxisBinding': 'PRIMARY_YAXIS'|'SECONDARY_YAXIS',
'SeriesType': 'BAR'|'LINE'
},
'StyleConfiguration': {
'Pattern': 'SOLID'|'DASHED'|'DOTTED',
'Color': 'string'
},
'LabelConfiguration': {
'ValueLabelConfiguration': {
'RelativePosition': 'BEFORE_CUSTOM_LABEL'|'AFTER_CUSTOM_LABEL',
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
},
'CustomLabelConfiguration': {
'CustomLabel': 'string'
},
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'FontColor': 'string',
'HorizontalPosition': 'LEFT'|'CENTER'|'RIGHT',
'VerticalPosition': 'ABOVE'|'BELOW'
}
},
],
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'WaterfallVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'WaterfallChartAggregatedFieldWells': {
'Categories': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
],
'Breakdowns': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
]
}
},
'SortConfiguration': {
'CategorySort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'BreakdownItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
}
},
'WaterfallChartOptions': {
'TotalBarLabel': 'string'
},
'CategoryAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'CategoryAxisDisplayOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'PrimaryYAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'PrimaryYAxisDisplayOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'DataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'HistogramVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'HistogramAggregatedFieldWells': {
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'XAxisDisplayOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'XAxisLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'YAxisDisplayOptions': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'BinOptions': {
'SelectedBinType': 'BIN_COUNT'|'BIN_WIDTH',
'BinCount': {
'Value': 123
},
'BinWidth': {
'Value': 123.0,
'BinCountLimit': 123
},
'StartValue': 123.0
},
'DataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
},
'Tooltip': {
'TooltipVisibility': 'HIDDEN'|'VISIBLE',
'SelectedTooltipType': 'BASIC'|'DETAILED',
'FieldBasedTooltip': {
'AggregationVisibility': 'HIDDEN'|'VISIBLE',
'TooltipTitleType': 'NONE'|'PRIMARY_VALUE',
'TooltipFields': [
{
'FieldTooltipItem': {
'FieldId': 'string',
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'ColumnTooltipItem': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Label': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'Aggregation': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
}
},
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
]
},
'WordCloudVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'WordCloudAggregatedFieldWells': {
'GroupBy': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Size': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'SortConfiguration': {
'CategoryItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
},
'CategorySort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
]
},
'CategoryLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'WordCloudOptions': {
'WordOrientation': 'HORIZONTAL'|'HORIZONTAL_AND_VERTICAL',
'WordScaling': 'EMPHASIZE'|'NORMAL',
'CloudLayout': 'FLUID'|'NORMAL',
'WordCasing': 'LOWER_CASE'|'EXISTING_CASE',
'WordPadding': 'NONE'|'SMALL'|'MEDIUM'|'LARGE',
'MaximumStringLength': 123
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
},
'InsightVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'InsightConfiguration': {
'Computations': [
{
'TopBottomRanked': {
'ComputationId': 'string',
'Name': 'string',
'Category': {
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
'Value': {
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
'ResultSize': 123,
'Type': 'TOP'|'BOTTOM'
},
'TopBottomMovers': {
'ComputationId': 'string',
'Name': 'string',
'Time': {
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
'Category': {
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
'Value': {
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
'MoverSize': 123,
'SortOrder': 'PERCENT_DIFFERENCE'|'ABSOLUTE_DIFFERENCE',
'Type': 'TOP'|'BOTTOM'
},
'TotalAggregation': {
'ComputationId': 'string',
'Name': 'string',
'Value': {
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
}
},
'MaximumMinimum': {
'ComputationId': 'string',
'Name': 'string',
'Time': {
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
'Value': {
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
'Type': 'MAXIMUM'|'MINIMUM'
},
'MetricComparison': {
'ComputationId': 'string',
'Name': 'string',
'Time': {
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
'FromValue': {
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
'TargetValue': {
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
}
},
'PeriodOverPeriod': {
'ComputationId': 'string',
'Name': 'string',
'Time': {
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
'Value': {
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
}
},
'PeriodToDate': {
'ComputationId': 'string',
'Name': 'string',
'Time': {
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
'Value': {
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
'PeriodTimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
'GrowthRate': {
'ComputationId': 'string',
'Name': 'string',
'Time': {
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
'Value': {
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
'PeriodSize': 123
},
'UniqueValues': {
'ComputationId': 'string',
'Name': 'string',
'Category': {
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
}
},
'Forecast': {
'ComputationId': 'string',
'Name': 'string',
'Time': {
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
'Value': {
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
'PeriodsForward': 123,
'PeriodsBackward': 123,
'UpperBoundary': 123.0,
'LowerBoundary': 123.0,
'PredictionInterval': 123,
'Seasonality': 'AUTOMATIC'|'CUSTOM',
'CustomSeasonalityValue': 123
}
},
],
'CustomNarrative': {
'Narrative': 'string'
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'DataSetIdentifier': 'string'
},
'SankeyDiagramVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'SankeyDiagramAggregatedFieldWells': {
'Source': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Destination': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Weight': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'SortConfiguration': {
'WeightSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'SourceItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
},
'DestinationItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
}
},
'DataLabels': {
'Visibility': 'HIDDEN'|'VISIBLE',
'CategoryLabelVisibility': 'HIDDEN'|'VISIBLE',
'MeasureLabelVisibility': 'HIDDEN'|'VISIBLE',
'DataLabelTypes': [
{
'FieldLabelType': {
'FieldId': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'DataPathLabelType': {
'FieldId': 'string',
'FieldValue': 'string',
'Visibility': 'HIDDEN'|'VISIBLE'
},
'RangeEndsLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MinimumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
},
'MaximumLabelType': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'Position': 'INSIDE'|'OUTSIDE'|'LEFT'|'TOP'|'BOTTOM'|'RIGHT',
'LabelContent': 'VALUE'|'PERCENT'|'VALUE_AND_PERCENT',
'LabelFontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'LabelColor': 'string',
'Overlap': 'DISABLE_OVERLAP'|'ENABLE_OVERLAP',
'TotalsVisibility': 'HIDDEN'|'VISIBLE'
}
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
]
},
'CustomContentVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'ContentUrl': 'string',
'ContentType': 'IMAGE'|'OTHER_EMBEDDED_CONTENT',
'ImageScaling': 'FIT_TO_HEIGHT'|'FIT_TO_WIDTH'|'DO_NOT_SCALE'|'SCALE_TO_VISUAL'
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'DataSetIdentifier': 'string'
},
'EmptyVisual': {
'VisualId': 'string',
'DataSetIdentifier': 'string',
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
]
},
'RadarChartVisual': {
'VisualId': 'string',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'Subtitle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FormatText': {
'PlainText': 'string',
'RichText': 'string'
}
},
'ChartConfiguration': {
'FieldWells': {
'RadarChartAggregatedFieldWells': {
'Category': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Color': [
{
'NumericalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'HierarchyId': 'string',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateDimensionField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DateGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'HierarchyId': 'string',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
}
},
],
'Values': [
{
'NumericalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'FormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CategoricalMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'FormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'DateMeasureField': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'FormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'CalculatedMeasureField': {
'FieldId': 'string',
'Expression': 'string'
}
},
]
}
},
'SortConfiguration': {
'CategorySort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'CategoryItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
},
'ColorSort': [
{
'FieldSort': {
'FieldId': 'string',
'Direction': 'ASC'|'DESC'
},
'ColumnSort': {
'SortBy': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Direction': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
}
},
],
'ColorItemsLimit': {
'ItemsLimit': 123,
'OtherCategories': 'INCLUDE'|'EXCLUDE'
}
},
'Shape': 'CIRCLE'|'POLYGON',
'BaseSeriesSettings': {
'AreaStyleSettings': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'StartAngle': 123.0,
'VisualPalette': {
'ChartColor': 'string',
'ColorMap': [
{
'Element': {
'FieldId': 'string',
'FieldValue': 'string',
'DataPathType': {
'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN'|'MULTIPLE_ROW_METRICS_COLUMN'|'EMPTY_COLUMN_HEADER'|'COUNT_METRIC_COLUMN'
}
},
'Color': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
]
},
'AlternateBandColorsVisibility': 'HIDDEN'|'VISIBLE',
'AlternateBandEvenColor': 'string',
'AlternateBandOddColor': 'string',
'CategoryAxis': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'CategoryLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'ColorAxis': {
'TickLabelOptions': {
'LabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'RotationAngle': 123.0
},
'AxisLineVisibility': 'HIDDEN'|'VISIBLE',
'GridLineVisibility': 'HIDDEN'|'VISIBLE',
'DataOptions': {
'NumericAxisOptions': {
'Scale': {
'Linear': {
'StepCount': 123,
'StepSize': 123.0
},
'Logarithmic': {
'Base': 123.0
}
},
'Range': {
'MinMax': {
'Minimum': 123.0,
'Maximum': 123.0
},
'DataDriven': {}
}
},
'DateAxisOptions': {
'MissingDateVisibility': 'HIDDEN'|'VISIBLE'
}
},
'ScrollbarOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'VisibleRange': {
'PercentRange': {
'From': 123.0,
'To': 123.0
}
}
},
'AxisOffset': 'string'
},
'ColorLabelOptions': {
'Visibility': 'HIDDEN'|'VISIBLE',
'SortIconVisibility': 'HIDDEN'|'VISIBLE',
'AxisLabelOptions': [
{
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string',
'ApplyTo': {
'FieldId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
},
'Legend': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Title': {
'Visibility': 'HIDDEN'|'VISIBLE',
'FontConfiguration': {
'FontSize': {
'Relative': 'EXTRA_SMALL'|'SMALL'|'MEDIUM'|'LARGE'|'EXTRA_LARGE'
},
'FontDecoration': 'UNDERLINE'|'NONE',
'FontColor': 'string',
'FontWeight': {
'Name': 'NORMAL'|'BOLD'
},
'FontStyle': 'NORMAL'|'ITALIC'
},
'CustomLabel': 'string'
},
'Position': 'AUTO'|'RIGHT'|'BOTTOM'|'TOP',
'Width': 'string',
'Height': 'string'
},
'AxesRangeScale': 'AUTO'|'INDEPENDENT'|'SHARED'
},
'Actions': [
{
'CustomActionId': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'Trigger': 'DATA_POINT_CLICK'|'DATA_POINT_MENU',
'ActionOperations': [
{
'FilterOperation': {
'SelectedFieldsConfiguration': {
'SelectedFields': [
'string',
],
'SelectedFieldOptions': 'ALL_FIELDS',
'SelectedColumns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
]
},
'TargetVisualsConfiguration': {
'SameSheetTargetVisualConfiguration': {
'TargetVisuals': [
'string',
],
'TargetVisualOptions': 'ALL_VISUALS'
}
}
},
'NavigationOperation': {
'LocalNavigationConfiguration': {
'TargetSheetId': 'string'
}
},
'URLOperation': {
'URLTemplate': 'string',
'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
},
'SetParametersOperation': {
'ParameterValueConfigurations': [
{
'DestinationParameterName': 'string',
'Value': {
'CustomValuesConfiguration': {
'IncludeNullValue': True|False,
'CustomValues': {
'StringValues': [
'string',
],
'IntegerValues': [
123,
],
'DecimalValues': [
123.0,
],
'DateTimeValues': [
datetime(2015, 1, 1),
]
}
},
'SelectAllValueOptions': 'ALL_VALUES',
'SourceParameterName': 'string',
'SourceField': 'string',
'SourceColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
}
},
]
}
},
]
},
],
'ColumnHierarchies': [
{
'ExplicitHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'DateTimeHierarchy': {
'HierarchyId': 'string',
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
},
'PredefinedHierarchy': {
'HierarchyId': 'string',
'Columns': [
{
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
],
'DrillDownFilters': [
{
'NumericEqualityFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0
},
'CategoryFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'CategoryValues': [
'string',
]
},
'TimeRangeFilter': {
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'RangeMinimum': datetime(2015, 1, 1),
'RangeMaximum': datetime(2015, 1, 1),
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
}
},
]
}
},
]
}
},
],
'TextBoxes': [
{
'SheetTextBoxId': 'string',
'Content': 'string'
},
],
'Layouts': [
{
'Configuration': {
'GridLayout': {
'Elements': [
{
'ElementId': 'string',
'ElementType': 'VISUAL'|'FILTER_CONTROL'|'PARAMETER_CONTROL'|'TEXT_BOX',
'ColumnIndex': 123,
'ColumnSpan': 123,
'RowIndex': 123,
'RowSpan': 123
},
],
'CanvasSizeOptions': {
'ScreenCanvasSizeOptions': {
'ResizeOption': 'FIXED'|'RESPONSIVE',
'OptimizedViewPortWidth': 'string'
}
}
},
'FreeFormLayout': {
'Elements': [
{
'ElementId': 'string',
'ElementType': 'VISUAL'|'FILTER_CONTROL'|'PARAMETER_CONTROL'|'TEXT_BOX',
'XAxisLocation': 'string',
'YAxisLocation': 'string',
'Width': 'string',
'Height': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'RenderingRules': [
{
'Expression': 'string',
'ConfigurationOverrides': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'BorderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'SelectedBorderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'BackgroundStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'LoadingAnimation': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'CanvasSizeOptions': {
'ScreenCanvasSizeOptions': {
'OptimizedViewPortWidth': 'string'
}
}
},
'SectionBasedLayout': {
'HeaderSections': [
{
'SectionId': 'string',
'Layout': {
'FreeFormLayout': {
'Elements': [
{
'ElementId': 'string',
'ElementType': 'VISUAL'|'FILTER_CONTROL'|'PARAMETER_CONTROL'|'TEXT_BOX',
'XAxisLocation': 'string',
'YAxisLocation': 'string',
'Width': 'string',
'Height': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'RenderingRules': [
{
'Expression': 'string',
'ConfigurationOverrides': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'BorderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'SelectedBorderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'BackgroundStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'LoadingAnimation': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
]
}
},
'Style': {
'Height': 'string',
'Padding': {
'Top': 'string',
'Bottom': 'string',
'Left': 'string',
'Right': 'string'
}
}
},
],
'BodySections': [
{
'SectionId': 'string',
'Content': {
'Layout': {
'FreeFormLayout': {
'Elements': [
{
'ElementId': 'string',
'ElementType': 'VISUAL'|'FILTER_CONTROL'|'PARAMETER_CONTROL'|'TEXT_BOX',
'XAxisLocation': 'string',
'YAxisLocation': 'string',
'Width': 'string',
'Height': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'RenderingRules': [
{
'Expression': 'string',
'ConfigurationOverrides': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'BorderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'SelectedBorderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'BackgroundStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'LoadingAnimation': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
]
}
}
},
'Style': {
'Height': 'string',
'Padding': {
'Top': 'string',
'Bottom': 'string',
'Left': 'string',
'Right': 'string'
}
},
'PageBreakConfiguration': {
'After': {
'Status': 'ENABLED'|'DISABLED'
}
}
},
],
'FooterSections': [
{
'SectionId': 'string',
'Layout': {
'FreeFormLayout': {
'Elements': [
{
'ElementId': 'string',
'ElementType': 'VISUAL'|'FILTER_CONTROL'|'PARAMETER_CONTROL'|'TEXT_BOX',
'XAxisLocation': 'string',
'YAxisLocation': 'string',
'Width': 'string',
'Height': 'string',
'Visibility': 'HIDDEN'|'VISIBLE',
'RenderingRules': [
{
'Expression': 'string',
'ConfigurationOverrides': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
],
'BorderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'SelectedBorderStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'BackgroundStyle': {
'Visibility': 'HIDDEN'|'VISIBLE',
'Color': 'string'
},
'LoadingAnimation': {
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
]
}
},
'Style': {
'Height': 'string',
'Padding': {
'Top': 'string',
'Bottom': 'string',
'Left': 'string',
'Right': 'string'
}
}
},
],
'CanvasSizeOptions': {
'PaperCanvasSizeOptions': {
'PaperSize': 'US_LETTER'|'US_LEGAL'|'US_TABLOID_LEDGER'|'A0'|'A1'|'A2'|'A3'|'A4'|'A5'|'JIS_B4'|'JIS_B5',
'PaperOrientation': 'PORTRAIT'|'LANDSCAPE',
'PaperMargin': {
'Top': 'string',
'Bottom': 'string',
'Left': 'string',
'Right': 'string'
}
}
}
}
}
},
],
'SheetControlLayouts': [
{
'Configuration': {
'GridLayout': {
'Elements': [
{
'ElementId': 'string',
'ElementType': 'VISUAL'|'FILTER_CONTROL'|'PARAMETER_CONTROL'|'TEXT_BOX',
'ColumnIndex': 123,
'ColumnSpan': 123,
'RowIndex': 123,
'RowSpan': 123
},
],
'CanvasSizeOptions': {
'ScreenCanvasSizeOptions': {
'ResizeOption': 'FIXED'|'RESPONSIVE',
'OptimizedViewPortWidth': 'string'
}
}
}
}
},
],
'ContentType': 'PAGINATED'|'INTERACTIVE'
},
],
'CalculatedFields': [
{
'DataSetIdentifier': 'string',
'Name': 'string',
'Expression': 'string'
},
],
'ParameterDeclarations': [
{
'StringParameterDeclaration': {
'ParameterValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'Name': 'string',
'DefaultValues': {
'DynamicValue': {
'UserNameColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'GroupNameColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DefaultValueColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
},
'StaticValues': [
'string',
]
},
'ValueWhenUnset': {
'ValueWhenUnsetOption': 'RECOMMENDED_VALUE'|'NULL',
'CustomValue': 'string'
},
'MappedDataSetParameters': [
{
'DataSetIdentifier': 'string',
'DataSetParameterName': 'string'
},
]
},
'DecimalParameterDeclaration': {
'ParameterValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'Name': 'string',
'DefaultValues': {
'DynamicValue': {
'UserNameColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'GroupNameColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DefaultValueColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
},
'StaticValues': [
123.0,
]
},
'ValueWhenUnset': {
'ValueWhenUnsetOption': 'RECOMMENDED_VALUE'|'NULL',
'CustomValue': 123.0
},
'MappedDataSetParameters': [
{
'DataSetIdentifier': 'string',
'DataSetParameterName': 'string'
},
]
},
'IntegerParameterDeclaration': {
'ParameterValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'Name': 'string',
'DefaultValues': {
'DynamicValue': {
'UserNameColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'GroupNameColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DefaultValueColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
},
'StaticValues': [
123,
]
},
'ValueWhenUnset': {
'ValueWhenUnsetOption': 'RECOMMENDED_VALUE'|'NULL',
'CustomValue': 123
},
'MappedDataSetParameters': [
{
'DataSetIdentifier': 'string',
'DataSetParameterName': 'string'
},
]
},
'DateTimeParameterDeclaration': {
'Name': 'string',
'DefaultValues': {
'DynamicValue': {
'UserNameColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'GroupNameColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'DefaultValueColumn': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
}
},
'StaticValues': [
datetime(2015, 1, 1),
],
'RollingDate': {
'DataSetIdentifier': 'string',
'Expression': 'string'
}
},
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'ValueWhenUnset': {
'ValueWhenUnsetOption': 'RECOMMENDED_VALUE'|'NULL',
'CustomValue': datetime(2015, 1, 1)
},
'MappedDataSetParameters': [
{
'DataSetIdentifier': 'string',
'DataSetParameterName': 'string'
},
]
}
},
],
'FilterGroups': [
{
'FilterGroupId': 'string',
'Filters': [
{
'CategoryFilter': {
'FilterId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Configuration': {
'FilterListConfiguration': {
'MatchOperator': 'EQUALS'|'DOES_NOT_EQUAL'|'CONTAINS'|'DOES_NOT_CONTAIN'|'STARTS_WITH'|'ENDS_WITH',
'CategoryValues': [
'string',
],
'SelectAllOptions': 'FILTER_ALL_VALUES',
'NullOption': 'ALL_VALUES'|'NULLS_ONLY'|'NON_NULLS_ONLY'
},
'CustomFilterListConfiguration': {
'MatchOperator': 'EQUALS'|'DOES_NOT_EQUAL'|'CONTAINS'|'DOES_NOT_CONTAIN'|'STARTS_WITH'|'ENDS_WITH',
'CategoryValues': [
'string',
],
'SelectAllOptions': 'FILTER_ALL_VALUES',
'NullOption': 'ALL_VALUES'|'NULLS_ONLY'|'NON_NULLS_ONLY'
},
'CustomFilterConfiguration': {
'MatchOperator': 'EQUALS'|'DOES_NOT_EQUAL'|'CONTAINS'|'DOES_NOT_CONTAIN'|'STARTS_WITH'|'ENDS_WITH',
'CategoryValue': 'string',
'SelectAllOptions': 'FILTER_ALL_VALUES',
'ParameterName': 'string',
'NullOption': 'ALL_VALUES'|'NULLS_ONLY'|'NON_NULLS_ONLY'
}
}
},
'NumericRangeFilter': {
'FilterId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False,
'RangeMinimum': {
'StaticValue': 123.0,
'Parameter': 'string'
},
'RangeMaximum': {
'StaticValue': 123.0,
'Parameter': 'string'
},
'SelectAllOptions': 'FILTER_ALL_VALUES',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
},
'NullOption': 'ALL_VALUES'|'NULLS_ONLY'|'NON_NULLS_ONLY'
},
'NumericEqualityFilter': {
'FilterId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': 123.0,
'SelectAllOptions': 'FILTER_ALL_VALUES',
'MatchOperator': 'EQUALS'|'DOES_NOT_EQUAL',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
},
'ParameterName': 'string',
'NullOption': 'ALL_VALUES'|'NULLS_ONLY'|'NON_NULLS_ONLY'
},
'TimeEqualityFilter': {
'FilterId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Value': datetime(2015, 1, 1),
'ParameterName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'RollingDate': {
'DataSetIdentifier': 'string',
'Expression': 'string'
}
},
'TimeRangeFilter': {
'FilterId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False,
'RangeMinimumValue': {
'StaticValue': datetime(2015, 1, 1),
'RollingDate': {
'DataSetIdentifier': 'string',
'Expression': 'string'
},
'Parameter': 'string'
},
'RangeMaximumValue': {
'StaticValue': datetime(2015, 1, 1),
'RollingDate': {
'DataSetIdentifier': 'string',
'Expression': 'string'
},
'Parameter': 'string'
},
'NullOption': 'ALL_VALUES'|'NULLS_ONLY'|'NON_NULLS_ONLY',
'ExcludePeriodConfiguration': {
'Amount': 123,
'Granularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Status': 'ENABLED'|'DISABLED'
},
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
'RelativeDatesFilter': {
'FilterId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'AnchorDateConfiguration': {
'AnchorOption': 'NOW',
'ParameterName': 'string'
},
'MinimumGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'RelativeDateType': 'PREVIOUS'|'THIS'|'LAST'|'NOW'|'NEXT',
'RelativeDateValue': 123,
'ParameterName': 'string',
'NullOption': 'ALL_VALUES'|'NULLS_ONLY'|'NON_NULLS_ONLY',
'ExcludePeriodConfiguration': {
'Amount': 123,
'Granularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Status': 'ENABLED'|'DISABLED'
}
},
'TopBottomFilter': {
'FilterId': 'string',
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'Limit': 123,
'AggregationSortConfigurations': [
{
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'SortDirection': 'ASC'|'DESC',
'AggregationFunction': {
'NumericalAggregationFunction': {
'SimpleNumericalAggregation': 'SUM'|'AVERAGE'|'MIN'|'MAX'|'COUNT'|'DISTINCT_COUNT'|'VAR'|'VARP'|'STDEV'|'STDEVP'|'MEDIAN',
'PercentileAggregation': {
'PercentileValue': 123.0
}
},
'CategoricalAggregationFunction': 'COUNT'|'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT'|'DISTINCT_COUNT'|'MIN'|'MAX',
'AttributeAggregationFunction': {
'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'
}
}
},
],
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'ParameterName': 'string'
}
},
],
'ScopeConfiguration': {
'SelectedSheets': {
'SheetVisualScopingConfigurations': [
{
'SheetId': 'string',
'Scope': 'ALL_VISUALS'|'SELECTED_VISUALS',
'VisualIds': [
'string',
]
},
]
},
'AllSheets': {}
},
'Status': 'ENABLED'|'DISABLED',
'CrossDataset': 'ALL_DATASETS'|'SINGLE_DATASET'
},
],
'ColumnConfigurations': [
{
'Column': {
'DataSetIdentifier': 'string',
'ColumnName': 'string'
},
'FormatConfiguration': {
'StringFormatConfiguration': {
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
},
'NumberFormatConfiguration': {
'FormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
},
'DateTimeFormatConfiguration': {
'DateTimeFormat': 'string',
'NullValueFormatConfiguration': {
'NullString': 'string'
},
'NumericFormatConfiguration': {
'NumberDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'CurrencyDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'Symbol': 'string',
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NumberScale': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
},
'PercentageDisplayFormatConfiguration': {
'Prefix': 'string',
'Suffix': 'string',
'SeparatorConfiguration': {
'DecimalSeparator': 'COMMA'|'DOT'|'SPACE',
'ThousandsSeparator': {
'Symbol': 'COMMA'|'DOT'|'SPACE',
'Visibility': 'HIDDEN'|'VISIBLE'
}
},
'DecimalPlacesConfiguration': {
'DecimalPlaces': 123
},
'NegativeValueConfiguration': {
'DisplayMode': 'POSITIVE'|'NEGATIVE'
},
'NullValueFormatConfiguration': {
'NullString': 'string'
}
}
}
}
},
'Role': 'DIMENSION'|'MEASURE',
'ColorsConfiguration': {
'CustomColors': [
{
'FieldValue': 'string',
'Color': 'string',
'SpecialValue': 'EMPTY'|'NULL'|'OTHER'
},
]
}
},
],
'AnalysisDefaults': {
'DefaultNewSheetConfiguration': {
'InteractiveLayoutConfiguration': {
'Grid': {
'CanvasSizeOptions': {
'ScreenCanvasSizeOptions': {
'ResizeOption': 'FIXED'|'RESPONSIVE',
'OptimizedViewPortWidth': 'string'
}
}
},
'FreeForm': {
'CanvasSizeOptions': {
'ScreenCanvasSizeOptions': {
'OptimizedViewPortWidth': 'string'
}
}
}
},
'PaginatedLayoutConfiguration': {
'SectionBased': {
'CanvasSizeOptions': {
'PaperCanvasSizeOptions': {
'PaperSize': 'US_LETTER'|'US_LEGAL'|'US_TABLOID_LEDGER'|'A0'|'A1'|'A2'|'A3'|'A4'|'A5'|'JIS_B4'|'JIS_B5',
'PaperOrientation': 'PORTRAIT'|'LANDSCAPE',
'PaperMargin': {
'Top': 'string',
'Bottom': 'string',
'Left': 'string',
'Right': 'string'
}
}
}
}
},
'SheetContentType': 'PAGINATED'|'INTERACTIVE'
}
},
'Options': {
'Timezone': 'string',
'WeekStart': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'
}
},
ValidationStrategy={
'Mode': 'STRICT'|'LENIENT'
},
FolderArns=[
'string',
],
LinkSharingConfiguration={
'Permissions': [
{
'Principal': 'string',
'Actions': [
'string',
]
},
]
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account where you want to create the dashboard.
string
[REQUIRED]
The ID for the dashboard, also added to the IAM policy.
string
[REQUIRED]
The display name of the dashboard.
dict
The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
StringParameters (list) --
The parameters that have a data type of string.
(dict) --
A string parameter.
Name (string) -- [REQUIRED]
A display name for a string parameter.
Values (list) -- [REQUIRED]
The values of a string parameter.
(string) --
IntegerParameters (list) --
The parameters that have a data type of integer.
(dict) --
An integer parameter.
Name (string) -- [REQUIRED]
The name of the integer parameter.
Values (list) -- [REQUIRED]
The values for the integer parameter.
(integer) --
DecimalParameters (list) --
The parameters that have a data type of decimal.
(dict) --
A decimal parameter.
Name (string) -- [REQUIRED]
A display name for the decimal parameter.
Values (list) -- [REQUIRED]
The values for the decimal parameter.
(float) --
DateTimeParameters (list) --
The parameters that have a data type of date-time.
(dict) --
A date-time parameter.
Name (string) -- [REQUIRED]
A display name for the date-time parameter.
Values (list) -- [REQUIRED]
The values for the date-time parameter.
(datetime) --
list
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
The entity that you are using as a source when you create the dashboard. In SourceEntity , you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the `` CreateTemplate `` API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
Either a SourceEntity or a Definition must be provided in order for the request to be valid.
SourceTemplate (dict) --
Source template.
DataSetReferences (list) -- [REQUIRED]
Dataset references.
(dict) --
Dataset reference.
DataSetPlaceholder (string) -- [REQUIRED]
Dataset placeholder.
DataSetArn (string) -- [REQUIRED]
Dataset Amazon Resource Name (ARN).
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the resource.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
string
A description for the first version of the dashboard being created.
dict
Options for publishing the dashboard when you create it:
AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED . When this is set to DISABLED , Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED . The visual option to export data to .CSV format isn't enabled when this is set to DISABLED . This option is ENABLED by default.
VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED . This option is COLLAPSED by default.
AdHocFilteringOption (dict) --
Ad hoc (one-time) filtering option.
AvailabilityStatus (string) --
Availability status.
ExportToCSVOption (dict) --
Export to .csv option.
AvailabilityStatus (string) --
Availability status.
SheetControlsOption (dict) --
Sheet controls option.
VisibilityState (string) --
Visibility state.
VisualPublishOptions (dict) --
The visual publish options of a visual in a dashboard.
ExportHiddenFieldsOption (dict) --
Determines if hidden fields are included in an exported dashboard.
AvailabilityStatus (string) --
The status of the export hidden fields options of a dashbaord.
SheetLayoutElementMaximizationOption (dict) --
The sheet layout maximization options of a dashbaord.
AvailabilityStatus (string) --
The status of the sheet layout maximization options of a dashbaord.
VisualMenuOption (dict) --
The menu options of a visual in a dashboard.
AvailabilityStatus (string) --
The availaiblity status of a visual's menu options.
VisualAxisSortOption (dict) --
The axis sort options of a dashboard.
AvailabilityStatus (string) --
The availaiblity status of a visual's axis sort options.
ExportWithHiddenFieldsOption (dict) --
Determines if hidden fields are exported with a dashboard.
AvailabilityStatus (string) --
The status of the export with hidden fields options.
DataPointDrillUpDownOption (dict) --
The drill-down options of data points in a dashboard.
AvailabilityStatus (string) --
The status of the drill down options of data points.
DataPointMenuLabelOption (dict) --
The data point menu label options of a dashboard.
AvailabilityStatus (string) --
The status of the data point menu options.
DataPointTooltipOption (dict) --
The data point tool tip options of a dashboard.
AvailabilityStatus (string) --
The status of the data point tool tip options.
string
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
dict
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Either a SourceEntity or a Definition must be provided in order for the request to be valid.
DataSetIdentifierDeclarations (list) -- [REQUIRED]
An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.
(dict) --
A data set.
Identifier (string) -- [REQUIRED]
The identifier of the data set, typically the data set's name.
DataSetArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the data set.
Sheets (list) --
An array of sheet definitions for a dashboard.
(dict) --
A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.
SheetId (string) -- [REQUIRED]
The unique identifier of a sheet.
Title (string) --
The title of the sheet.
Description (string) --
A description of the sheet.
Name (string) --
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
ParameterControls (list) --
The list of parameter controls that are on a sheet.
For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide .
(dict) --
The control of a parameter that users can interact with in a dashboard or an analysis.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
DateTimePicker (dict) --
A control from a date parameter that specifies date and time.
ParameterControlId (string) -- [REQUIRED]
The ID of the ParameterDateTimePickerControl .
Title (string) -- [REQUIRED]
The title of the ParameterDateTimePickerControl .
SourceParameterName (string) -- [REQUIRED]
The name of the ParameterDateTimePickerControl .
DisplayOptions (dict) --
The display options of a control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
DateTimeFormat (string) --
Customize how dates are formatted in controls.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
List (dict) --
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
ParameterControlId (string) -- [REQUIRED]
The ID of the ParameterListControl .
Title (string) -- [REQUIRED]
The title of the ParameterListControl .
SourceParameterName (string) -- [REQUIRED]
The source parameter name of the ParameterListControl .
DisplayOptions (dict) --
The display options of a control.
SearchOptions (dict) --
The configuration of the search options in a list control.
Visibility (string) --
The visibility configuration of the search options in a list control.
SelectAllOptions (dict) --
The configuration of the Select all options in a list control.
Visibility (string) --
The visibility configuration of the Select all options in a list control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
Type (string) --
The type of ParameterListControl .
SelectableValues (dict) --
A list of selectable values that are used in a control.
Values (list) --
The values that are used in ParameterSelectableValues .
(string) --
LinkToDataSetColumn (dict) --
The column identifier that fetches values from the data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CascadingControlConfiguration (dict) --
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.
SourceControls (list) --
A list of source controls that determine the values that are used in the current control.
(dict) --
The source controls that are used in a CascadingControlConfiguration .
SourceSheetControlId (string) --
The source sheet control ID of a CascadingControlSource .
ColumnToMatch (dict) --
The column identifier that determines which column to look up for the source sheet control.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Dropdown (dict) --
A control to display a dropdown list with buttons that are used to select a single value.
ParameterControlId (string) -- [REQUIRED]
The ID of the ParameterDropDownControl .
Title (string) -- [REQUIRED]
The title of the ParameterDropDownControl .
SourceParameterName (string) -- [REQUIRED]
The source parameter name of the ParameterDropDownControl .
DisplayOptions (dict) --
The display options of a control.
SelectAllOptions (dict) --
The configuration of the Select all options in a dropdown control.
Visibility (string) --
The visibility configuration of the Select all options in a list control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
Type (string) --
The type parameter name of the ParameterDropDownControl .
SelectableValues (dict) --
A list of selectable values that are used in a control.
Values (list) --
The values that are used in ParameterSelectableValues .
(string) --
LinkToDataSetColumn (dict) --
The column identifier that fetches values from the data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CascadingControlConfiguration (dict) --
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.
SourceControls (list) --
A list of source controls that determine the values that are used in the current control.
(dict) --
The source controls that are used in a CascadingControlConfiguration .
SourceSheetControlId (string) --
The source sheet control ID of a CascadingControlSource .
ColumnToMatch (dict) --
The column identifier that determines which column to look up for the source sheet control.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TextField (dict) --
A control to display a text box that is used to enter a single entry.
ParameterControlId (string) -- [REQUIRED]
The ID of the ParameterTextFieldControl .
Title (string) -- [REQUIRED]
The title of the ParameterTextFieldControl .
SourceParameterName (string) -- [REQUIRED]
The source parameter name of the ParameterTextFieldControl .
DisplayOptions (dict) --
The display options of a control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
PlaceholderOptions (dict) --
The configuration of the placeholder options in a text field control.
Visibility (string) --
The visibility configuration of the placeholder options in a text control.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
TextArea (dict) --
A control to display a text box that is used to enter multiple entries.
ParameterControlId (string) -- [REQUIRED]
The ID of the ParameterTextAreaControl .
Title (string) -- [REQUIRED]
The title of the ParameterTextAreaControl .
SourceParameterName (string) -- [REQUIRED]
The source parameter name of the ParameterTextAreaControl .
Delimiter (string) --
The delimiter that is used to separate the lines in text.
DisplayOptions (dict) --
The display options of a control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
PlaceholderOptions (dict) --
The configuration of the placeholder options in a text area control.
Visibility (string) --
The visibility configuration of the placeholder options in a text control.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
Slider (dict) --
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
ParameterControlId (string) -- [REQUIRED]
The ID of the ParameterSliderControl .
Title (string) -- [REQUIRED]
The title of the ParameterSliderControl .
SourceParameterName (string) -- [REQUIRED]
The source parameter name of the ParameterSliderControl .
DisplayOptions (dict) --
The display options of a control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
MaximumValue (float) -- [REQUIRED]
The smaller value that is displayed at the left of the slider.
MinimumValue (float) -- [REQUIRED]
The larger value that is displayed at the right of the slider.
StepSize (float) -- [REQUIRED]
The number of increments that the slider bar is divided into.
FilterControls (list) --
The list of filter controls that are on a sheet.
For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide .
(dict) --
The control of a filter that is used to interact with a dashboard or an analysis.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
DateTimePicker (dict) --
A control from a date filter that is used to specify date and time.
FilterControlId (string) -- [REQUIRED]
The ID of the FilterDateTimePickerControl .
Title (string) -- [REQUIRED]
The title of the FilterDateTimePickerControl .
SourceFilterId (string) -- [REQUIRED]
The source filter ID of the FilterDateTimePickerControl .
DisplayOptions (dict) --
The display options of a control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
DateTimeFormat (string) --
Customize how dates are formatted in controls.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
Type (string) --
The date time picker type of a FilterDateTimePickerControl . Choose one of the following options:
SINGLE_VALUED : The filter condition is a fixed date.
DATE_RANGE : The filter condition is a date time range.
List (dict) --
A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.
FilterControlId (string) -- [REQUIRED]
The ID of the FilterListControl .
Title (string) -- [REQUIRED]
The title of the FilterListControl .
SourceFilterId (string) -- [REQUIRED]
The source filter ID of the FilterListControl .
DisplayOptions (dict) --
The display options of a control.
SearchOptions (dict) --
The configuration of the search options in a list control.
Visibility (string) --
The visibility configuration of the search options in a list control.
SelectAllOptions (dict) --
The configuration of the Select all options in a list control.
Visibility (string) --
The visibility configuration of the Select all options in a list control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
Type (string) --
The type of FilterListControl . Choose one of the following options:
MULTI_SELECT : The user can select multiple entries from the list.
SINGLE_SELECT : The user can select a single entry from the list.
SelectableValues (dict) --
A list of selectable values that are used in a control.
Values (list) --
The values that are used in the FilterSelectableValues .
(string) --
CascadingControlConfiguration (dict) --
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.
SourceControls (list) --
A list of source controls that determine the values that are used in the current control.
(dict) --
The source controls that are used in a CascadingControlConfiguration .
SourceSheetControlId (string) --
The source sheet control ID of a CascadingControlSource .
ColumnToMatch (dict) --
The column identifier that determines which column to look up for the source sheet control.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Dropdown (dict) --
A control to display a dropdown list with buttons that are used to select a single value.
FilterControlId (string) -- [REQUIRED]
The ID of the FilterDropDownControl .
Title (string) -- [REQUIRED]
The title of the FilterDropDownControl .
SourceFilterId (string) -- [REQUIRED]
The source filter ID of the FilterDropDownControl .
DisplayOptions (dict) --
The display options of the FilterDropDownControl .
SelectAllOptions (dict) --
The configuration of the Select all options in a dropdown control.
Visibility (string) --
The visibility configuration of the Select all options in a list control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
Type (string) --
The type of the FilterDropDownControl . Choose one of the following options:
MULTI_SELECT : The user can select multiple entries from a dropdown menu.
SINGLE_SELECT : The user can select a single entry from a dropdown menu.
SelectableValues (dict) --
A list of selectable values that are used in a control.
Values (list) --
The values that are used in the FilterSelectableValues .
(string) --
CascadingControlConfiguration (dict) --
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.
SourceControls (list) --
A list of source controls that determine the values that are used in the current control.
(dict) --
The source controls that are used in a CascadingControlConfiguration .
SourceSheetControlId (string) --
The source sheet control ID of a CascadingControlSource .
ColumnToMatch (dict) --
The column identifier that determines which column to look up for the source sheet control.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TextField (dict) --
A control to display a text box that is used to enter a single entry.
FilterControlId (string) -- [REQUIRED]
The ID of the FilterTextFieldControl .
Title (string) -- [REQUIRED]
The title of the FilterTextFieldControl .
SourceFilterId (string) -- [REQUIRED]
The source filter ID of the FilterTextFieldControl .
DisplayOptions (dict) --
The display options of a control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
PlaceholderOptions (dict) --
The configuration of the placeholder options in a text field control.
Visibility (string) --
The visibility configuration of the placeholder options in a text control.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
TextArea (dict) --
A control to display a text box that is used to enter multiple entries.
FilterControlId (string) -- [REQUIRED]
The ID of the FilterTextAreaControl .
Title (string) -- [REQUIRED]
The title of the FilterTextAreaControl .
SourceFilterId (string) -- [REQUIRED]
The source filter ID of the FilterTextAreaControl .
Delimiter (string) --
The delimiter that is used to separate the lines in text.
DisplayOptions (dict) --
The display options of a control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
PlaceholderOptions (dict) --
The configuration of the placeholder options in a text area control.
Visibility (string) --
The visibility configuration of the placeholder options in a text control.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
Slider (dict) --
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
FilterControlId (string) -- [REQUIRED]
The ID of the FilterSliderControl .
Title (string) -- [REQUIRED]
The title of the FilterSliderControl .
SourceFilterId (string) -- [REQUIRED]
The source filter ID of the FilterSliderControl .
DisplayOptions (dict) --
The display options of a control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
Type (string) --
The type of FilterSliderControl . Choose one of the following options:
SINGLE_POINT : Filter against(equals) a single data point.
RANGE : Filter data that is in a specified range.
MaximumValue (float) -- [REQUIRED]
The smaller value that is displayed at the left of the slider.
MinimumValue (float) -- [REQUIRED]
The larger value that is displayed at the right of the slider.
StepSize (float) -- [REQUIRED]
The number of increments that the slider bar is divided into.
RelativeDateTime (dict) --
A control from a date filter that is used to specify the relative date.
FilterControlId (string) -- [REQUIRED]
The ID of the FilterTextAreaControl .
Title (string) -- [REQUIRED]
The title of the FilterTextAreaControl .
SourceFilterId (string) -- [REQUIRED]
The source filter ID of the FilterTextAreaControl .
DisplayOptions (dict) --
The display options of a control.
TitleOptions (dict) --
The options to configure the title visibility, name, and font size.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
DateTimeFormat (string) --
Customize how dates are formatted in controls.
InfoIconLabelOptions (dict) --
The configuration of info icon label options.
Visibility (string) --
The visibility configuration of info icon label options.
InfoIconText (string) --
The text content of info icon.
Visuals (list) --
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
(dict) --
A visual displayed on a sheet in an analysis, dashboard, or template.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
TableVisual (dict) --
A table visual.
For more information, see Using tables as visuals in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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..
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field wells of the visual.
TableAggregatedFieldWells (dict) --
The aggregated field well for the table.
GroupBy (list) --
The group by field well for a pivot table. Values are grouped by group by fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The values field well for a pivot table. Values are aggregated based on group by fields.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
TableUnaggregatedFieldWells (dict) --
The unaggregated field well for the table.
Values (list) --
The values field well for a pivot table. Values are unaggregated for an unaggregated table.
(dict) --
The unaggregated field for a table.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the UnaggregatedField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
FormatConfiguration (dict) --
The format configuration of the field.
StringFormatConfiguration (dict) --
Formatting configuration for string fields.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumberFormatConfiguration (dict) --
Formatting configuration for number fields.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateTimeFormatConfiguration (dict) --
Formatting configuration for DateTime fields.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
SortConfiguration (dict) --
The sort configuration for a TableVisual .
RowSort (list) --
The field sort options for rows in the table.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
PaginationConfiguration (dict) --
The pagination configuration (page size, page number) for the table.
PageSize (integer) -- [REQUIRED]
Indicates how many items render in one page.
PageNumber (integer) -- [REQUIRED]
Indicates the page number.
TableOptions (dict) --
The table options for a table visual.
Orientation (string) --
The orientation (vertical, horizontal) for a table.
HeaderStyle (dict) --
The table cell style of a table header.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
CellStyle (dict) --
The table cell style of table cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
RowAlternateColorOptions (dict) --
The row alternate color options (widget status, row alternate colors) for a table.
Status (string) --
Determines the widget status.
RowAlternateColors (list) --
Determines the list of row alternate colors.
(string) --
UsePrimaryBackgroundColor (string) --
The primary background color options for alternate rows.
TotalOptions (dict) --
The total options for a table visual.
TotalsVisibility (string) --
The visibility configuration for the total cells.
Placement (string) --
The placement (start, end) for the total cells.
ScrollStatus (string) --
The scroll status (pinned, scrolled) for the total cells.
CustomLabel (string) --
The custom label string for the total cells.
TotalCellStyle (dict) --
Cell styling options for the total cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
TotalAggregationOptions (list) --
The total aggregation settings for each value field.
(dict) --
The total aggregation settings map of a field id.
FieldId (string) -- [REQUIRED]
The field id that's associated with the total aggregation option.
TotalAggregationFunction (dict) -- [REQUIRED]
The total aggregation function that you want to set for a specified field id.
SimpleTotalAggregationFunction (string) --
A built in aggregation function for total values.
FieldOptions (dict) --
The field options for a table visual.
SelectedFieldOptions (list) --
The field options to be configured to a table.
(dict) --
The options for a table field.
FieldId (string) -- [REQUIRED]
The field ID for a table field.
Width (string) --
The width for a table field.
CustomLabel (string) --
The custom label for a table field.
Visibility (string) --
The visibility of a table field.
URLStyling (dict) --
The URL configuration for a table field.
LinkConfiguration (dict) --
The link configuration of a table field URL.
Target (string) -- [REQUIRED]
The URL target (new tab, new window, same tab) for the table link configuration.
Content (dict) -- [REQUIRED]
The URL content (text, icon) for the table link configuration.
CustomTextContent (dict) --
The custom text content (value, font configuration) for the table link content configuration.
Value (string) --
The string value of the custom text content for the table URL link content.
FontConfiguration (dict) -- [REQUIRED]
The font configuration of the custom text content for the table URL link content.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomIconContent (dict) --
The custom icon content for the table link content configuration.
Icon (string) --
The icon set type (link) of the custom icon content for table URL link content.
ImageConfiguration (dict) --
The image configuration of a table field URL.
SizingOptions (dict) --
The sizing options for the table image configuration.
TableCellImageScalingConfiguration (string) --
The cell scaling configuration of the sizing options for the table image configuration.
Order (list) --
The order of the field IDs that are configured as field options for a table visual.
(string) --
PinnedFieldOptions (dict) --
The settings for the pinned columns of a table visual.
PinnedLeftFields (list) --
A list of columns to be pinned to the left of a table visual.
(string) --
PaginatedReportOptions (dict) --
The paginated report options for a table visual.
VerticalOverflowVisibility (string) --
The visibility of printing table overflow across pages.
OverflowColumnHeaderVisibility (string) --
The visibility of repeating header rows on each page.
TableInlineVisualizations (list) --
A collection of inline visualizations to display within a chart.
(dict) --
The inline visualization of a specific type to display within a chart.
DataBars (dict) --
The configuration of the inline visualization of the data bars within a chart.
FieldId (string) -- [REQUIRED]
The field ID for the data bars options.
PositiveColor (string) --
The color of the positive data bar.
NegativeColor (string) --
The color of the negative data bar.
ConditionalFormatting (dict) --
The conditional formatting for a PivotTableVisual .
ConditionalFormattingOptions (list) --
Conditional formatting options for a PivotTableVisual .
(dict) --
Conditional formatting options for a PivotTableVisual .
Cell (dict) --
The cell conditional formatting option for a table.
FieldId (string) -- [REQUIRED]
The field ID of the cell for conditional formatting.
TextFormat (dict) --
The text format of the cell for conditional formatting.
BackgroundColor (dict) --
The conditional formatting for the text background color.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
TextColor (dict) --
The conditional formatting for the text color.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
Icon (dict) --
The conditional formatting for the icon.
IconSet (dict) --
Formatting configuration for icon set.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for the icon set.
IconSetType (string) --
Determines the icon set type.
CustomCondition (dict) --
Determines the custom condition for an icon set.
Expression (string) -- [REQUIRED]
The expression that determines the condition of the icon set.
IconOptions (dict) -- [REQUIRED]
Custom icon options for an icon set.
Icon (string) --
Determines the type of icon.
UnicodeIcon (string) --
Determines the Unicode icon type.
Color (string) --
Determines the color of the icon.
DisplayConfiguration (dict) --
Determines the icon display configuration.
IconDisplayOption (string) --
Determines the icon display configuration.
Row (dict) --
The row conditional formatting option for a table.
BackgroundColor (dict) --
The conditional formatting color (solid, gradient) of the background for a table row.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
TextColor (dict) --
The conditional formatting color (solid, gradient) of the text for a table row.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
PivotTableVisual (dict) --
A pivot table.
For more information, see Using pivot tables in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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..
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field wells of the visual.
PivotTableAggregatedFieldWells (dict) --
The aggregated field well for the pivot table.
Rows (list) --
The rows field well for a pivot table. Values are grouped by rows fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Columns (list) --
The columns field well for a pivot table. Values are grouped by columns fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The values field well for a pivot table. Values are aggregated based on rows and columns fields.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SortConfiguration (dict) --
The sort configuration for a PivotTableVisual .
FieldSortOptions (list) --
The field sort options for a pivot table sort configuration.
(dict) --
The field sort options for a pivot table sort configuration.
FieldId (string) -- [REQUIRED]
The field ID for the field sort options.
SortBy (dict) -- [REQUIRED]
The sort by field for the field sort options.
Field (dict) --
The field sort (field id, direction) for the pivot table sort by options.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
Column (dict) --
The column sort (field id, direction) for the pivot table sort by options.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
DataPath (dict) --
The data path sort (data path value, direction) for the pivot table sort by options.
Direction (string) -- [REQUIRED]
Determines the sort direction.
SortPaths (list) -- [REQUIRED]
The list of data paths that need to be sorted.
(dict) --
The data path that needs to be sorted.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
TableOptions (dict) --
The table options for a pivot table visual.
MetricPlacement (string) --
The metric placement (row, column) options.
SingleMetricVisibility (string) --
The visibility of the single metric options.
ColumnNamesVisibility (string) --
The visibility of the column names.
ToggleButtonsVisibility (string) --
Determines the visibility of the pivot table.
ColumnHeaderStyle (dict) --
The table cell style of the column header.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
RowHeaderStyle (dict) --
The table cell style of the row headers.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
CellStyle (dict) --
The table cell style of cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
RowFieldNamesStyle (dict) --
The table cell style of row field names.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
RowAlternateColorOptions (dict) --
The row alternate color options (widget status, row alternate colors).
Status (string) --
Determines the widget status.
RowAlternateColors (list) --
Determines the list of row alternate colors.
(string) --
UsePrimaryBackgroundColor (string) --
The primary background color options for alternate rows.
CollapsedRowDimensionsVisibility (string) --
The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN , all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE .
RowsLayout (string) --
The layout for the row dimension headers of a pivot table. Choose one of the following options.
TABULAR : (Default) Each row field is displayed in a separate column.
HIERARCHY : All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.
RowsLabelOptions (dict) --
The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY .
Visibility (string) --
The visibility of the rows label.
CustomLabel (string) --
The custom label string for the rows label.
DefaultCellWidth (string) --
The default cell width of the pivot table.
TotalOptions (dict) --
The total options for a pivot table visual.
RowSubtotalOptions (dict) --
The row subtotal options.
TotalsVisibility (string) --
The visibility configuration for the subtotal cells.
CustomLabel (string) --
The custom label string for the subtotal cells.
FieldLevel (string) --
The field level (all, custom, last) for the subtotal cells.
FieldLevelOptions (list) --
The optional configuration of subtotal cells.
(dict) --
The optional configuration of subtotals cells.
FieldId (string) --
The field ID of the subtotal options.
TotalCellStyle (dict) --
The cell styling options for the subtotal cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
ValueCellStyle (dict) --
The cell styling options for the subtotals of value cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
MetricHeaderCellStyle (dict) --
The cell styling options for the subtotals of header cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
StyleTargets (list) --
The style targets options for subtotals.
(dict) --
The table style target.
CellType (string) -- [REQUIRED]
The cell type of the table style target.
ColumnSubtotalOptions (dict) --
The column subtotal options.
TotalsVisibility (string) --
The visibility configuration for the subtotal cells.
CustomLabel (string) --
The custom label string for the subtotal cells.
FieldLevel (string) --
The field level (all, custom, last) for the subtotal cells.
FieldLevelOptions (list) --
The optional configuration of subtotal cells.
(dict) --
The optional configuration of subtotals cells.
FieldId (string) --
The field ID of the subtotal options.
TotalCellStyle (dict) --
The cell styling options for the subtotal cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
ValueCellStyle (dict) --
The cell styling options for the subtotals of value cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
MetricHeaderCellStyle (dict) --
The cell styling options for the subtotals of header cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
StyleTargets (list) --
The style targets options for subtotals.
(dict) --
The table style target.
CellType (string) -- [REQUIRED]
The cell type of the table style target.
RowTotalOptions (dict) --
The row total options.
TotalsVisibility (string) --
The visibility configuration for the total cells.
Placement (string) --
The placement (start, end) for the total cells.
ScrollStatus (string) --
The scroll status (pinned, scrolled) for the total cells.
CustomLabel (string) --
The custom label string for the total cells.
TotalCellStyle (dict) --
The cell styling options for the total cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
ValueCellStyle (dict) --
The cell styling options for the totals of value cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
MetricHeaderCellStyle (dict) --
The cell styling options for the total of header cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
TotalAggregationOptions (list) --
The total aggregation options for each value field.
(dict) --
The total aggregation settings map of a field id.
FieldId (string) -- [REQUIRED]
The field id that's associated with the total aggregation option.
TotalAggregationFunction (dict) -- [REQUIRED]
The total aggregation function that you want to set for a specified field id.
SimpleTotalAggregationFunction (string) --
A built in aggregation function for total values.
ColumnTotalOptions (dict) --
The column total options.
TotalsVisibility (string) --
The visibility configuration for the total cells.
Placement (string) --
The placement (start, end) for the total cells.
ScrollStatus (string) --
The scroll status (pinned, scrolled) for the total cells.
CustomLabel (string) --
The custom label string for the total cells.
TotalCellStyle (dict) --
The cell styling options for the total cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
ValueCellStyle (dict) --
The cell styling options for the totals of value cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
MetricHeaderCellStyle (dict) --
The cell styling options for the total of header cells.
Visibility (string) --
The visibility of the table cells.
FontConfiguration (dict) --
The font configuration of the table cells.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
TextWrap (string) --
The text wrap (none, wrap) for the table cells.
HorizontalTextAlignment (string) --
The horizontal text alignment (left, center, right, auto) for the table cells.
VerticalTextAlignment (string) --
The vertical text alignment (top, middle, bottom) for the table cells.
BackgroundColor (string) --
The background color for the table cells.
Height (integer) --
The height color for the table cells.
Border (dict) --
The borders for the table cells.
UniformBorder (dict) --
Determines the options for uniform border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
SideSpecificBorder (dict) --
Determines the options for side specific border.
InnerVertical (dict) --
The table border options of the inner vertical border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
InnerHorizontal (dict) --
The table border options of the inner horizontal border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Left (dict) --
The table border options of the left border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Right (dict) --
The table border options of the right border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Top (dict) --
The table border options of the top border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
Bottom (dict) --
The table border options of the bottom border.
Color (string) --
The color of a table border.
Thickness (integer) --
The thickness of a table border.
Style (string) --
The style (none, solid) of a table border.
TotalAggregationOptions (list) --
The total aggregation options for each value field.
(dict) --
The total aggregation settings map of a field id.
FieldId (string) -- [REQUIRED]
The field id that's associated with the total aggregation option.
TotalAggregationFunction (dict) -- [REQUIRED]
The total aggregation function that you want to set for a specified field id.
SimpleTotalAggregationFunction (string) --
A built in aggregation function for total values.
FieldOptions (dict) --
The field options for a pivot table visual.
SelectedFieldOptions (list) --
The selected field options for the pivot table field options.
(dict) --
The selected field options for the pivot table field options.
FieldId (string) -- [REQUIRED]
The field ID of the pivot table field.
CustomLabel (string) --
The custom label of the pivot table field.
Visibility (string) --
The visibility of the pivot table field.
DataPathOptions (list) --
The data path options for the pivot table field options.
(dict) --
The data path options for the pivot table field options.
DataPathList (list) -- [REQUIRED]
The list of data path values for the data path options.
(dict) --
The data path that needs to be sorted.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Width (string) --
The width of the data path option.
CollapseStateOptions (list) --
The collapse state options for the pivot table field options.
(dict) --
The collapse state options for the pivot table field options.
Target (dict) -- [REQUIRED]
A tagged-union object that sets the collapse state.
FieldId (string) --
The field ID of the pivot table that the collapse state needs to be set to.
FieldDataPathValues (list) --
The data path of the pivot table's header. Used to set the collapse state.
(dict) --
The data path that needs to be sorted.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
State (string) --
The state of the field target of a pivot table. Choose one of the following options:
COLLAPSED
EXPANDED
PaginatedReportOptions (dict) --
The paginated report options for a pivot table visual.
VerticalOverflowVisibility (string) --
The visibility of the printing table overflow across pages.
OverflowColumnHeaderVisibility (string) --
The visibility of the repeating header rows on each page.
ConditionalFormatting (dict) --
The conditional formatting for a PivotTableVisual .
ConditionalFormattingOptions (list) --
Conditional formatting options for a PivotTableVisual .
(dict) --
Conditional formatting options for a PivotTableVisual .
Cell (dict) --
The cell conditional formatting option for a pivot table.
FieldId (string) -- [REQUIRED]
The field ID of the cell for conditional formatting.
TextFormat (dict) --
The text format of the cell for conditional formatting.
BackgroundColor (dict) --
The conditional formatting for the text background color.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
TextColor (dict) --
The conditional formatting for the text color.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
Icon (dict) --
The conditional formatting for the icon.
IconSet (dict) --
Formatting configuration for icon set.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for the icon set.
IconSetType (string) --
Determines the icon set type.
CustomCondition (dict) --
Determines the custom condition for an icon set.
Expression (string) -- [REQUIRED]
The expression that determines the condition of the icon set.
IconOptions (dict) -- [REQUIRED]
Custom icon options for an icon set.
Icon (string) --
Determines the type of icon.
UnicodeIcon (string) --
Determines the Unicode icon type.
Color (string) --
Determines the color of the icon.
DisplayConfiguration (dict) --
Determines the icon display configuration.
IconDisplayOption (string) --
Determines the icon display configuration.
Scope (dict) --
The scope of the cell for conditional formatting.
Role (string) --
The role (field, field total, grand total) of the cell for conditional formatting.
Scopes (list) --
A list of cell scopes for conditional formatting.
(dict) --
The scope of the cell for conditional formatting.
Role (string) --
The role (field, field total, grand total) of the cell for conditional formatting.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
BarChartVisual (dict) --
A bar chart.
For more information, see Using bar charts in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field wells of the visual.
BarChartAggregatedFieldWells (dict) --
The aggregated field wells of a bar chart.
Category (list) --
The category (y-axis) field well of a bar chart.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The value field wells of a bar chart. Values are aggregated by category.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
Colors (list) --
The color (group/color) field well of a bar chart.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
SmallMultiples (list) --
The small multiples field well of a bar chart.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
SortConfiguration (dict) --
The sort configuration of a BarChartVisual .
CategorySort (list) --
The sort configuration of category fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
CategoryItemsLimit (dict) --
The limit on the number of categories displayed in a bar chart.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
ColorSort (list) --
The sort configuration of color fields in a bar chart.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
ColorItemsLimit (dict) --
The limit on the number of values displayed in a bar chart.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
SmallMultiplesSort (list) --
The sort configuration of the small multiples field.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
SmallMultiplesLimitConfiguration (dict) --
The limit on the number of small multiples panels that are displayed.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
Orientation (string) --
The orientation of the bars in a bar chart visual. There are two valid values in this structure:
HORIZONTAL : 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.
VERTICAL : 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.
BarsArrangement (string) --
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
VisualPalette (dict) --
The palette (chart color) display setup of the visual.
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
SmallMultiplesOptions (dict) --
The small multiples setup for the visual.
MaxVisibleRows (integer) --
Sets the maximum number of visible rows to display in the grid of small multiples panels.
The default value is Auto , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.
MaxVisibleColumns (integer) --
Sets the maximum number of visible columns to display in the grid of small multiples panels.
The default is Auto , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.
PanelConfiguration (dict) --
Configures the display options for each small multiples panel.
Title (dict) --
Configures the title display within each small multiples panel.
Visibility (string) --
Determines whether or not panel titles are displayed.
FontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
HorizontalTextAlignment (string) --
Sets the horizontal text alignment of the title within each panel.
BorderVisibility (string) --
Determines whether or not each panel displays a border.
BorderThickness (string) --
Sets the line thickness of panel borders.
BorderStyle (string) --
Sets the line style of panel borders.
BorderColor (string) --
Sets the line color of panel borders.
GutterVisibility (string) --
Determines whether or not negative space between sibling panels is rendered.
GutterSpacing (string) --
Sets the total amount of negative space to display between sibling panels.
BackgroundVisibility (string) --
Determines whether or not a background for each small multiples panel is rendered.
BackgroundColor (string) --
Sets the background color for each panel.
XAxis (dict) --
The properties of a small multiples X axis.
Scale (string) --
Determines whether scale of the axes are shared or independent. The default value is SHARED .
Placement (string) --
Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.
YAxis (dict) --
The properties of a small multiples Y axis.
Scale (string) --
Determines whether scale of the axes are shared or independent. The default value is SHARED .
Placement (string) --
Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.
CategoryAxis (dict) --
The label display options (grid line, range, scale, axis step) for bar chart category.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
CategoryLabelOptions (dict) --
The label options (label text, label visibility and sort icon visibility) for a bar chart.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ValueAxis (dict) --
The label display options (grid line, range, scale, axis step) for a bar chart value.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
ValueLabelOptions (dict) --
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColorLabelOptions (dict) --
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Legend (dict) --
The legend display setup of the visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
DataLabels (dict) --
The options that determine if visual data labels are displayed.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
Tooltip (dict) --
The tooltip display setup of the visual.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
ReferenceLines (list) --
The reference line setup of the visual.
(dict) --
The reference line visual display options.
Status (string) --
The status of the reference line. Choose one of the following options:
ENABLE
DISABLE
DataConfiguration (dict) -- [REQUIRED]
The data configuration of the reference line.
StaticConfiguration (dict) --
The static data configuration of the reference line data configuration.
Value (float) -- [REQUIRED]
The double input of the static data.
DynamicConfiguration (dict) --
The dynamic configuration of the reference line data configuration.
Column (dict) -- [REQUIRED]
The column that the dynamic data targets.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
MeasureAggregationFunction (dict) --
The aggregation function that is used in the dynamic data.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
Calculation (dict) -- [REQUIRED]
The calculation that is used in the dynamic data.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
AxisBinding (string) --
The axis binding type of the reference line. Choose one of the following options:
PrimaryY
SecondaryY
SeriesType (string) --
The series type of the reference line data configuration. Choose one of the following options:
BAR
LINE
StyleConfiguration (dict) --
The style configuration of the reference line.
Pattern (string) --
The pattern type of the line style. Choose one of the following options:
SOLID
DASHED
DOTTED
Color (string) --
The hex color of the reference line.
LabelConfiguration (dict) --
The label configuration of the reference line.
ValueLabelConfiguration (dict) --
The value label configuration of the label in a reference line.
RelativePosition (string) --
The relative position of the value label. Choose one of the following options:
BEFORE_CUSTOM_LABEL
AFTER_CUSTOM_LABEL
FormatConfiguration (dict) --
The format configuration of the value label.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CustomLabelConfiguration (dict) --
The custom label configuration of the label in a reference line.
CustomLabel (string) -- [REQUIRED]
The string text of the custom label.
FontConfiguration (dict) --
The font configuration of the label in a reference line.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontColor (string) --
The font color configuration of the label in a reference line.
HorizontalPosition (string) --
The horizontal position configuration of the label in a reference line. Choose one of the following options:
LEFT
CENTER
RIGHT
VerticalPosition (string) --
The vertical position configuration of the label in a reference line. Choose one of the following options:
ABOVE
BELOW
ContributionAnalysisDefaults (list) --
The contribution analysis (anomaly configuration) setup of the visual.
(dict) --
The contribution analysis visual display for a line, pie, or bar chart.
MeasureFieldId (string) -- [REQUIRED]
The measure field that is used in the contribution analysis.
ContributorDimensions (list) -- [REQUIRED]
The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
KPIVisual (dict) --
A key performance indicator (KPI).
For more information, see Using KPIs in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration of a KPI visual.
FieldWells (dict) --
The field well configuration of a KPI visual.
Values (list) --
The value field wells of a KPI visual.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
TargetValues (list) --
The target value field wells of a KPI visual.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
TrendGroups (list) --
The trend group field wells of a KPI visual.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
SortConfiguration (dict) --
The sort configuration of a KPI visual.
TrendGroupSort (list) --
The sort configuration of the trend group fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
KPIOptions (dict) --
The options that determine the presentation of a KPI visual.
ProgressBar (dict) --
The options that determine the presentation of the progress bar of a KPI visual.
Visibility (string) --
The visibility of the progress bar.
TrendArrows (dict) --
The options that determine the presentation of trend arrows in a KPI visual.
Visibility (string) --
The visibility of the trend arrows.
SecondaryValue (dict) --
The options that determine the presentation of the secondary value of a KPI visual.
Visibility (string) --
Determines the visibility of the secondary value.
Comparison (dict) --
The comparison configuration of a KPI visual.
ComparisonMethod (string) --
The method of the comparison. Choose from the following options:
DIFFERENCE
PERCENT_DIFFERENCE
PERCENT
ComparisonFormat (dict) --
The format of the comparison.
NumberDisplayFormatConfiguration (dict) --
The number display format.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The percentage display format.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PrimaryValueDisplayType (string) --
The options that determine the primary value display type.
PrimaryValueFontConfiguration (dict) --
The options that determine the primary value font configuration.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
SecondaryValueFontConfiguration (dict) --
The options that determine the secondary value font configuration.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
Sparkline (dict) --
The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
Visibility (string) --
The visibility of the sparkline.
Type (string) -- [REQUIRED]
The type of the sparkline.
Color (string) --
The color of the sparkline.
TooltipVisibility (string) --
The tooltip visibility of the sparkline.
VisualLayoutOptions (dict) --
The options that determine the layout a KPI visual.
StandardLayout (dict) --
The standard layout of the KPI visual.
Type (string) -- [REQUIRED]
The standard layout type.
ConditionalFormatting (dict) --
The conditional formatting of a KPI visual.
ConditionalFormattingOptions (list) --
The conditional formatting options of a KPI visual.
(dict) --
The conditional formatting options of a KPI visual.
PrimaryValue (dict) --
The conditional formatting for the primary value of a KPI visual.
TextColor (dict) --
The conditional formatting of the primary value's text color.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
Icon (dict) --
The conditional formatting of the primary value's icon.
IconSet (dict) --
Formatting configuration for icon set.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for the icon set.
IconSetType (string) --
Determines the icon set type.
CustomCondition (dict) --
Determines the custom condition for an icon set.
Expression (string) -- [REQUIRED]
The expression that determines the condition of the icon set.
IconOptions (dict) -- [REQUIRED]
Custom icon options for an icon set.
Icon (string) --
Determines the type of icon.
UnicodeIcon (string) --
Determines the Unicode icon type.
Color (string) --
Determines the color of the icon.
DisplayConfiguration (dict) --
Determines the icon display configuration.
IconDisplayOption (string) --
Determines the icon display configuration.
ProgressBar (dict) --
The conditional formatting for the progress bar of a KPI visual.
ForegroundColor (dict) --
The conditional formatting of the progress bar's foreground color.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
ActualValue (dict) --
The conditional formatting for the actual value of a KPI visual.
TextColor (dict) --
The conditional formatting of the actual value's text color.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
Icon (dict) --
The conditional formatting of the actual value's icon.
IconSet (dict) --
Formatting configuration for icon set.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for the icon set.
IconSetType (string) --
Determines the icon set type.
CustomCondition (dict) --
Determines the custom condition for an icon set.
Expression (string) -- [REQUIRED]
The expression that determines the condition of the icon set.
IconOptions (dict) -- [REQUIRED]
Custom icon options for an icon set.
Icon (string) --
Determines the type of icon.
UnicodeIcon (string) --
Determines the Unicode icon type.
Color (string) --
Determines the color of the icon.
DisplayConfiguration (dict) --
Determines the icon display configuration.
IconDisplayOption (string) --
Determines the icon display configuration.
ComparisonValue (dict) --
The conditional formatting for the comparison value of a KPI visual.
TextColor (dict) --
The conditional formatting of the comparison value's text color.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
Icon (dict) --
The conditional formatting of the comparison value's icon.
IconSet (dict) --
Formatting configuration for icon set.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for the icon set.
IconSetType (string) --
Determines the icon set type.
CustomCondition (dict) --
Determines the custom condition for an icon set.
Expression (string) -- [REQUIRED]
The expression that determines the condition of the icon set.
IconOptions (dict) -- [REQUIRED]
Custom icon options for an icon set.
Icon (string) --
Determines the type of icon.
UnicodeIcon (string) --
Determines the Unicode icon type.
Color (string) --
Determines the color of the icon.
DisplayConfiguration (dict) --
Determines the icon display configuration.
IconDisplayOption (string) --
Determines the icon display configuration.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PieChartVisual (dict) --
A pie or donut chart.
For more information, see Using pie charts in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration of a pie chart.
FieldWells (dict) --
The field wells of the visual.
PieChartAggregatedFieldWells (dict) --
The field well configuration of a pie chart.
Category (list) --
The category (group/color) field wells of a pie chart.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The value field wells of a pie chart. Values are aggregated based on categories.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SmallMultiples (list) --
The small multiples field well of a pie chart.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
SortConfiguration (dict) --
The sort configuration of a pie chart.
CategorySort (list) --
The sort configuration of the category fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
CategoryItemsLimit (dict) --
The limit on the number of categories that are displayed in a pie chart.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
SmallMultiplesSort (list) --
The sort configuration of the small multiples field.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
SmallMultiplesLimitConfiguration (dict) --
The limit on the number of small multiples panels that are displayed.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
DonutOptions (dict) --
The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.
ArcOptions (dict) --
The option for define the arc of the chart shape. Valid values are as follows:
WHOLE - A pie chart
SMALL - A small-sized donut chart
MEDIUM - A medium-sized donut chart
LARGE - A large-sized donut chart
ArcThickness (string) --
The arc thickness of a GaugeChartVisual .
DonutCenterOptions (dict) --
The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.
LabelVisibility (string) --
Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total' .
SmallMultiplesOptions (dict) --
The small multiples setup for the visual.
MaxVisibleRows (integer) --
Sets the maximum number of visible rows to display in the grid of small multiples panels.
The default value is Auto , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.
MaxVisibleColumns (integer) --
Sets the maximum number of visible columns to display in the grid of small multiples panels.
The default is Auto , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.
PanelConfiguration (dict) --
Configures the display options for each small multiples panel.
Title (dict) --
Configures the title display within each small multiples panel.
Visibility (string) --
Determines whether or not panel titles are displayed.
FontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
HorizontalTextAlignment (string) --
Sets the horizontal text alignment of the title within each panel.
BorderVisibility (string) --
Determines whether or not each panel displays a border.
BorderThickness (string) --
Sets the line thickness of panel borders.
BorderStyle (string) --
Sets the line style of panel borders.
BorderColor (string) --
Sets the line color of panel borders.
GutterVisibility (string) --
Determines whether or not negative space between sibling panels is rendered.
GutterSpacing (string) --
Sets the total amount of negative space to display between sibling panels.
BackgroundVisibility (string) --
Determines whether or not a background for each small multiples panel is rendered.
BackgroundColor (string) --
Sets the background color for each panel.
XAxis (dict) --
The properties of a small multiples X axis.
Scale (string) --
Determines whether scale of the axes are shared or independent. The default value is SHARED .
Placement (string) --
Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.
YAxis (dict) --
The properties of a small multiples Y axis.
Scale (string) --
Determines whether scale of the axes are shared or independent. The default value is SHARED .
Placement (string) --
Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.
CategoryLabelOptions (dict) --
The label options of the group/color that is displayed in a pie chart.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ValueLabelOptions (dict) --
The label options for the value that is displayed in a pie chart.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Legend (dict) --
The legend display setup of the visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
DataLabels (dict) --
The options that determine if visual data labels are displayed.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
Tooltip (dict) --
The tooltip display setup of the visual.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
VisualPalette (dict) --
The palette (chart color) display setup of the visual.
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
ContributionAnalysisDefaults (list) --
The contribution analysis (anomaly configuration) setup of the visual.
(dict) --
The contribution analysis visual display for a line, pie, or bar chart.
MeasureFieldId (string) -- [REQUIRED]
The measure field that is used in the contribution analysis.
ContributorDimensions (list) -- [REQUIRED]
The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
GaugeChartVisual (dict) --
A gauge chart.
For more information, see Using gauge charts in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration of a GaugeChartVisual .
FieldWells (dict) --
The field well configuration of a GaugeChartVisual .
Values (list) --
The value field wells of a GaugeChartVisual .
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
TargetValues (list) --
The target value field wells of a GaugeChartVisual .
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
GaugeChartOptions (dict) --
The options that determine the presentation of the GaugeChartVisual .
PrimaryValueDisplayType (string) --
The options that determine the primary value display type.
Comparison (dict) --
The comparison configuration of a GaugeChartVisual .
ComparisonMethod (string) --
The method of the comparison. Choose from the following options:
DIFFERENCE
PERCENT_DIFFERENCE
PERCENT
ComparisonFormat (dict) --
The format of the comparison.
NumberDisplayFormatConfiguration (dict) --
The number display format.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The percentage display format.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
ArcAxis (dict) --
The arc axis configuration of a GaugeChartVisual .
Range (dict) --
The arc axis range of a GaugeChartVisual .
Min (float) --
The minimum value of the arc axis range.
Max (float) --
The maximum value of the arc axis range.
ReserveRange (integer) --
The reserved range of the arc axis.
Arc (dict) --
The arc configuration of a GaugeChartVisual .
ArcAngle (float) --
The option that determines the arc angle of a GaugeChartVisual .
ArcThickness (string) --
The options that determine the arc thickness of a GaugeChartVisual .
PrimaryValueFontConfiguration (dict) --
The options that determine the primary value font configuration.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
DataLabels (dict) --
The data label configuration of a GaugeChartVisual .
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
TooltipOptions (dict) --
The tooltip configuration of a GaugeChartVisual .
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
VisualPalette (dict) --
The visual palette configuration of a GaugeChartVisual .
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
ConditionalFormatting (dict) --
The conditional formatting of a GaugeChartVisual .
ConditionalFormattingOptions (list) --
Conditional formatting options of a GaugeChartVisual .
(dict) --
Conditional formatting options of a GaugeChartVisual .
PrimaryValue (dict) --
The conditional formatting for the primary value of a GaugeChartVisual .
TextColor (dict) --
The conditional formatting of the primary value text color.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
Icon (dict) --
The conditional formatting of the primary value icon.
IconSet (dict) --
Formatting configuration for icon set.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for the icon set.
IconSetType (string) --
Determines the icon set type.
CustomCondition (dict) --
Determines the custom condition for an icon set.
Expression (string) -- [REQUIRED]
The expression that determines the condition of the icon set.
IconOptions (dict) -- [REQUIRED]
Custom icon options for an icon set.
Icon (string) --
Determines the type of icon.
UnicodeIcon (string) --
Determines the Unicode icon type.
Color (string) --
Determines the color of the icon.
DisplayConfiguration (dict) --
Determines the icon display configuration.
IconDisplayOption (string) --
Determines the icon display configuration.
Arc (dict) --
The options that determine the presentation of the arc of a GaugeChartVisual .
ForegroundColor (dict) --
The conditional formatting of the arc foreground color.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
LineChartVisual (dict) --
A line chart.
For more information, see Using line charts in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration of a line chart.
FieldWells (dict) --
The field well configuration of a line chart.
LineChartAggregatedFieldWells (dict) --
The field well configuration of a line chart.
Category (list) --
The category field wells of a line chart. Values are grouped by category fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The value field wells of a line chart. Values are aggregated based on categories.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
Colors (list) --
The color field wells of a line chart. Values are grouped by category fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
SmallMultiples (list) --
The small multiples field well of a line chart.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
SortConfiguration (dict) --
The sort configuration of a line chart.
CategorySort (list) --
The sort configuration of the category fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
CategoryItemsLimitConfiguration (dict) --
The limit on the number of categories that are displayed in a line chart.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
ColorItemsLimitConfiguration (dict) --
The limit on the number of lines that are displayed in a line chart.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
SmallMultiplesSort (list) --
The sort configuration of the small multiples field.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
SmallMultiplesLimitConfiguration (dict) --
The limit on the number of small multiples panels that are displayed.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
ForecastConfigurations (list) --
The forecast configuration of a line chart.
(dict) --
The forecast configuration that is used in a line chart's display properties.
ForecastProperties (dict) --
The forecast properties setup of a forecast in the line chart.
PeriodsForward (integer) --
The periods forward setup of a forecast computation.
PeriodsBackward (integer) --
The periods backward setup of a forecast computation.
UpperBoundary (float) --
The upper boundary setup of a forecast computation.
LowerBoundary (float) --
The lower boundary setup of a forecast computation.
PredictionInterval (integer) --
The prediction interval setup of a forecast computation.
Seasonality (integer) --
The seasonality setup of a forecast computation. Choose one of the following options:
NULL : The input is set to NULL .
NON_NULL : The input is set to a custom value.
Scenario (dict) --
The forecast scenario of a forecast in the line chart.
WhatIfPointScenario (dict) --
The what-if analysis forecast setup with the target date.
Date (datetime) -- [REQUIRED]
The date that you need the forecast results for.
Value (float) -- [REQUIRED]
The target value that you want to meet for the provided date.
WhatIfRangeScenario (dict) --
The what-if analysis forecast setup with the date range.
StartDate (datetime) -- [REQUIRED]
The start date in the date range that you need the forecast results for.
EndDate (datetime) -- [REQUIRED]
The end date in the date range that you need the forecast results for.
Value (float) -- [REQUIRED]
The target value that you want to meet for the provided date range.
Type (string) --
Determines the type of the line chart.
SmallMultiplesOptions (dict) --
The small multiples setup for the visual.
MaxVisibleRows (integer) --
Sets the maximum number of visible rows to display in the grid of small multiples panels.
The default value is Auto , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.
MaxVisibleColumns (integer) --
Sets the maximum number of visible columns to display in the grid of small multiples panels.
The default is Auto , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.
PanelConfiguration (dict) --
Configures the display options for each small multiples panel.
Title (dict) --
Configures the title display within each small multiples panel.
Visibility (string) --
Determines whether or not panel titles are displayed.
FontConfiguration (dict) --
Configures the display properties of the given text.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
HorizontalTextAlignment (string) --
Sets the horizontal text alignment of the title within each panel.
BorderVisibility (string) --
Determines whether or not each panel displays a border.
BorderThickness (string) --
Sets the line thickness of panel borders.
BorderStyle (string) --
Sets the line style of panel borders.
BorderColor (string) --
Sets the line color of panel borders.
GutterVisibility (string) --
Determines whether or not negative space between sibling panels is rendered.
GutterSpacing (string) --
Sets the total amount of negative space to display between sibling panels.
BackgroundVisibility (string) --
Determines whether or not a background for each small multiples panel is rendered.
BackgroundColor (string) --
Sets the background color for each panel.
XAxis (dict) --
The properties of a small multiples X axis.
Scale (string) --
Determines whether scale of the axes are shared or independent. The default value is SHARED .
Placement (string) --
Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.
YAxis (dict) --
The properties of a small multiples Y axis.
Scale (string) --
Determines whether scale of the axes are shared or independent. The default value is SHARED .
Placement (string) --
Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.
XAxisDisplayOptions (dict) --
The options that determine the presentation of the x-axis.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
XAxisLabelOptions (dict) --
The options that determine the presentation of the x-axis label.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
PrimaryYAxisDisplayOptions (dict) --
The series axis configuration of a line chart.
AxisOptions (dict) --
The options that determine the presentation of the line series axis.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
MissingDataConfigurations (list) --
The configuration options that determine how missing data is treated during the rendering of a line chart.
(dict) --
The configuration options that determine how missing data is treated during the rendering of a line chart.
TreatmentOption (string) --
The treatment option that determines how missing data should be rendered. Choose from the following options:
INTERPOLATE : Interpolate missing values between the prior and the next known value.
SHOW_AS_ZERO : Show missing values as the value 0 .
SHOW_AS_BLANK : Display a blank space when rendering missing data.
PrimaryYAxisLabelOptions (dict) --
The options that determine the presentation of the y-axis label.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
SecondaryYAxisDisplayOptions (dict) --
The series axis configuration of a line chart.
AxisOptions (dict) --
The options that determine the presentation of the line series axis.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
MissingDataConfigurations (list) --
The configuration options that determine how missing data is treated during the rendering of a line chart.
(dict) --
The configuration options that determine how missing data is treated during the rendering of a line chart.
TreatmentOption (string) --
The treatment option that determines how missing data should be rendered. Choose from the following options:
INTERPOLATE : Interpolate missing values between the prior and the next known value.
SHOW_AS_ZERO : Show missing values as the value 0 .
SHOW_AS_BLANK : Display a blank space when rendering missing data.
SecondaryYAxisLabelOptions (dict) --
The options that determine the presentation of the secondary y-axis label.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DefaultSeriesSettings (dict) --
The options that determine the default presentation of all line series in LineChartVisual .
AxisBinding (string) --
The axis to which you are binding all line series to.
LineStyleSettings (dict) --
Line styles options for all line series in the visual.
LineVisibility (string) --
Configuration option that determines whether to show the line for the series.
LineInterpolation (string) --
Interpolation style for line series.
LINEAR : Show as default, linear style.
SMOOTH : Show as a smooth curve.
STEPPED : Show steps in line.
LineStyle (string) --
Line style for line series.
SOLID : Show as a solid line.
DOTTED : Show as a dotted line.
DASHED : Show as a dashed line.
LineWidth (string) --
Width that determines the line thickness.
MarkerStyleSettings (dict) --
Marker styles options for all line series in the visual.
MarkerVisibility (string) --
Configuration option that determines whether to show the markers in the series.
MarkerShape (string) --
Shape option for markers in the series.
CIRCLE : Show marker as a circle.
TRIANGLE : Show marker as a triangle.
SQUARE : Show marker as a square.
DIAMOND : Show marker as a diamond.
ROUNDED_SQUARE : Show marker as a rounded square.
MarkerSize (string) --
Size of marker in the series.
MarkerColor (string) --
Color of marker in the series.
Series (list) --
The series item configuration of a line chart.
(dict) --
The series item configuration of a line chart.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldSeriesItem (dict) --
The field series item configuration of a line chart.
FieldId (string) -- [REQUIRED]
The field ID of the field for which you are setting the axis binding.
AxisBinding (string) -- [REQUIRED]
The axis that you are binding the field to.
Settings (dict) --
The options that determine the presentation of line series associated to the field.
LineStyleSettings (dict) --
Line styles options for a line series in LineChartVisual .
LineVisibility (string) --
Configuration option that determines whether to show the line for the series.
LineInterpolation (string) --
Interpolation style for line series.
LINEAR : Show as default, linear style.
SMOOTH : Show as a smooth curve.
STEPPED : Show steps in line.
LineStyle (string) --
Line style for line series.
SOLID : Show as a solid line.
DOTTED : Show as a dotted line.
DASHED : Show as a dashed line.
LineWidth (string) --
Width that determines the line thickness.
MarkerStyleSettings (dict) --
Marker styles options for a line series in LineChartVisual .
MarkerVisibility (string) --
Configuration option that determines whether to show the markers in the series.
MarkerShape (string) --
Shape option for markers in the series.
CIRCLE : Show marker as a circle.
TRIANGLE : Show marker as a triangle.
SQUARE : Show marker as a square.
DIAMOND : Show marker as a diamond.
ROUNDED_SQUARE : Show marker as a rounded square.
MarkerSize (string) --
Size of marker in the series.
MarkerColor (string) --
Color of marker in the series.
DataFieldSeriesItem (dict) --
The data field series item configuration of a line chart.
FieldId (string) -- [REQUIRED]
The field ID of the field that you are setting the axis binding to.
FieldValue (string) --
The field value of the field that you are setting the axis binding to.
AxisBinding (string) -- [REQUIRED]
The axis that you are binding the field to.
Settings (dict) --
The options that determine the presentation of line series associated to the field.
LineStyleSettings (dict) --
Line styles options for a line series in LineChartVisual .
LineVisibility (string) --
Configuration option that determines whether to show the line for the series.
LineInterpolation (string) --
Interpolation style for line series.
LINEAR : Show as default, linear style.
SMOOTH : Show as a smooth curve.
STEPPED : Show steps in line.
LineStyle (string) --
Line style for line series.
SOLID : Show as a solid line.
DOTTED : Show as a dotted line.
DASHED : Show as a dashed line.
LineWidth (string) --
Width that determines the line thickness.
MarkerStyleSettings (dict) --
Marker styles options for a line series in LineChartVisual .
MarkerVisibility (string) --
Configuration option that determines whether to show the markers in the series.
MarkerShape (string) --
Shape option for markers in the series.
CIRCLE : Show marker as a circle.
TRIANGLE : Show marker as a triangle.
SQUARE : Show marker as a square.
DIAMOND : Show marker as a diamond.
ROUNDED_SQUARE : Show marker as a rounded square.
MarkerSize (string) --
Size of marker in the series.
MarkerColor (string) --
Color of marker in the series.
Legend (dict) --
The legend configuration of a line chart.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
DataLabels (dict) --
The data label configuration of a line chart.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
ReferenceLines (list) --
The reference lines configuration of a line chart.
(dict) --
The reference line visual display options.
Status (string) --
The status of the reference line. Choose one of the following options:
ENABLE
DISABLE
DataConfiguration (dict) -- [REQUIRED]
The data configuration of the reference line.
StaticConfiguration (dict) --
The static data configuration of the reference line data configuration.
Value (float) -- [REQUIRED]
The double input of the static data.
DynamicConfiguration (dict) --
The dynamic configuration of the reference line data configuration.
Column (dict) -- [REQUIRED]
The column that the dynamic data targets.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
MeasureAggregationFunction (dict) --
The aggregation function that is used in the dynamic data.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
Calculation (dict) -- [REQUIRED]
The calculation that is used in the dynamic data.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
AxisBinding (string) --
The axis binding type of the reference line. Choose one of the following options:
PrimaryY
SecondaryY
SeriesType (string) --
The series type of the reference line data configuration. Choose one of the following options:
BAR
LINE
StyleConfiguration (dict) --
The style configuration of the reference line.
Pattern (string) --
The pattern type of the line style. Choose one of the following options:
SOLID
DASHED
DOTTED
Color (string) --
The hex color of the reference line.
LabelConfiguration (dict) --
The label configuration of the reference line.
ValueLabelConfiguration (dict) --
The value label configuration of the label in a reference line.
RelativePosition (string) --
The relative position of the value label. Choose one of the following options:
BEFORE_CUSTOM_LABEL
AFTER_CUSTOM_LABEL
FormatConfiguration (dict) --
The format configuration of the value label.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CustomLabelConfiguration (dict) --
The custom label configuration of the label in a reference line.
CustomLabel (string) -- [REQUIRED]
The string text of the custom label.
FontConfiguration (dict) --
The font configuration of the label in a reference line.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontColor (string) --
The font color configuration of the label in a reference line.
HorizontalPosition (string) --
The horizontal position configuration of the label in a reference line. Choose one of the following options:
LEFT
CENTER
RIGHT
VerticalPosition (string) --
The vertical position configuration of the label in a reference line. Choose one of the following options:
ABOVE
BELOW
Tooltip (dict) --
The tooltip configuration of a line chart.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
ContributionAnalysisDefaults (list) --
The default configuration of a line chart's contribution analysis.
(dict) --
The contribution analysis visual display for a line, pie, or bar chart.
MeasureFieldId (string) -- [REQUIRED]
The measure field that is used in the contribution analysis.
ContributorDimensions (list) -- [REQUIRED]
The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
VisualPalette (dict) --
The visual palette configuration of a line chart.
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
HeatMapVisual (dict) --
A heat map.
For more information, see Using heat maps in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration of a heat map.
FieldWells (dict) --
The field wells of the visual.
HeatMapAggregatedFieldWells (dict) --
The aggregated field wells of a heat map.
Rows (list) --
The rows field well of a heat map.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Columns (list) --
The columns field well of a heat map.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The values field well of a heat map.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SortConfiguration (dict) --
The sort configuration of a heat map.
HeatMapRowSort (list) --
The field sort configuration of the rows fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
HeatMapColumnSort (list) --
The column sort configuration for heat map for columns that aren't a part of a field well.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
HeatMapRowItemsLimitConfiguration (dict) --
The limit on the number of rows that are displayed in a heat map.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
HeatMapColumnItemsLimitConfiguration (dict) --
The limit on the number of columns that are displayed in a heat map.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
RowLabelOptions (dict) --
The label options of the row that is displayed in a heat map .
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnLabelOptions (dict) --
The label options of the column that is displayed in a heat map.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColorScale (dict) --
The color options (gradient color, point of divergence) in a heat map.
Colors (list) -- [REQUIRED]
Determines the list of colors that are applied to the visual.
(dict) --
Determines the color that is applied to a particular data value.
Color (string) --
The color that is applied to the data value.
DataValue (float) --
The data value that the color is applied to.
ColorFillType (string) -- [REQUIRED]
Determines the color fill type.
NullValueColor (dict) --
Determines the color that is applied to null values.
Color (string) --
The color that is applied to the data value.
DataValue (float) --
The data value that the color is applied to.
Legend (dict) --
The legend display setup of the visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
DataLabels (dict) --
The options that determine if visual data labels are displayed.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
Tooltip (dict) --
The tooltip display setup of the visual.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TreeMapVisual (dict) --
A tree map.
For more information, see Using tree maps in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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..
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field wells of the visual.
TreeMapAggregatedFieldWells (dict) --
The aggregated field wells of a tree map.
Groups (list) --
The group by field well of a tree map. Values are grouped based on group by fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Sizes (list) --
The size field well of a tree map. Values are aggregated based on group by fields.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
Colors (list) --
The color field well of a tree map. Values are grouped by aggregations based on group by fields.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SortConfiguration (dict) --
The sort configuration of a tree map.
TreeMapSort (list) --
The sort configuration of group by fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
TreeMapGroupItemsLimitConfiguration (dict) --
The limit on the number of groups that are displayed.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
GroupLabelOptions (dict) --
The label options (label text, label visibility) of the groups that are displayed in a tree map.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
SizeLabelOptions (dict) --
The label options (label text, label visibility) of the sizes that are displayed in a tree map.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColorLabelOptions (dict) --
The label options (label text, label visibility) for the colors displayed in a tree map.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColorScale (dict) --
The color options (gradient color, point of divergence) of a tree map.
Colors (list) -- [REQUIRED]
Determines the list of colors that are applied to the visual.
(dict) --
Determines the color that is applied to a particular data value.
Color (string) --
The color that is applied to the data value.
DataValue (float) --
The data value that the color is applied to.
ColorFillType (string) -- [REQUIRED]
Determines the color fill type.
NullValueColor (dict) --
Determines the color that is applied to null values.
Color (string) --
The color that is applied to the data value.
DataValue (float) --
The data value that the color is applied to.
Legend (dict) --
The legend display setup of the visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
DataLabels (dict) --
The options that determine if visual data labels are displayed.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
Tooltip (dict) --
The tooltip display setup of the visual.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
GeospatialMapVisual (dict) --
A geospatial map or a points on map visual.
For more information, see Creating point maps in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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..
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field wells of the visual.
GeospatialMapAggregatedFieldWells (dict) --
The aggregated field well for a geospatial map.
Geospatial (list) --
The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The size field wells of a geospatial map. Values are aggregated based on geospatial fields.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
Colors (list) --
The color field wells of a geospatial map.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Legend (dict) --
The legend display setup of the visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
Tooltip (dict) --
The tooltip display setup of the visual.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
WindowOptions (dict) --
The window options of the geospatial map.
Bounds (dict) --
The bounds options (north, south, west, east) of the geospatial window options.
North (float) -- [REQUIRED]
The latitude of the north bound of the geospatial coordinate bounds.
South (float) -- [REQUIRED]
The latitude of the south bound of the geospatial coordinate bounds.
West (float) -- [REQUIRED]
The longitude of the west bound of the geospatial coordinate bounds.
East (float) -- [REQUIRED]
The longitude of the east bound of the geospatial coordinate bounds.
MapZoomMode (string) --
The map zoom modes (manual, auto) of the geospatial window options.
MapStyleOptions (dict) --
The map style options of the geospatial map.
BaseMapStyle (string) --
The base map style of the geospatial map.
PointStyleOptions (dict) --
The point style options of the geospatial map.
SelectedPointStyle (string) --
The selected point styles (point, cluster) of the geospatial map.
ClusterMarkerConfiguration (dict) --
The cluster marker configuration of the geospatial point style.
ClusterMarker (dict) --
The cluster marker that is a part of the cluster marker configuration.
SimpleClusterMarker (dict) --
The simple cluster marker of the cluster marker.
Color (string) --
The color of the simple cluster marker.
HeatmapConfiguration (dict) --
The heatmap configuration of the geospatial point style.
HeatmapColor (dict) --
The color scale specification for the heatmap point style.
Colors (list) --
The list of colors to be used in heatmap point style.
(dict) --
The color to be used in the heatmap point style.
Color (string) -- [REQUIRED]
The hex color to be used in the heatmap point style.
VisualPalette (dict) --
The visual display options for the visual palette.
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
FilledMapVisual (dict) --
A filled map.
For more information, see Creating filled maps in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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..
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field wells of the visual.
FilledMapAggregatedFieldWells (dict) --
The aggregated field well of the filled map.
Geospatial (list) --
The aggregated location field well of the filled map. Values are grouped by location fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The aggregated color field well of a filled map. Values are aggregated based on location fields.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SortConfiguration (dict) --
The sort configuration of a FilledMapVisual .
CategorySort (list) --
The sort configuration of the location fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
Legend (dict) --
The legend display setup of the visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
Tooltip (dict) --
The tooltip display setup of the visual.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
WindowOptions (dict) --
The window options of the filled map visual.
Bounds (dict) --
The bounds options (north, south, west, east) of the geospatial window options.
North (float) -- [REQUIRED]
The latitude of the north bound of the geospatial coordinate bounds.
South (float) -- [REQUIRED]
The latitude of the south bound of the geospatial coordinate bounds.
West (float) -- [REQUIRED]
The longitude of the west bound of the geospatial coordinate bounds.
East (float) -- [REQUIRED]
The longitude of the east bound of the geospatial coordinate bounds.
MapZoomMode (string) --
The map zoom modes (manual, auto) of the geospatial window options.
MapStyleOptions (dict) --
The map style options of the filled map visual.
BaseMapStyle (string) --
The base map style of the geospatial map.
ConditionalFormatting (dict) --
The conditional formatting of a FilledMapVisual .
ConditionalFormattingOptions (list) -- [REQUIRED]
Conditional formatting options of a FilledMapVisual .
(dict) --
Conditional formatting options of a FilledMapVisual .
Shape (dict) -- [REQUIRED]
The conditional formatting that determines the shape of the filled map.
FieldId (string) -- [REQUIRED]
The field ID of the filled map shape.
Format (dict) --
The conditional formatting that determines the background color of a filled map's shape.
BackgroundColor (dict) -- [REQUIRED]
The conditional formatting for the shape background color of a filled map visual.
Solid (dict) --
Formatting configuration for solid color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for solid color.
Color (string) --
Determines the color.
Gradient (dict) --
Formatting configuration for gradient color.
Expression (string) -- [REQUIRED]
The expression that determines the formatting configuration for gradient color.
Color (dict) -- [REQUIRED]
Determines the color.
Stops (list) --
The list of gradient color stops.
(dict) --
Determines the gradient stop configuration.
GradientOffset (float) -- [REQUIRED]
Determines gradient offset value.
DataValue (float) --
Determines the data value.
Color (string) --
Determines the color.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
FunnelChartVisual (dict) --
A funnel chart.
For more information, see Using funnel charts in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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..
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration of a FunnelChartVisual .
FieldWells (dict) --
The field well configuration of a FunnelChartVisual .
FunnelChartAggregatedFieldWells (dict) --
The field well configuration of a FunnelChartVisual .
Category (list) --
The category field wells of a funnel chart. Values are grouped by category fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The value field wells of a funnel chart. Values are aggregated based on categories.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SortConfiguration (dict) --
The sort configuration of a FunnelChartVisual .
CategorySort (list) --
The sort configuration of the category fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
CategoryItemsLimit (dict) --
The limit on the number of categories displayed.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
CategoryLabelOptions (dict) --
The label options of the categories that are displayed in a FunnelChartVisual .
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ValueLabelOptions (dict) --
The label options for the values that are displayed in a FunnelChartVisual .
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Tooltip (dict) --
The tooltip configuration of a FunnelChartVisual .
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
DataLabelOptions (dict) --
The options that determine the presentation of the data labels.
Visibility (string) --
The visibility option that determines if data labels are displayed.
CategoryLabelVisibility (string) --
The visibility of the category labels within the data labels.
MeasureLabelVisibility (string) --
The visibility of the measure labels within the data labels.
Position (string) --
Determines the positioning of the data label relative to a section of the funnel.
LabelFontConfiguration (dict) --
The font configuration for the data labels.
Only the FontSize attribute of the font configuration is used for data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
The color of the data label text.
MeasureDataLabelStyle (string) --
Determines the style of the metric labels.
VisualPalette (dict) --
The visual palette configuration of a FunnelChartVisual .
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
ScatterPlotVisual (dict) --
A scatter plot.
For more information, see Using scatter plots in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field wells of the visual.
ScatterPlotCategoricallyAggregatedFieldWells (dict) --
The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.
XAxis (list) --
The x-axis field well of a scatter plot.
The x-axis is aggregated by category.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
YAxis (list) --
The y-axis field well of a scatter plot.
The y-axis is aggregated by category.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
Category (list) --
The category field well of a scatter plot.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Size (list) --
The size field well of a scatter plot.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
Label (list) --
The label field well of a scatter plot.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
ScatterPlotUnaggregatedFieldWells (dict) --
The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are unaggregated.
XAxis (list) --
The x-axis field well of a scatter plot.
The x-axis is a dimension field and cannot be aggregated.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
YAxis (list) --
The y-axis field well of a scatter plot.
The y-axis is a dimension field and cannot be aggregated.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Size (list) --
The size field well of a scatter plot.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
Category (list) --
The category field well of a scatter plot.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Label (list) --
The label field well of a scatter plot.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
XAxisLabelOptions (dict) --
The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
XAxisDisplayOptions (dict) --
The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
YAxisLabelOptions (dict) --
The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
YAxisDisplayOptions (dict) --
The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
Legend (dict) --
The legend display setup of the visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
DataLabels (dict) --
The options that determine if visual data labels are displayed.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
Tooltip (dict) --
The legend display setup of the visual.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
VisualPalette (dict) --
The palette (chart color) display setup of the visual.
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
ComboChartVisual (dict) --
A combo chart.
For more information, see Using combo charts in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field wells of the visual.
ComboChartAggregatedFieldWells (dict) --
The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.
Category (list) --
The aggregated category field wells of a combo chart.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
BarValues (list) --
The aggregated BarValues field well of a combo chart.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
Colors (list) --
The aggregated colors field well of a combo chart.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
LineValues (list) --
The aggregated LineValues field well of a combo chart.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SortConfiguration (dict) --
The sort configuration of a ComboChartVisual .
CategorySort (list) --
The sort configuration of the category field well in a combo chart.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
CategoryItemsLimit (dict) --
The item limit configuration for the category field well of a combo chart.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
ColorSort (list) --
The sort configuration of the color field well in a combo chart.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
ColorItemsLimit (dict) --
The item limit configuration of the color field well in a combo chart.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
BarsArrangement (string) --
Determines the bar arrangement in a combo chart. The following are valid values in this structure:
CLUSTERED : For clustered bar combo charts.
STACKED : For stacked bar combo charts.
STACKED_PERCENT : Do not use. If you use this value, the operation returns a validation error.
CategoryAxis (dict) --
The category axis of a combo chart.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
CategoryLabelOptions (dict) --
The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
PrimaryYAxisDisplayOptions (dict) --
The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
PrimaryYAxisLabelOptions (dict) --
The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
SecondaryYAxisDisplayOptions (dict) --
The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
SecondaryYAxisLabelOptions (dict) --
The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColorLabelOptions (dict) --
The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Legend (dict) --
The legend display setup of the visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
BarDataLabels (dict) --
The options that determine if visual data labels are displayed.
The data label options for a bar in a combo chart.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
LineDataLabels (dict) --
The options that determine if visual data labels are displayed.
The data label options for a line in a combo chart.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
Tooltip (dict) --
The legend display setup of the visual.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
ReferenceLines (list) --
The reference line setup of the visual.
(dict) --
The reference line visual display options.
Status (string) --
The status of the reference line. Choose one of the following options:
ENABLE
DISABLE
DataConfiguration (dict) -- [REQUIRED]
The data configuration of the reference line.
StaticConfiguration (dict) --
The static data configuration of the reference line data configuration.
Value (float) -- [REQUIRED]
The double input of the static data.
DynamicConfiguration (dict) --
The dynamic configuration of the reference line data configuration.
Column (dict) -- [REQUIRED]
The column that the dynamic data targets.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
MeasureAggregationFunction (dict) --
The aggregation function that is used in the dynamic data.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
Calculation (dict) -- [REQUIRED]
The calculation that is used in the dynamic data.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
AxisBinding (string) --
The axis binding type of the reference line. Choose one of the following options:
PrimaryY
SecondaryY
SeriesType (string) --
The series type of the reference line data configuration. Choose one of the following options:
BAR
LINE
StyleConfiguration (dict) --
The style configuration of the reference line.
Pattern (string) --
The pattern type of the line style. Choose one of the following options:
SOLID
DASHED
DOTTED
Color (string) --
The hex color of the reference line.
LabelConfiguration (dict) --
The label configuration of the reference line.
ValueLabelConfiguration (dict) --
The value label configuration of the label in a reference line.
RelativePosition (string) --
The relative position of the value label. Choose one of the following options:
BEFORE_CUSTOM_LABEL
AFTER_CUSTOM_LABEL
FormatConfiguration (dict) --
The format configuration of the value label.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CustomLabelConfiguration (dict) --
The custom label configuration of the label in a reference line.
CustomLabel (string) -- [REQUIRED]
The string text of the custom label.
FontConfiguration (dict) --
The font configuration of the label in a reference line.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontColor (string) --
The font color configuration of the label in a reference line.
HorizontalPosition (string) --
The horizontal position configuration of the label in a reference line. Choose one of the following options:
LEFT
CENTER
RIGHT
VerticalPosition (string) --
The vertical position configuration of the label in a reference line. Choose one of the following options:
ABOVE
BELOW
VisualPalette (dict) --
The palette (chart color) display setup of the visual.
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
BoxPlotVisual (dict) --
A box plot.
For more information, see Using box plots in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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..
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field wells of the visual.
BoxPlotAggregatedFieldWells (dict) --
The aggregated field wells of a box plot.
GroupBy (list) --
The group by field well of a box plot chart. Values are grouped based on group by fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The value field well of a box plot chart. Values are aggregated based on group by fields.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SortConfiguration (dict) --
The sort configuration of a BoxPlotVisual .
CategorySort (list) --
The sort configuration of a group by fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
PaginationConfiguration (dict) --
The pagination configuration of a table visual or box plot.
PageSize (integer) -- [REQUIRED]
Indicates how many items render in one page.
PageNumber (integer) -- [REQUIRED]
Indicates the page number.
BoxPlotOptions (dict) --
The box plot chart options for a box plot visual
StyleOptions (dict) --
The style options of the box plot.
FillStyle (string) --
The fill styles (solid, transparent) of the box plot.
OutlierVisibility (string) --
Determines the visibility of the outlier in a box plot.
AllDataPointsVisibility (string) --
Determines the visibility of all data points of the box plot.
CategoryAxis (dict) --
The label display options (grid line, range, scale, axis step) of a box plot category.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
CategoryLabelOptions (dict) --
The label options (label text, label visibility and sort Icon visibility) of a box plot category.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
PrimaryYAxisDisplayOptions (dict) --
The label display options (grid line, range, scale, axis step) of a box plot category.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
PrimaryYAxisLabelOptions (dict) --
The label options (label text, label visibility and sort icon visibility) of a box plot value.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Legend (dict) --
The options for the legend setup of a visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
Tooltip (dict) --
The tooltip display setup of the visual.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
ReferenceLines (list) --
The reference line setup of the visual.
(dict) --
The reference line visual display options.
Status (string) --
The status of the reference line. Choose one of the following options:
ENABLE
DISABLE
DataConfiguration (dict) -- [REQUIRED]
The data configuration of the reference line.
StaticConfiguration (dict) --
The static data configuration of the reference line data configuration.
Value (float) -- [REQUIRED]
The double input of the static data.
DynamicConfiguration (dict) --
The dynamic configuration of the reference line data configuration.
Column (dict) -- [REQUIRED]
The column that the dynamic data targets.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
MeasureAggregationFunction (dict) --
The aggregation function that is used in the dynamic data.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
Calculation (dict) -- [REQUIRED]
The calculation that is used in the dynamic data.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
AxisBinding (string) --
The axis binding type of the reference line. Choose one of the following options:
PrimaryY
SecondaryY
SeriesType (string) --
The series type of the reference line data configuration. Choose one of the following options:
BAR
LINE
StyleConfiguration (dict) --
The style configuration of the reference line.
Pattern (string) --
The pattern type of the line style. Choose one of the following options:
SOLID
DASHED
DOTTED
Color (string) --
The hex color of the reference line.
LabelConfiguration (dict) --
The label configuration of the reference line.
ValueLabelConfiguration (dict) --
The value label configuration of the label in a reference line.
RelativePosition (string) --
The relative position of the value label. Choose one of the following options:
BEFORE_CUSTOM_LABEL
AFTER_CUSTOM_LABEL
FormatConfiguration (dict) --
The format configuration of the value label.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CustomLabelConfiguration (dict) --
The custom label configuration of the label in a reference line.
CustomLabel (string) -- [REQUIRED]
The string text of the custom label.
FontConfiguration (dict) --
The font configuration of the label in a reference line.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
FontColor (string) --
The font color configuration of the label in a reference line.
HorizontalPosition (string) --
The horizontal position configuration of the label in a reference line. Choose one of the following options:
LEFT
CENTER
RIGHT
VerticalPosition (string) --
The vertical position configuration of the label in a reference line. Choose one of the following options:
ABOVE
BELOW
VisualPalette (dict) --
The palette (chart color) display setup of the visual.
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
WaterfallVisual (dict) --
A waterfall chart.
For more information, see Using waterfall charts in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration for a waterfall visual.
FieldWells (dict) --
The field well configuration of a waterfall visual.
WaterfallChartAggregatedFieldWells (dict) --
The field well configuration of a waterfall visual.
Categories (list) --
The category field wells of a waterfall visual.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The value field wells of a waterfall visual.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
Breakdowns (list) --
The breakdown field wells of a waterfall visual.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
SortConfiguration (dict) --
The sort configuration of a waterfall visual.
CategorySort (list) --
The sort configuration of the category fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
BreakdownItemsLimit (dict) --
The limit on the number of bar groups that are displayed.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
WaterfallChartOptions (dict) --
The options that determine the presentation of a waterfall visual.
TotalBarLabel (string) --
This option determines the total bar label of a waterfall visual.
CategoryAxisLabelOptions (dict) --
The options that determine the presentation of the category axis label.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryAxisDisplayOptions (dict) --
The options that determine the presentation of the category axis.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
PrimaryYAxisLabelOptions (dict) --
The options that determine the presentation of the y-axis label.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
PrimaryYAxisDisplayOptions (dict) --
The options that determine the presentation of the y-axis.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
Legend (dict) --
The legend configuration of a waterfall visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
DataLabels (dict) --
The data label configuration of a waterfall visual.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
VisualPalette (dict) --
The visual palette configuration of a waterfall visual.
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
HistogramVisual (dict) --
A histogram.
For more information, see Using histograms in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration for a HistogramVisual .
FieldWells (dict) --
The field well configuration of a histogram.
HistogramAggregatedFieldWells (dict) --
The field well configuration of a histogram.
Values (list) --
The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT .
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
XAxisDisplayOptions (dict) --
The options that determine the presentation of the x-axis.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
XAxisLabelOptions (dict) --
The options that determine the presentation of the x-axis label.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
YAxisDisplayOptions (dict) --
The options that determine the presentation of the y-axis.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
BinOptions (dict) --
The options that determine the presentation of histogram bins.
SelectedBinType (string) --
The options that determine the selected bin type.
BinCount (dict) --
The options that determine the bin count of a histogram.
Value (integer) --
The options that determine the bin count value.
BinWidth (dict) --
The options that determine the bin width of a histogram.
Value (float) --
The options that determine the bin width value.
BinCountLimit (integer) --
The options that determine the bin count limit.
StartValue (float) --
The options that determine the bin start value.
DataLabels (dict) --
The data label configuration of a histogram.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
Tooltip (dict) --
The tooltip configuration of a histogram.
TooltipVisibility (string) --
Determines whether or not the tooltip is visible.
SelectedTooltipType (string) --
The selected type for the tooltip. Choose one of the following options:
BASIC : A basic tooltip.
DETAILED : A detailed tooltip.
FieldBasedTooltip (dict) --
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility (string) --
The visibility of Show aggregations .
TooltipTitleType (string) --
The type for the >tooltip title. Choose one of the following options:
NONE : Doesn't use the primary value as the title.
PRIMARY_VALUE : Uses primary value as the title.
TooltipFields (list) --
The fields configuration in the tooltip.
(dict) --
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem (dict) --
The tooltip item for the fields.
FieldId (string) -- [REQUIRED]
The unique ID of the field that is targeted by the tooltip.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
ColumnTooltipItem (dict) --
The tooltip item for the columns that are not part of a field well.
Column (dict) -- [REQUIRED]
The target column of the tooltip item.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Label (string) --
The label of the tooltip item.
Visibility (string) --
The visibility of the tooltip item.
Aggregation (dict) --
The aggregation function of the column tooltip item.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
VisualPalette (dict) --
The visual palette configuration of a histogram.
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
WordCloudVisual (dict) --
A word cloud.
For more information, see Using word clouds in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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..
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field wells of the visual.
WordCloudAggregatedFieldWells (dict) --
The aggregated field wells of a word cloud.
GroupBy (list) --
The group by field well of a word cloud. Values are grouped by group by fields.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Size (list) --
The size field well of a word cloud. Values are aggregated based on group by fields.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SortConfiguration (dict) --
The sort configuration of a word cloud visual.
CategoryItemsLimit (dict) --
The limit on the number of groups that are displayed in a word cloud.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
CategorySort (list) --
The sort configuration of group by fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
CategoryLabelOptions (dict) --
The label options (label text, label visibility, and sort icon visibility) for the word cloud category.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
WordCloudOptions (dict) --
The options for a word cloud visual.
WordOrientation (string) --
The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
WordScaling (string) --
The word scaling options (emphasize, normal) for the words in a word cloud.
CloudLayout (string) --
The cloud layout options (fluid, normal) of a word cloud.
WordCasing (string) --
The word casing options (lower_case, existing_case) for the words in a word cloud.
WordPadding (string) --
The word padding options (none, small, medium, large) for the words in a word cloud.
MaximumStringLength (integer) --
The length limit of each word from 1-100.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
InsightVisual (dict) --
An insight visual.
For more information, see Working with insights in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
InsightConfiguration (dict) --
The configuration of an insight visual.
Computations (list) --
The computations configurations of the insight visual
(dict) --
The computation union that is used in an insight visual.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
TopBottomRanked (dict) --
The top ranked and bottom ranked computation configuration.
ComputationId (string) -- [REQUIRED]
The ID for a computation.
Name (string) --
The name of a computation.
Category (dict) --
The category field that is used in a computation.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Value (dict) --
The value field that is used in a computation.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
ResultSize (integer) --
The result size of a top and bottom ranked computation.
Type (string) -- [REQUIRED]
The computation type. Choose one of the following options:
TOP: A top ranked computation.
BOTTOM: A bottom ranked computation.
TopBottomMovers (dict) --
The top movers and bottom movers computation configuration.
ComputationId (string) -- [REQUIRED]
The ID for a computation.
Name (string) --
The name of a computation.
Time (dict) --
The time field that is used in a computation.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Category (dict) --
The category field that is used in a computation.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Value (dict) --
The value field that is used in a computation.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
MoverSize (integer) --
The mover size setup of the top and bottom movers computation.
SortOrder (string) --
The sort order setup of the top and bottom movers computation.
Type (string) -- [REQUIRED]
The computation type. Choose from the following options:
TOP: Top movers computation.
BOTTOM: Bottom movers computation.
TotalAggregation (dict) --
The total aggregation computation configuration.
ComputationId (string) -- [REQUIRED]
The ID for a computation.
Name (string) --
The name of a computation.
Value (dict) --
The value field that is used in a computation.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
MaximumMinimum (dict) --
The maximum and minimum computation configuration.
ComputationId (string) -- [REQUIRED]
The ID for a computation.
Name (string) --
The name of a computation.
Time (dict) --
The time field that is used in a computation.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Value (dict) --
The value field that is used in a computation.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
Type (string) -- [REQUIRED]
The type of computation. Choose one of the following options:
MAXIMUM: A maximum computation.
MINIMUM: A minimum computation.
MetricComparison (dict) --
The metric comparison computation configuration.
ComputationId (string) -- [REQUIRED]
The ID for a computation.
Name (string) --
The name of a computation.
Time (dict) --
The time field that is used in a computation.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
FromValue (dict) --
The field that is used in a metric comparison from value setup.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
TargetValue (dict) --
The field that is used in a metric comparison to value setup.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
PeriodOverPeriod (dict) --
The period over period computation configuration.
ComputationId (string) -- [REQUIRED]
The ID for a computation.
Name (string) --
The name of a computation.
Time (dict) --
The time field that is used in a computation.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Value (dict) --
The value field that is used in a computation.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
PeriodToDate (dict) --
The period to DataSetIdentifier computation configuration.
ComputationId (string) -- [REQUIRED]
The ID for a computation.
Name (string) --
The name of a computation.
Time (dict) --
The time field that is used in a computation.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Value (dict) --
The value field that is used in a computation.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
PeriodTimeGranularity (string) --
The time granularity setup of period to date computation. Choose from the following options:
YEAR: Year to date.
MONTH: Month to date.
GrowthRate (dict) --
The growth rate computation configuration.
ComputationId (string) -- [REQUIRED]
The ID for a computation.
Name (string) --
The name of a computation.
Time (dict) --
The time field that is used in a computation.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Value (dict) --
The value field that is used in a computation.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
PeriodSize (integer) --
The period size setup of a growth rate computation.
UniqueValues (dict) --
The unique values computation configuration.
ComputationId (string) -- [REQUIRED]
The ID for a computation.
Name (string) --
The name of a computation.
Category (dict) --
The category field that is used in a computation.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Forecast (dict) --
The forecast computation configuration.
ComputationId (string) -- [REQUIRED]
The ID for a computation.
Name (string) --
The name of a computation.
Time (dict) --
The time field that is used in a computation.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Value (dict) --
The value field that is used in a computation.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
PeriodsForward (integer) --
The periods forward setup of a forecast computation.
PeriodsBackward (integer) --
The periods backward setup of a forecast computation.
UpperBoundary (float) --
The upper boundary setup of a forecast computation.
LowerBoundary (float) --
The lower boundary setup of a forecast computation.
PredictionInterval (integer) --
The prediction interval setup of a forecast computation.
Seasonality (string) --
The seasonality setup of a forecast computation. Choose one of the following options:
AUTOMATIC
CUSTOM : Checks the custom seasonality value.
CustomSeasonalityValue (integer) --
The custom seasonality value setup of a forecast computation.
CustomNarrative (dict) --
The custom narrative of the insight visual.
Narrative (string) -- [REQUIRED]
The string input of custom narrative.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DataSetIdentifier (string) -- [REQUIRED]
The dataset that is used in the insight visual.
SankeyDiagramVisual (dict) --
A sankey diagram.
For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration of a sankey diagram.
FieldWells (dict) --
The field well configuration of a sankey diagram.
SankeyDiagramAggregatedFieldWells (dict) --
The field well configuration of a sankey diagram.
Source (list) --
The source field wells of a sankey diagram.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Destination (list) --
The destination field wells of a sankey diagram.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Weight (list) --
The weight field wells of a sankey diagram.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SortConfiguration (dict) --
The sort configuration of a sankey diagram.
WeightSort (list) --
The sort configuration of the weight fields.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
SourceItemsLimit (dict) --
The limit on the number of source nodes that are displayed in a sankey diagram.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
DestinationItemsLimit (dict) --
The limit on the number of destination nodes that are displayed in a sankey diagram.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
DataLabels (dict) --
The data label configuration of a sankey diagram.
Visibility (string) --
Determines the visibility of the data labels.
CategoryLabelVisibility (string) --
Determines the visibility of the category field labels.
MeasureLabelVisibility (string) --
Determines the visibility of the measure field labels.
DataLabelTypes (list) --
The option that determines the data label type.
(dict) --
The option that determines the data label type.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldLabelType (dict) --
Determines the label configuration for the entire field.
FieldId (string) --
Indicates the field that is targeted by the field label.
Visibility (string) --
The visibility of the field label.
DataPathLabelType (dict) --
The option that specifies individual data values for labels.
FieldId (string) --
The field ID of the field that the data label needs to be applied to.
FieldValue (string) --
The actual value of the field that is labeled.
Visibility (string) --
The visibility of the data label.
RangeEndsLabelType (dict) --
Determines the label configuration for range end value in a visual.
Visibility (string) --
The visibility of the range ends label.
MinimumLabelType (dict) --
Determines the label configuration for the minimum value in a visual.
Visibility (string) --
The visibility of the minimum label.
MaximumLabelType (dict) --
Determines the label configuration for the maximum value in a visual.
Visibility (string) --
The visibility of the maximum label.
Position (string) --
Determines the position of the data labels.
LabelContent (string) --
Determines the content of the data labels.
LabelFontConfiguration (dict) --
Determines the font configuration of the data labels.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
LabelColor (string) --
Determines the color of the data labels.
Overlap (string) --
Determines whether overlap is enabled or disabled for the data labels.
TotalsVisibility (string) --
Determines the visibility of the total.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CustomContentVisual (dict) --
A visual that contains custom content.
For more information, see Using custom visual content in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration of a CustomContentVisual .
ContentUrl (string) --
The input URL that links to the custom content that you want in the custom visual.
ContentType (string) --
The content type of the custom content visual. You can use this to have the visual render as an image.
ImageScaling (string) --
The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE' .
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DataSetIdentifier (string) -- [REQUIRED]
The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
EmptyVisual (dict) --
An empty visual.
VisualId (string) -- [REQUIRED]
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.
DataSetIdentifier (string) -- [REQUIRED]
The data set that is used in the empty visual. Every visual requires a dataset to render.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RadarChartVisual (dict) --
A radar chart visual.
For more information, see Using radar charts in the Amazon QuickSight User Guide .
VisualId (string) -- [REQUIRED]
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.
Title (dict) --
The title that is displayed on the visual.
Visibility (string) --
The visibility of the title label.
FormatText (dict) --
The short text format of the title label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
Subtitle (dict) --
The subtitle that is displayed on the visual.
Visibility (string) --
The visibility of the subtitle label.
FormatText (dict) --
The long text format of the subtitle label, such as plain text or rich text.
PlainText (string) --
Plain text format.
RichText (string) --
Rich text. Examples of rich text include bold, underline, and italics.
ChartConfiguration (dict) --
The configuration settings of the visual.
FieldWells (dict) --
The field well configuration of a RadarChartVisual .
RadarChartAggregatedFieldWells (dict) --
The aggregated field wells of a radar chart visual.
Category (list) --
The aggregated field well categories of a radar chart.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Color (list) --
The color that are assigned to the aggregated field wells of a radar chart.
(dict) --
The dimension type field.
NumericalDimensionField (dict) --
The dimension type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalDimensionField (dict) --
The dimension type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateDimensionField (dict) --
The dimension type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateDimensionField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DateGranularity (string) --
The date granularity of the DateDimensionField . Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
HierarchyId (string) --
The custom hierarchy ID.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Values (list) --
The values that are assigned to the aggregated field wells of a radar chart.
(dict) --
The measure (metric) type field.
NumericalMeasureField (dict) --
The measure type field with numerical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the NumericalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (dict) --
The aggregation function of the measure field.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
FormatConfiguration (dict) --
The format configuration of the field.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CategoricalMeasureField (dict) --
The measure type field with categorical type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the CategoricalMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateMeasureField (dict) --
The measure type field with date type columns.
FieldId (string) -- [REQUIRED]
The custom field ID.
Column (dict) -- [REQUIRED]
The column that is used in the DateMeasureField .
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AggregationFunction (string) --
The aggregation function of the measure field.
FormatConfiguration (dict) --
The format configuration of the field.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CalculatedMeasureField (dict) --
The calculated measure field only used in pivot tables.
FieldId (string) -- [REQUIRED]
The custom field ID.
Expression (string) -- [REQUIRED]
The expression in the table calculation.
SortConfiguration (dict) --
The sort configuration of a RadarChartVisual .
CategorySort (list) --
The category sort options of a radar chart.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
CategoryItemsLimit (dict) --
The category items limit for a radar chart.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
ColorSort (list) --
The color sort configuration of a radar chart.
(dict) --
The field sort options in a chart configuration.
FieldSort (dict) --
The sort configuration for a field in a field well.
FieldId (string) -- [REQUIRED]
The sort configuration target field.
Direction (string) -- [REQUIRED]
The sort direction. Choose one of the following options:
ASC : Ascending
DESC : Descending
ColumnSort (dict) --
The sort configuration for a column that is not used in a field well.
SortBy (dict) -- [REQUIRED]
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Direction (string) -- [REQUIRED]
The sort direction.
AggregationFunction (dict) --
The aggregation function that is defined in the column sort.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
ColorItemsLimit (dict) --
The color items limit of a radar chart.
ItemsLimit (integer) --
The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
OtherCategories (string) --
The Show other of an axis in the chart. Choose one of the following options:
INCLUDE
EXCLUDE
Shape (string) --
The shape of the radar chart.
BaseSeriesSettings (dict) --
The base sreies settings of a radar chart.
AreaStyleSettings (dict) --
The area style settings of a radar chart.
Visibility (string) --
The visibility settings of a radar chart.
StartAngle (float) --
The start angle of a radar chart's axis.
VisualPalette (dict) --
The palette (chart color) display setup of the visual.
ChartColor (string) --
The chart color options for the visual palette.
ColorMap (list) --
The color map options for the visual palette.
(dict) --
The color map that determines the color options for a particular element.
Element (dict) -- [REQUIRED]
The element that the color needs to be applied to.
FieldId (string) --
The field ID of the field that needs to be sorted.
FieldValue (string) --
The actual value of the field that needs to be sorted.
DataPathType (dict) --
The type configuration of the field.
PivotTableDataPathType (string) --
The type of data path value utilized in a pivot table. Choose one of the following options:
HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .
Color (string) -- [REQUIRED]
The color that needs to be applied to the element.
TimeGranularity (string) --
The time granularity of the field that the color needs to be applied to.
AlternateBandColorsVisibility (string) --
Determines the visibility of the colors of alternatign bands in a radar chart.
AlternateBandEvenColor (string) --
The color of the even-numbered alternate bands of a radar chart.
AlternateBandOddColor (string) --
The color of the odd-numbered alternate bands of a radar chart.
CategoryAxis (dict) --
The category axis of a radar chart.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
CategoryLabelOptions (dict) --
The category label options of a radar chart.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColorAxis (dict) --
The color axis of a radar chart.
TickLabelOptions (dict) --
The tick label options of an axis.
LabelOptions (dict) --
Determines whether or not the axis ticks are visible.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
RotationAngle (float) --
The rotation angle of the axis tick labels.
AxisLineVisibility (string) --
Determines whether or not the axis line is visible.
GridLineVisibility (string) --
Determines whether or not the grid line is visible.
DataOptions (dict) --
The data options for an axis.
NumericAxisOptions (dict) --
The options for an axis with a numeric field.
Scale (dict) --
The scale setup of a numeric axis.
Linear (dict) --
The linear axis scale setup.
StepCount (integer) --
The step count setup of a linear axis.
StepSize (float) --
The step size setup of a linear axis.
Logarithmic (dict) --
The logarithmic axis scale setup.
Base (float) --
The base setup of a logarithmic axis scale.
Range (dict) --
The range setup of a numeric axis.
MinMax (dict) --
The minimum and maximum setup of an axis display range.
Minimum (float) --
The minimum setup for an axis display range.
Maximum (float) --
The maximum setup for an axis display range.
DataDriven (dict) --
The data-driven setup of an axis display range.
DateAxisOptions (dict) --
The options for an axis with a date field.
MissingDateVisibility (string) --
Determines whether or not missing dates are displayed.
ScrollbarOptions (dict) --
The scroll bar options for an axis.
Visibility (string) --
The visibility of the data zoom scroll bar.
VisibleRange (dict) --
The visibility range for the data zoom scroll bar.
PercentRange (dict) --
The percent range in the visible range.
From (float) --
The lower bound of the range.
To (float) --
The top bound of the range.
AxisOffset (string) --
The offset value that determines the starting placement of the axis within a visual's bounds.
ColorLabelOptions (dict) --
The color label options of a radar chart.
Visibility (string) --
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE : Shows the axis.
HIDDEN : Hides the axis.
SortIconVisibility (string) --
The visibility configuration of the sort icon on a chart's axis label.
AxisLabelOptions (list) --
The label options for a chart axis.
(dict) --
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration (dict) --
The font configuration of the axis label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the axis label.
ApplyTo (dict) --
The options that indicate which field the label belongs to.
FieldId (string) -- [REQUIRED]
The field that the axis label is targeted to.
Column (dict) -- [REQUIRED]
The column that the axis label is targeted to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Legend (dict) --
The legend display setup of the visual.
Visibility (string) --
Determines whether or not the legend is visible.
Title (dict) --
The custom title for the legend.
Visibility (string) --
Determines whether or not the label is visible.
FontConfiguration (dict) --
The font configuration of the label.
FontSize (dict) --
The option that determines the text display size.
Relative (string) --
The lexical name for the text size, proportional to its surrounding context.
FontDecoration (string) --
Determines the appearance of decorative lines on the text.
FontColor (string) --
Determines the color of the text.
FontWeight (dict) --
The option that determines the text display weight, or boldness.
Name (string) --
The lexical name for the level of boldness of the text display.
FontStyle (string) --
Determines the text display face that is inherited by the given font family.
CustomLabel (string) --
The text for the label.
Position (string) --
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
Width (string) --
The width of the legend. If this value is omitted, a default width is used when rendering.
Height (string) --
The height of the legend. If this value is omitted, a default height is used when rendering.
AxesRangeScale (string) --
The axis behavior options of a radar chart.
Actions (list) --
The list of custom actions that are configured for a visual.
(dict) --
A custom action defined on a visual.
CustomActionId (string) -- [REQUIRED]
The ID of the VisualCustomAction .
Name (string) -- [REQUIRED]
The name of the VisualCustomAction .
Status (string) --
The status of the VisualCustomAction .
Trigger (string) -- [REQUIRED]
The trigger of the VisualCustomAction .
Valid values are defined as follows:
DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.
ActionOperations (list) -- [REQUIRED]
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(dict) --
The operation that is defined by the custom action.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterOperation (dict) --
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the fields to be filtered.
SelectedFields (list) --
Chooses the fields that are filtered in CustomActionFilterOperation .
(string) --
SelectedFieldOptions (string) --
A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .
Valid values are defined as follows:
ALL_FIELDS : Applies the filter operation to all fields.
SelectedColumns (list) --
The selected columns of a dataset.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
TargetVisualsConfiguration (dict) -- [REQUIRED]
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration (dict) --
The configuration of the same-sheet target visuals that you want to be filtered.
TargetVisuals (list) --
A list of the target visual IDs that are located in the same sheet of the analysis.
(string) --
TargetVisualOptions (string) --
The options that choose the target visual in the same sheet.
Valid values are defined as follows:
ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
NavigationOperation (dict) --
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration (dict) --
The configuration that chooses the navigation target.
TargetSheetId (string) -- [REQUIRED]
The sheet that is targeted for navigation in the same analysis.
URLOperation (dict) --
The URL operation that opens a link to another webpage.
URLTemplate (string) -- [REQUIRED]
THe URL link of the CustomActionURLOperation .
URLTarget (string) -- [REQUIRED]
The target of the CustomActionURLOperation .
Valid values are defined as follows:
NEW_TAB : Opens the target URL in a new browser tab.
NEW_WINDOW : Opens the target URL in a new browser window.
SAME_TAB : Opens the target URL in the same browser tab.
SetParametersOperation (dict) --
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations (list) -- [REQUIRED]
The parameter that determines the value configuration.
(dict) --
The configuration of adding parameters in action.
DestinationParameterName (string) -- [REQUIRED]
The destination parameter name of the SetParameterValueConfiguration .
Value (dict) -- [REQUIRED]
The configuration of destination parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomValuesConfiguration (dict) --
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue (boolean) --
Includes the null value in custom action parameter values.
CustomValues (dict) -- [REQUIRED]
The customized parameter values.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringValues (list) --
A list of string-type parameter values.
(string) --
IntegerValues (list) --
A list of integer-type parameter values.
(integer) --
DecimalValues (list) --
A list of decimal-type parameter values.
(float) --
DateTimeValues (list) --
A list of datetime-type parameter values.
(datetime) --
SelectAllValueOptions (string) --
The configuration that selects all options.
SourceParameterName (string) --
The source parameter name of the destination parameter.
SourceField (string) --
The source field ID of the destination parameter.
SourceColumn (dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
ColumnHierarchies (list) --
The column hierarchy that is used during drill-downs and drill-ups.
(dict) --
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the explicit hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the explicit hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the explicit hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
DateTimeHierarchy (dict) --
The option that determines the hierarchy of any DateTime fields.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the DateTime hierarchy.
DrillDownFilters (list) --
The option that determines the drill down filters for the DateTime hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
PredefinedHierarchy (dict) --
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.
HierarchyId (string) -- [REQUIRED]
The hierarchy ID of the predefined hierarchy.
Columns (list) -- [REQUIRED]
The list of columns that define the predefined hierarchy.
(dict) --
A column of a data set.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DrillDownFilters (list) --
The option that determines the drill down filters for the predefined hierarchy.
(dict) --
The drill down filter for the column hierarchies.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
NumericEqualityFilter (dict) --
The numeric equality type drill down filter. This filter is used for number type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) -- [REQUIRED]
The value of the double input numeric drill down filter.
CategoryFilter (dict) --
The category type drill down filter. This filter is used for string type columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
CategoryValues (list) -- [REQUIRED]
A list of the string inputs that are the values of the category drill down filter.
(string) --
TimeRangeFilter (dict) --
The time range drill down filter. This filter is used for date time columns.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
RangeMinimum (datetime) -- [REQUIRED]
The minimum value for the filter value range.
RangeMaximum (datetime) -- [REQUIRED]
The maximum value for the filter value range.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
TextBoxes (list) --
The text boxes that are on a sheet.
(dict) --
A text box.
SheetTextBoxId (string) -- [REQUIRED]
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.
Content (string) --
The content that is displayed in the text box.
Layouts (list) --
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide .
(dict) --
A Layout defines the placement of elements within a sheet.
For more information, see Types of layout in the Amazon QuickSight User Guide .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
Configuration (dict) -- [REQUIRED]
The configuration that determines what the type of layout for a sheet.
GridLayout (dict) --
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: FIXED or RESPONSIVE .
Elements (list) -- [REQUIRED]
The elements that are included in a grid layout.
(dict) --
An element within a grid layout.
ElementId (string) -- [REQUIRED]
A unique identifier for an element within a grid layout.
ElementType (string) -- [REQUIRED]
The type of element.
ColumnIndex (integer) --
The column index for the upper left corner of an element.
ColumnSpan (integer) -- [REQUIRED]
The width of a grid element expressed as a number of grid columns.
RowIndex (integer) --
The row index for the upper left corner of an element.
RowSpan (integer) -- [REQUIRED]
The height of a grid element expressed as a number of grid rows.
CanvasSizeOptions (dict) --
Configuration options for the canvas of a grid layout.
ScreenCanvasSizeOptions (dict) --
The options that determine the sizing of the canvas used in a grid layout.
ResizeOption (string) -- [REQUIRED]
This value determines the layout behavior when the viewport is resized.
FIXED : A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic .
RESPONSIVE : The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled .
OptimizedViewPortWidth (string) --
The width that the view port will be optimized for when the layout renders.
FreeFormLayout (dict) --
A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
Elements (list) -- [REQUIRED]
The elements that are included in a free-form layout.
(dict) --
An element within a free-form layout.
ElementId (string) -- [REQUIRED]
A unique identifier for an element within a free-form layout.
ElementType (string) -- [REQUIRED]
The type of element.
XAxisLocation (string) -- [REQUIRED]
The x-axis coordinate of the element.
YAxisLocation (string) -- [REQUIRED]
The y-axis coordinate of the element.
Width (string) -- [REQUIRED]
The width of an element within a free-form layout.
Height (string) -- [REQUIRED]
The height of an element within a free-form layout.
Visibility (string) --
The visibility of an element within a free-form layout.
RenderingRules (list) --
The rendering rules that determine when an element should be displayed within a free-form layout.
(dict) --
The rendering rules of a sheet that uses a free-form layout.
Expression (string) -- [REQUIRED]
The expression of the rendering rules of a sheet.
ConfigurationOverrides (dict) -- [REQUIRED]
The override configuration of the rendering rules of a sheet.
Visibility (string) --
Determines whether or not the overrides are visible. Choose one of the following options:
VISIBLE
HIDDEN
BorderStyle (dict) --
The border style configuration of a free-form layout element.
Visibility (string) --
The border visibility of a free-form layout element.
Color (string) --
The border color of a free-form layout element.
SelectedBorderStyle (dict) --
The border style configuration of a free-form layout element. This border style is used when the element is selected.
Visibility (string) --
The border visibility of a free-form layout element.
Color (string) --
The border color of a free-form layout element.
BackgroundStyle (dict) --
The background style configuration of a free-form layout element.
Visibility (string) --
The background visibility of a free-form layout element.
Color (string) --
The background color of a free-form layout element.
LoadingAnimation (dict) --
The loading animation configuration of a free-form layout element.
Visibility (string) --
The visibility configuration of LoadingAnimation .
CanvasSizeOptions (dict) --
Configuration options for the canvas of a free-form layout.
ScreenCanvasSizeOptions (dict) --
The options that determine the sizing of the canvas used in a free-form layout.
OptimizedViewPortWidth (string) -- [REQUIRED]
The width that the view port will be optimized for when the layout renders.
SectionBasedLayout (dict) --
A section based layout organizes visuals into multiple sections and has customized header, footer and page break.
HeaderSections (list) -- [REQUIRED]
A list of header section configurations.
(dict) --
The configuration of a header or footer section.
SectionId (string) -- [REQUIRED]
The unique identifier of the header or footer section.
Layout (dict) -- [REQUIRED]
The layout configuration of the header or footer section.
FreeFormLayout (dict) -- [REQUIRED]
The free-form layout configuration of a section.
Elements (list) -- [REQUIRED]
The elements that are included in the free-form layout.
(dict) --
An element within a free-form layout.
ElementId (string) -- [REQUIRED]
A unique identifier for an element within a free-form layout.
ElementType (string) -- [REQUIRED]
The type of element.
XAxisLocation (string) -- [REQUIRED]
The x-axis coordinate of the element.
YAxisLocation (string) -- [REQUIRED]
The y-axis coordinate of the element.
Width (string) -- [REQUIRED]
The width of an element within a free-form layout.
Height (string) -- [REQUIRED]
The height of an element within a free-form layout.
Visibility (string) --
The visibility of an element within a free-form layout.
RenderingRules (list) --
The rendering rules that determine when an element should be displayed within a free-form layout.
(dict) --
The rendering rules of a sheet that uses a free-form layout.
Expression (string) -- [REQUIRED]
The expression of the rendering rules of a sheet.
ConfigurationOverrides (dict) -- [REQUIRED]
The override configuration of the rendering rules of a sheet.
Visibility (string) --
Determines whether or not the overrides are visible. Choose one of the following options:
VISIBLE
HIDDEN
BorderStyle (dict) --
The border style configuration of a free-form layout element.
Visibility (string) --
The border visibility of a free-form layout element.
Color (string) --
The border color of a free-form layout element.
SelectedBorderStyle (dict) --
The border style configuration of a free-form layout element. This border style is used when the element is selected.
Visibility (string) --
The border visibility of a free-form layout element.
Color (string) --
The border color of a free-form layout element.
BackgroundStyle (dict) --
The background style configuration of a free-form layout element.
Visibility (string) --
The background visibility of a free-form layout element.
Color (string) --
The background color of a free-form layout element.
LoadingAnimation (dict) --
The loading animation configuration of a free-form layout element.
Visibility (string) --
The visibility configuration of LoadingAnimation .
Style (dict) --
The style options of a header or footer section.
Height (string) --
The height of a section.
Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.
Padding (dict) --
The spacing between section content and its top, bottom, left, and right edges.
There is no padding by default.
Top (string) --
Define the top spacing.
Bottom (string) --
Define the bottom spacing.
Left (string) --
Define the left spacing.
Right (string) --
Define the right spacing.
BodySections (list) -- [REQUIRED]
A list of body section configurations.
(dict) --
The configuration of a body section.
SectionId (string) -- [REQUIRED]
The unique identifier of a body section.
Content (dict) -- [REQUIRED]
The configuration of content in a body section.
Layout (dict) --
The layout configuration of a body section.
FreeFormLayout (dict) -- [REQUIRED]
The free-form layout configuration of a section.
Elements (list) -- [REQUIRED]
The elements that are included in the free-form layout.
(dict) --
An element within a free-form layout.
ElementId (string) -- [REQUIRED]
A unique identifier for an element within a free-form layout.
ElementType (string) -- [REQUIRED]
The type of element.
XAxisLocation (string) -- [REQUIRED]
The x-axis coordinate of the element.
YAxisLocation (string) -- [REQUIRED]
The y-axis coordinate of the element.
Width (string) -- [REQUIRED]
The width of an element within a free-form layout.
Height (string) -- [REQUIRED]
The height of an element within a free-form layout.
Visibility (string) --
The visibility of an element within a free-form layout.
RenderingRules (list) --
The rendering rules that determine when an element should be displayed within a free-form layout.
(dict) --
The rendering rules of a sheet that uses a free-form layout.
Expression (string) -- [REQUIRED]
The expression of the rendering rules of a sheet.
ConfigurationOverrides (dict) -- [REQUIRED]
The override configuration of the rendering rules of a sheet.
Visibility (string) --
Determines whether or not the overrides are visible. Choose one of the following options:
VISIBLE
HIDDEN
BorderStyle (dict) --
The border style configuration of a free-form layout element.
Visibility (string) --
The border visibility of a free-form layout element.
Color (string) --
The border color of a free-form layout element.
SelectedBorderStyle (dict) --
The border style configuration of a free-form layout element. This border style is used when the element is selected.
Visibility (string) --
The border visibility of a free-form layout element.
Color (string) --
The border color of a free-form layout element.
BackgroundStyle (dict) --
The background style configuration of a free-form layout element.
Visibility (string) --
The background visibility of a free-form layout element.
Color (string) --
The background color of a free-form layout element.
LoadingAnimation (dict) --
The loading animation configuration of a free-form layout element.
Visibility (string) --
The visibility configuration of LoadingAnimation .
Style (dict) --
The style options of a body section.
Height (string) --
The height of a section.
Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.
Padding (dict) --
The spacing between section content and its top, bottom, left, and right edges.
There is no padding by default.
Top (string) --
Define the top spacing.
Bottom (string) --
Define the bottom spacing.
Left (string) --
Define the left spacing.
Right (string) --
Define the right spacing.
PageBreakConfiguration (dict) --
The configuration of a page break for a section.
After (dict) --
The configuration of a page break after a section.
Status (string) --
The option that enables or disables a page break at the end of a section.
FooterSections (list) -- [REQUIRED]
A list of footer section configurations.
(dict) --
The configuration of a header or footer section.
SectionId (string) -- [REQUIRED]
The unique identifier of the header or footer section.
Layout (dict) -- [REQUIRED]
The layout configuration of the header or footer section.
FreeFormLayout (dict) -- [REQUIRED]
The free-form layout configuration of a section.
Elements (list) -- [REQUIRED]
The elements that are included in the free-form layout.
(dict) --
An element within a free-form layout.
ElementId (string) -- [REQUIRED]
A unique identifier for an element within a free-form layout.
ElementType (string) -- [REQUIRED]
The type of element.
XAxisLocation (string) -- [REQUIRED]
The x-axis coordinate of the element.
YAxisLocation (string) -- [REQUIRED]
The y-axis coordinate of the element.
Width (string) -- [REQUIRED]
The width of an element within a free-form layout.
Height (string) -- [REQUIRED]
The height of an element within a free-form layout.
Visibility (string) --
The visibility of an element within a free-form layout.
RenderingRules (list) --
The rendering rules that determine when an element should be displayed within a free-form layout.
(dict) --
The rendering rules of a sheet that uses a free-form layout.
Expression (string) -- [REQUIRED]
The expression of the rendering rules of a sheet.
ConfigurationOverrides (dict) -- [REQUIRED]
The override configuration of the rendering rules of a sheet.
Visibility (string) --
Determines whether or not the overrides are visible. Choose one of the following options:
VISIBLE
HIDDEN
BorderStyle (dict) --
The border style configuration of a free-form layout element.
Visibility (string) --
The border visibility of a free-form layout element.
Color (string) --
The border color of a free-form layout element.
SelectedBorderStyle (dict) --
The border style configuration of a free-form layout element. This border style is used when the element is selected.
Visibility (string) --
The border visibility of a free-form layout element.
Color (string) --
The border color of a free-form layout element.
BackgroundStyle (dict) --
The background style configuration of a free-form layout element.
Visibility (string) --
The background visibility of a free-form layout element.
Color (string) --
The background color of a free-form layout element.
LoadingAnimation (dict) --
The loading animation configuration of a free-form layout element.
Visibility (string) --
The visibility configuration of LoadingAnimation .
Style (dict) --
The style options of a header or footer section.
Height (string) --
The height of a section.
Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.
Padding (dict) --
The spacing between section content and its top, bottom, left, and right edges.
There is no padding by default.
Top (string) --
Define the top spacing.
Bottom (string) --
Define the bottom spacing.
Left (string) --
Define the left spacing.
Right (string) --
Define the right spacing.
CanvasSizeOptions (dict) -- [REQUIRED]
The options for the canvas of a section-based layout.
PaperCanvasSizeOptions (dict) --
The options for a paper canvas of a section-based layout.
PaperSize (string) --
The paper size that is used to define canvas dimensions.
PaperOrientation (string) --
The paper orientation that is used to define canvas dimensions. Choose one of the following options:
PORTRAIT
LANDSCAPE
PaperMargin (dict) --
Defines the spacing between the canvas content and the top, bottom, left, and right edges.
Top (string) --
Define the top spacing.
Bottom (string) --
Define the bottom spacing.
Left (string) --
Define the left spacing.
Right (string) --
Define the right spacing.
SheetControlLayouts (list) --
The control layouts of the sheet.
(dict) --
A grid layout to define the placement of sheet control.
Configuration (dict) -- [REQUIRED]
The configuration that determines the elements and canvas size options of sheet control.
GridLayout (dict) --
The configuration that determines the elements and canvas size options of sheet control.
Elements (list) -- [REQUIRED]
The elements that are included in a grid layout.
(dict) --
An element within a grid layout.
ElementId (string) -- [REQUIRED]
A unique identifier for an element within a grid layout.
ElementType (string) -- [REQUIRED]
The type of element.
ColumnIndex (integer) --
The column index for the upper left corner of an element.
ColumnSpan (integer) -- [REQUIRED]
The width of a grid element expressed as a number of grid columns.
RowIndex (integer) --
The row index for the upper left corner of an element.
RowSpan (integer) -- [REQUIRED]
The height of a grid element expressed as a number of grid rows.
CanvasSizeOptions (dict) --
Configuration options for the canvas of a grid layout.
ScreenCanvasSizeOptions (dict) --
The options that determine the sizing of the canvas used in a grid layout.
ResizeOption (string) -- [REQUIRED]
This value determines the layout behavior when the viewport is resized.
FIXED : A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic .
RESPONSIVE : The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled .
OptimizedViewPortWidth (string) --
The width that the view port will be optimized for when the layout renders.
ContentType (string) --
The layout content type of the sheet. Choose one of the following options:
PAGINATED : Creates a sheet for a paginated report.
INTERACTIVE : Creates a sheet for an interactive dashboard.
CalculatedFields (list) --
An array of calculated field definitions for the dashboard.
(dict) --
The calculated field of an analysis.
DataSetIdentifier (string) -- [REQUIRED]
The data set that is used in this calculated field.
Name (string) -- [REQUIRED]
The name of the calculated field.
Expression (string) -- [REQUIRED]
The expression of the calculated field.
ParameterDeclarations (list) --
The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.
For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide .
(dict) --
The declaration definition of a parameter.
For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
StringParameterDeclaration (dict) --
A parameter declaration for the String data type.
ParameterValueType (string) -- [REQUIRED]
The value type determines whether the parameter is a single-value or multi-value parameter.
Name (string) -- [REQUIRED]
The name of the parameter that is being declared.
DefaultValues (dict) --
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
DynamicValue (dict) --
The dynamic value of the StringDefaultValues . Different defaults displayed according to users, groups, and values mapping.
UserNameColumn (dict) --
The column that contains the username.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
GroupNameColumn (dict) --
The column that contains the group name.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DefaultValueColumn (dict) -- [REQUIRED]
The column that contains the default value of each user or group.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
StaticValues (list) --
The static values of the DecimalDefaultValues .
(string) --
ValueWhenUnset (dict) --
The configuration that defines the default value of a String parameter when a value has not been set.
ValueWhenUnsetOption (string) --
The built-in options for default values. The value can be one of the following:
RECOMMENDED : The recommended value.
NULL : The NULL value.
CustomValue (string) --
A custom value that's used when the value of a parameter isn't set.
MappedDataSetParameters (list) --
A list of dataset parameters that are mapped to an analysis parameter.
(dict) --
A dataset parameter that is mapped to an analysis parameter.
DataSetIdentifier (string) -- [REQUIRED]
A unique name that identifies a dataset within the analysis or dashboard.
DataSetParameterName (string) -- [REQUIRED]
The name of the dataset parameter.
DecimalParameterDeclaration (dict) --
A parameter declaration for the Decimal data type.
ParameterValueType (string) -- [REQUIRED]
The value type determines whether the parameter is a single-value or multi-value parameter.
Name (string) -- [REQUIRED]
The name of the parameter that is being declared.
DefaultValues (dict) --
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
DynamicValue (dict) --
The dynamic value of the DecimalDefaultValues . Different defaults are displayed according to users, groups, and values mapping.
UserNameColumn (dict) --
The column that contains the username.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
GroupNameColumn (dict) --
The column that contains the group name.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DefaultValueColumn (dict) -- [REQUIRED]
The column that contains the default value of each user or group.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
StaticValues (list) --
The static values of the DecimalDefaultValues .
(float) --
ValueWhenUnset (dict) --
The configuration that defines the default value of a Decimal parameter when a value has not been set.
ValueWhenUnsetOption (string) --
The built-in options for default values. The value can be one of the following:
RECOMMENDED : The recommended value.
NULL : The NULL value.
CustomValue (float) --
A custom value that's used when the value of a parameter isn't set.
MappedDataSetParameters (list) --
A list of dataset parameters that are mapped to an analysis parameter.
(dict) --
A dataset parameter that is mapped to an analysis parameter.
DataSetIdentifier (string) -- [REQUIRED]
A unique name that identifies a dataset within the analysis or dashboard.
DataSetParameterName (string) -- [REQUIRED]
The name of the dataset parameter.
IntegerParameterDeclaration (dict) --
A parameter declaration for the Integer data type.
ParameterValueType (string) -- [REQUIRED]
The value type determines whether the parameter is a single-value or multi-value parameter.
Name (string) -- [REQUIRED]
The name of the parameter that is being declared.
DefaultValues (dict) --
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
DynamicValue (dict) --
The dynamic value of the IntegerDefaultValues . Different defaults are displayed according to users, groups, and values mapping.
UserNameColumn (dict) --
The column that contains the username.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
GroupNameColumn (dict) --
The column that contains the group name.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DefaultValueColumn (dict) -- [REQUIRED]
The column that contains the default value of each user or group.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
StaticValues (list) --
The static values of the IntegerDefaultValues .
(integer) --
ValueWhenUnset (dict) --
A parameter declaration for the Integer data type.
ValueWhenUnsetOption (string) --
The built-in options for default values. The value can be one of the following:
RECOMMENDED : The recommended value.
NULL : The NULL value.
CustomValue (integer) --
A custom value that's used when the value of a parameter isn't set.
MappedDataSetParameters (list) --
A list of dataset parameters that are mapped to an analysis parameter.
(dict) --
A dataset parameter that is mapped to an analysis parameter.
DataSetIdentifier (string) -- [REQUIRED]
A unique name that identifies a dataset within the analysis or dashboard.
DataSetParameterName (string) -- [REQUIRED]
The name of the dataset parameter.
DateTimeParameterDeclaration (dict) --
A parameter declaration for the DateTime data type.
Name (string) -- [REQUIRED]
The name of the parameter that is being declared.
DefaultValues (dict) --
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
DynamicValue (dict) --
The dynamic value of the DataTimeDefaultValues . Different defaults are displayed according to users, groups, and values mapping.
UserNameColumn (dict) --
The column that contains the username.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
GroupNameColumn (dict) --
The column that contains the group name.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
DefaultValueColumn (dict) -- [REQUIRED]
The column that contains the default value of each user or group.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
StaticValues (list) --
The static values of the DataTimeDefaultValues .
(datetime) --
RollingDate (dict) --
The rolling date of the DataTimeDefaultValues . The date is determined from the dataset based on input expression.
DataSetIdentifier (string) --
The data set that is used in the rolling date configuration.
Expression (string) -- [REQUIRED]
The expression of the rolling date configuration.
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
ValueWhenUnset (dict) --
The configuration that defines the default value of a DateTime parameter when a value has not been set.
ValueWhenUnsetOption (string) --
The built-in options for default values. The value can be one of the following:
RECOMMENDED : The recommended value.
NULL : The NULL value.
CustomValue (datetime) --
A custom value that's used when the value of a parameter isn't set.
MappedDataSetParameters (list) --
A list of dataset parameters that are mapped to an analysis parameter.
(dict) --
A dataset parameter that is mapped to an analysis parameter.
DataSetIdentifier (string) -- [REQUIRED]
A unique name that identifies a dataset within the analysis or dashboard.
DataSetParameterName (string) -- [REQUIRED]
The name of the dataset parameter.
FilterGroups (list) --
The filter definitions for a dashboard.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide .
(dict) --
A grouping of individual filters. Filter groups are applied to the same group of visuals.
For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide .
FilterGroupId (string) -- [REQUIRED]
The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.
Filters (list) -- [REQUIRED]
The list of filters that are present in a FilterGroup .
(dict) --
With a Filter , you can remove portions of data from a particular visual or view.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CategoryFilter (dict) --
A CategoryFilter filters text values.
For more information, see Adding text filters in the Amazon QuickSight User Guide .
FilterId (string) -- [REQUIRED]
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Configuration (dict) -- [REQUIRED]
The configuration for a CategoryFilter .
FilterListConfiguration (dict) --
A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.
MatchOperator (string) -- [REQUIRED]
The match operator that is used to determine if a filter should be applied.
CategoryValues (list) --
The list of category values for the filter.
(string) --
SelectAllOptions (string) --
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
NullOption (string) --
This option determines how null values should be treated when filtering data.
ALL_VALUES : Include null values in filtered results.
NULLS_ONLY : Only include null values in filtered results.
NON_NULLS_ONLY : Exclude null values from filtered results.
CustomFilterListConfiguration (dict) --
A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.
MatchOperator (string) -- [REQUIRED]
The match operator that is used to determine if a filter should be applied.
CategoryValues (list) --
The list of category values for the filter.
(string) --
SelectAllOptions (string) --
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
NullOption (string) -- [REQUIRED]
This option determines how null values should be treated when filtering data.
ALL_VALUES : Include null values in filtered results.
NULLS_ONLY : Only include null values in filtered results.
NON_NULLS_ONLY : Exclude null values from filtered results.
CustomFilterConfiguration (dict) --
A custom filter that filters based on a single value. This filter can be partially matched.
MatchOperator (string) -- [REQUIRED]
The match operator that is used to determine if a filter should be applied.
CategoryValue (string) --
The category value for the filter.
This field is mutually exclusive to ParameterName .
SelectAllOptions (string) --
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
ParameterName (string) --
The parameter whose value should be used for the filter value.
This field is mutually exclusive to CategoryValue .
NullOption (string) -- [REQUIRED]
This option determines how null values should be treated when filtering data.
ALL_VALUES : Include null values in filtered results.
NULLS_ONLY : Only include null values in filtered results.
NON_NULLS_ONLY : Exclude null values from filtered results.
NumericRangeFilter (dict) --
A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
FilterId (string) -- [REQUIRED]
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
IncludeMinimum (boolean) --
Determines whether the minimum value in the filter value range should be included in the filtered results.
IncludeMaximum (boolean) --
Determines whether the maximum value in the filter value range should be included in the filtered results.
RangeMinimum (dict) --
The minimum value for the filter value range.
StaticValue (float) --
The static value of the numeric range filter.
Parameter (string) --
The parameter that is used in the numeric range.
RangeMaximum (dict) --
The maximum value for the filter value range.
StaticValue (float) --
The static value of the numeric range filter.
Parameter (string) --
The parameter that is used in the numeric range.
SelectAllOptions (string) --
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
AggregationFunction (dict) --
The aggregation function of the filter.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
NullOption (string) -- [REQUIRED]
This option determines how null values should be treated when filtering data.
ALL_VALUES : Include null values in filtered results.
NULLS_ONLY : Only include null values in filtered results.
NON_NULLS_ONLY : Exclude null values from filtered results.
NumericEqualityFilter (dict) --
A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
FilterId (string) -- [REQUIRED]
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (float) --
The input value.
SelectAllOptions (string) --
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
MatchOperator (string) -- [REQUIRED]
The match operator that is used to determine if a filter should be applied.
AggregationFunction (dict) --
The aggregation function of the filter.
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
ParameterName (string) --
The parameter whose value should be used for the filter value.
NullOption (string) -- [REQUIRED]
This option determines how null values should be treated when filtering data.
ALL_VALUES : Include null values in filtered results.
NULLS_ONLY : Only include null values in filtered results.
NON_NULLS_ONLY : Exclude null values from filtered results.
TimeEqualityFilter (dict) --
A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
FilterId (string) -- [REQUIRED]
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Value (datetime) --
The value of a TimeEquality filter.
This field is mutually exclusive to RollingDate and ParameterName .
ParameterName (string) --
The parameter whose value should be used for the filter value.
This field is mutually exclusive to Value and RollingDate .
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
RollingDate (dict) --
The rolling date input for the TimeEquality filter.
This field is mutually exclusive to Value and ParameterName .
DataSetIdentifier (string) --
The data set that is used in the rolling date configuration.
Expression (string) -- [REQUIRED]
The expression of the rolling date configuration.
TimeRangeFilter (dict) --
A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
FilterId (string) -- [REQUIRED]
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
IncludeMinimum (boolean) --
Determines whether the minimum value in the filter value range should be included in the filtered results.
IncludeMaximum (boolean) --
Determines whether the maximum value in the filter value range should be included in the filtered results.
RangeMinimumValue (dict) --
The minimum value for the filter value range.
StaticValue (datetime) --
The static input value.
RollingDate (dict) --
The rolling date input value.
DataSetIdentifier (string) --
The data set that is used in the rolling date configuration.
Expression (string) -- [REQUIRED]
The expression of the rolling date configuration.
Parameter (string) --
The parameter type input value.
RangeMaximumValue (dict) --
The maximum value for the filter value range.
StaticValue (datetime) --
The static input value.
RollingDate (dict) --
The rolling date input value.
DataSetIdentifier (string) --
The data set that is used in the rolling date configuration.
Expression (string) -- [REQUIRED]
The expression of the rolling date configuration.
Parameter (string) --
The parameter type input value.
NullOption (string) -- [REQUIRED]
This option determines how null values should be treated when filtering data.
ALL_VALUES : Include null values in filtered results.
NULLS_ONLY : Only include null values in filtered results.
NON_NULLS_ONLY : Exclude null values from filtered results.
ExcludePeriodConfiguration (dict) --
The exclude period of the time range filter.
Amount (integer) -- [REQUIRED]
The amount or number of the exclude period.
Granularity (string) -- [REQUIRED]
The granularity or unit (day, month, year) of the exclude period.
Status (string) --
The status of the exclude period. Choose from the following options:
ENABLED
DISABLED
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
RelativeDatesFilter (dict) --
A RelativeDatesFilter filters date values that are relative to a given date.
FilterId (string) -- [REQUIRED]
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
AnchorDateConfiguration (dict) -- [REQUIRED]
The date configuration of the filter.
AnchorOption (string) --
The options for the date configuration. Choose one of the options below:
NOW
ParameterName (string) --
The name of the parameter that is used for the anchor date configuration.
MinimumGranularity (string) --
The minimum granularity (period granularity) of the relative dates filter.
TimeGranularity (string) -- [REQUIRED]
The level of time precision that is used to aggregate DateTime values.
RelativeDateType (string) -- [REQUIRED]
The range date type of the filter. Choose one of the options below:
PREVIOUS
THIS
LAST
NOW
NEXT
RelativeDateValue (integer) --
The date value of the filter.
ParameterName (string) --
The parameter whose value should be used for the filter value.
NullOption (string) -- [REQUIRED]
This option determines how null values should be treated when filtering data.
ALL_VALUES : Include null values in filtered results.
NULLS_ONLY : Only include null values in filtered results.
NON_NULLS_ONLY : Exclude null values from filtered results.
ExcludePeriodConfiguration (dict) --
The configuration for the exclude period of the filter.
Amount (integer) -- [REQUIRED]
The amount or number of the exclude period.
Granularity (string) -- [REQUIRED]
The granularity or unit (day, month, year) of the exclude period.
Status (string) --
The status of the exclude period. Choose from the following options:
ENABLED
DISABLED
TopBottomFilter (dict) --
A TopBottomFilter filters data to the top or bottom values for a given column.
FilterId (string) -- [REQUIRED]
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Column (dict) -- [REQUIRED]
The column that the filter is applied to.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
Limit (integer) --
The number of items to include in the top bottom filter results.
AggregationSortConfigurations (list) -- [REQUIRED]
The aggregation and sort configuration of the top bottom filter.
(dict) --
The configuration options to sort aggregated values.
Column (dict) -- [REQUIRED]
The column that determines the sort order of aggregated values.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
SortDirection (string) -- [REQUIRED]
The sort direction of values.
ASC : Sort in ascending order.
DESC : Sort in descending order.
AggregationFunction (dict) --
The function that aggregates the values in Column .
NumericalAggregationFunction (dict) --
Aggregation for numerical values.
SimpleNumericalAggregation (string) --
Built-in aggregation functions for numerical values.
SUM : The sum of a dimension or measure.
AVERAGE : The average of a dimension or measure.
MIN : The minimum value of a dimension or measure.
MAX : The maximum value of a dimension or measure.
COUNT : The count of a dimension or measure.
DISTINCT_COUNT : The count of distinct values in a dimension or measure.
VAR : The variance of a dimension or measure.
VARP : The partitioned variance of a dimension or measure.
STDEV : The standard deviation of a dimension or measure.
STDEVP : The partitioned standard deviation of a dimension or measure.
MEDIAN : The median value of a dimension or measure.
PercentileAggregation (dict) --
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue (float) --
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
CategoricalAggregationFunction (string) --
Aggregation for categorical values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
DateAggregationFunction (string) --
Aggregation for date values.
COUNT : Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT : Aggregate by the total number of distinct values.
MIN : Select the smallest date value.
MAX : Select the largest date value.
AttributeAggregationFunction (dict) --
Aggregation for attributes.
SimpleAttributeAggregation (string) --
The built-in aggregation functions for attributes.
UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.
ValueForMultipleValues (string) --
Used by the UNIQUE_VALUE 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 '*'.
TimeGranularity (string) --
The level of time precision that is used to aggregate DateTime values.
ParameterName (string) --
The parameter whose value should be used for the filter value.
ScopeConfiguration (dict) -- [REQUIRED]
The configuration that specifies what scope to apply to a FilterGroup .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
SelectedSheets (dict) --
The configuration for applying a filter to specific sheets.
SheetVisualScopingConfigurations (list) --
The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.
(dict) --
The filter that is applied to the options.
SheetId (string) -- [REQUIRED]
The selected sheet that the filter is applied to.
Scope (string) -- [REQUIRED]
The scope of the applied entities. Choose one of the following options:
ALL_VISUALS
SELECTED_VISUALS
VisualIds (list) --
The selected visuals that the filter is applied to.
(string) --
AllSheets (dict) --
The configuration for applying a filter to all sheets.
Status (string) --
The status of the FilterGroup .
CrossDataset (string) -- [REQUIRED]
The filter new feature which can apply filter group to all data sets. Choose one of the following options:
ALL_DATASETS
SINGLE_DATASET
ColumnConfigurations (list) --
An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.
(dict) --
The general configuration of a column.
Column (dict) -- [REQUIRED]
The column.
DataSetIdentifier (string) -- [REQUIRED]
The data set that the column belongs to.
ColumnName (string) -- [REQUIRED]
The name of the column.
FormatConfiguration (dict) --
The format configuration of a column.
StringFormatConfiguration (dict) --
Formatting configuration for string fields.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumberFormatConfiguration (dict) --
Formatting configuration for number fields.
FormatConfiguration (dict) --
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
DateTimeFormatConfiguration (dict) --
Formatting configuration for DateTime fields.
DateTimeFormat (string) --
Determines the DateTime format.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
NumericFormatConfiguration (dict) --
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration (dict) --
The options that determine the number display format configuration.
Prefix (string) --
Determines the prefix value of the number format.
Suffix (string) --
Determines the suffix value of the number format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value of the number format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
CurrencyDisplayFormatConfiguration (dict) --
The options that determine the currency display format configuration.
Prefix (string) --
Determines the prefix value of the currency format.
Suffix (string) --
Determines the suffix value of the currency format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
Symbol (string) --
Determines the symbol for the currency format.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NumberScale (string) --
Determines the number scale value for the currency format.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
PercentageDisplayFormatConfiguration (dict) --
The options that determine the percentage display format configuration.
Prefix (string) --
Determines the prefix value of the percentage format.
Suffix (string) --
Determines the suffix value of the percentage format.
SeparatorConfiguration (dict) --
The options that determine the numeric separator configuration.
DecimalSeparator (string) --
Determines the decimal separator.
ThousandsSeparator (dict) --
The options that determine the thousands separator configuration.
Symbol (string) --
Determines the thousands separator symbol.
Visibility (string) --
Determines the visibility of the thousands separator.
DecimalPlacesConfiguration (dict) --
The option that determines the decimal places configuration.
DecimalPlaces (integer) -- [REQUIRED]
The values of the decimal places.
NegativeValueConfiguration (dict) --
The options that determine the negative value configuration.
DisplayMode (string) -- [REQUIRED]
Determines the display mode of the negative value configuration.
NullValueFormatConfiguration (dict) --
The options that determine the null value format configuration.
NullString (string) -- [REQUIRED]
Determines the null string of null values.
Role (string) --
The role of the column.
ColorsConfiguration (dict) --
The color configurations of the column.
CustomColors (list) --
A list of up to 50 custom colors.
(dict) --
Determines the color that's applied to a particular data value in a column.
FieldValue (string) --
The data value that the color is applied to.
Color (string) -- [REQUIRED]
The color that is applied to the data value.
SpecialValue (string) --
The value of a special data value.
AnalysisDefaults (dict) --
The configuration for default analysis settings.
DefaultNewSheetConfiguration (dict) -- [REQUIRED]
The configuration for default new sheet settings.
InteractiveLayoutConfiguration (dict) --
The options that determine the default settings for interactive layout configuration.
Grid (dict) --
The options that determine the default settings for a grid layout configuration.
CanvasSizeOptions (dict) -- [REQUIRED]
Determines the screen canvas size options for a grid layout.
ScreenCanvasSizeOptions (dict) --
The options that determine the sizing of the canvas used in a grid layout.
ResizeOption (string) -- [REQUIRED]
This value determines the layout behavior when the viewport is resized.
FIXED : A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic .
RESPONSIVE : The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled .
OptimizedViewPortWidth (string) --
The width that the view port will be optimized for when the layout renders.
FreeForm (dict) --
The options that determine the default settings of a free-form layout configuration.
CanvasSizeOptions (dict) -- [REQUIRED]
Determines the screen canvas size options for a free-form layout.
ScreenCanvasSizeOptions (dict) --
The options that determine the sizing of the canvas used in a free-form layout.
OptimizedViewPortWidth (string) -- [REQUIRED]
The width that the view port will be optimized for when the layout renders.
PaginatedLayoutConfiguration (dict) --
The options that determine the default settings for a paginated layout configuration.
SectionBased (dict) --
The options that determine the default settings for a section-based layout configuration.
CanvasSizeOptions (dict) -- [REQUIRED]
Determines the screen canvas size options for a section-based layout.
PaperCanvasSizeOptions (dict) --
The options for a paper canvas of a section-based layout.
PaperSize (string) --
The paper size that is used to define canvas dimensions.
PaperOrientation (string) --
The paper orientation that is used to define canvas dimensions. Choose one of the following options:
PORTRAIT
LANDSCAPE
PaperMargin (dict) --
Defines the spacing between the canvas content and the top, bottom, left, and right edges.
Top (string) --
Define the top spacing.
Bottom (string) --
Define the bottom spacing.
Left (string) --
Define the left spacing.
Right (string) --
Define the right spacing.
SheetContentType (string) --
The option that determines the sheet content type.
Options (dict) --
An array of option definitions for a dashboard.
Timezone (string) --
Determines the timezone for the analysis.
WeekStart (string) --
Determines the week start day for an analysis.
dict
The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.
Mode (string) -- [REQUIRED]
The mode of validation for the asset to be created or updated. When you set this value to STRICT , strict validation for every error is enforced. When you set this value to LENIENT , validation is skipped for specific UI errors.
list
When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
(string) --
dict
A structure that contains the permissions of a shareable link to the dashboard.
Permissions (list) --
A structure that contains the permissions of a shareable link.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the dashboard.
VersionArn (string) --
The ARN of the dashboard, including the version number of the first version that is created.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The status of the dashboard creation request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}}}},
'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}},
'Type': {'BIGQUERY', 'STARBURST', 'TRINO'}}
Creates a data source.
See also: AWS API Documentation
Request Syntax
client.create_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
Type='ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FolderArns=[
'string',
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
string
[REQUIRED]
The type of the data source. To return a list of all data sources, use ListDataSources .
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
dict
The parameters that Amazon QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials .
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
dict
The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see `` CredentialPair `` .
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials .
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
list
A list of resource permissions on the data source.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
list
When you create the data source, Amazon QuickSight adds the data source to these folders.
(string) --
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
CreationStatus (string) --
The status of creating the data source.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'IncludePermissions': 'boolean',
'IncludeTags': 'boolean',
'ValidationStrategy': {'StrictModeForAllResources': 'boolean'},
'Warnings': [{'Arn': 'string', 'Message': 'string'}]}
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.
Job descriptions are available for 14 days after the job starts.
See also: AWS API Documentation
Request Syntax
client.describe_asset_bundle_export_job(
AwsAccountId='string',
AssetBundleExportJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account the export job is executed in.
string
[REQUIRED]
The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.
dict
Response Syntax
{
'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
'DownloadUrl': 'string',
'Errors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AssetBundleExportJobId': 'string',
'AwsAccountId': 'string',
'ResourceArns': [
'string',
],
'IncludeAllDependencies': True|False,
'ExportFormat': 'CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON',
'CloudFormationOverridePropertyConfiguration': {
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': True|False
},
'VPCConnections': [
{
'Arn': 'string',
'Properties': [
'Name'|'DnsResolvers'|'RoleArn',
]
},
],
'RefreshSchedules': [
{
'Arn': 'string',
'Properties': [
'StartAfterDateTime',
]
},
],
'DataSources': [
{
'Arn': 'string',
'Properties': [
'Name'|'DisableSsl'|'SecretArn'|'Username'|'Password'|'Domain'|'WorkGroup'|'Host'|'Port'|'Database'|'DataSetName'|'Catalog'|'InstanceId'|'ClusterId'|'ManifestFileLocation'|'Warehouse'|'RoleArn',
]
},
],
'DataSets': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Themes': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Analyses': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Dashboards': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
]
},
'RequestId': 'string',
'Status': 123,
'IncludePermissions': True|False,
'IncludeTags': True|False,
'ValidationStrategy': {
'StrictModeForAllResources': True|False
},
'Warnings': [
{
'Arn': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
JobStatus (string) --
Indicates the status of a job through its queuing and execution.
Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED .
DownloadUrl (string) --
The URL to download the exported asset bundle data from.
This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.
The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs . The file has a .qs extension.
This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.
Errors (list) --
An array of error records that describes any failures that occurred during the export job processing.
Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred during an Asset Bundle export job.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type of the error that occurred.
Message (string) --
A description of the error.
Arn (string) --
The Amazon Resource Name (ARN) for the export job.
CreatedTime (datetime) --
The time that the export job was created.
AssetBundleExportJobId (string) --
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.
AwsAccountId (string) --
The ID of the Amazon Web Services account that the export job was executed in.
ResourceArns (list) --
A list of resource ARNs that exported with the job.
(string) --
IncludeAllDependencies (boolean) --
The include dependencies flag.
ExportFormat (string) --
The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.
CloudFormationOverridePropertyConfiguration (dict) --
The CloudFormation override property configuration for the export job.
ResourceIdOverrideConfiguration (dict) --
An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.
PrefixForAllResources (boolean) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.
Arn (string) --
The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
Properties (list) --
A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.
(string) --
RefreshSchedules (list) --
An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
Properties (list) --
A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSources (list) --
An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific DataSource resource whose override properties are configured in this structure.
Properties (list) --
A list of DataSource resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSets (list) --
An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific DataSet resource whose override properties are configured in this structure.
Properties (list) --
A list of DataSet resource properties to generate variables for in the returned CloudFormation template.
(string) --
Themes (list) --
An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Theme resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific Theme resource whose override properties are configured in this structure.
Properties (list) --
A list of Theme resource properties to generate variables for in the returned CloudFormation template.
(string) --
Analyses (list) --
An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific Analysis resource whose override properties are configured in this structure.
Properties (list) --
A list of Analysis resource properties to generate variables for in the returned CloudFormation template.
(string) --
Dashboards (list) --
An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific Dashboard resource whose override properties are configured in this structure.
Properties (list) --
A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.
(string) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the response.
IncludePermissions (boolean) --
The include permissions flag.
IncludeTags (boolean) --
The include tags flag.
ValidationStrategy (dict) --
The validation strategy that is used to export the analysis or dashboard.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to export resources under strict or lenient mode.
Warnings (list) --
An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.
This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE .
(dict) --
Describes a warning that occurred during an Asset Bundle export job.
Arn (string) --
The ARN of the resource whose processing caused a warning.
Message (string) --
A description of the warning.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}}}},
'OverridePermissions': {'Analyses': [{'AnalysisIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'Dashboards': [{'DashboardIds': ['string'],
'LinkSharingConfiguration': {'Permissions': {'Actions': ['string'],
'Principals': ['string']}},
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'DataSets': [{'DataSetIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'DataSources': [{'DataSourceIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'Themes': [{'Permissions': {'Actions': ['string'],
'Principals': ['string']},
'ThemeIds': ['string']}]},
'OverrideTags': {'Analyses': [{'AnalysisIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'Dashboards': [{'DashboardIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'DataSets': [{'DataSetIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'DataSources': [{'DataSourceIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'Themes': [{'Tags': [{'Key': 'string', 'Value': 'string'}],
'ThemeIds': ['string']}],
'VPCConnections': [{'Tags': [{'Key': 'string',
'Value': 'string'}],
'VPCConnectionIds': ['string']}]},
'OverrideValidationStrategy': {'StrictModeForAllResources': 'boolean'}}
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
See also: AWS API Documentation
Request Syntax
client.describe_asset_bundle_import_job(
AwsAccountId='string',
AssetBundleImportJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account the import job was executed in.
string
[REQUIRED]
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
dict
Response Syntax
{
'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'FAILED_ROLLBACK_IN_PROGRESS'|'FAILED_ROLLBACK_COMPLETED'|'FAILED_ROLLBACK_ERROR',
'Errors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'RollbackErrors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AssetBundleImportJobId': 'string',
'AwsAccountId': 'string',
'AssetBundleImportSource': {
'Body': 'string',
'S3Uri': 'string'
},
'OverrideParameters': {
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': 'string'
},
'VPCConnections': [
{
'VPCConnectionId': 'string',
'Name': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'DnsResolvers': [
'string',
],
'RoleArn': 'string'
},
],
'RefreshSchedules': [
{
'DataSetId': 'string',
'ScheduleId': 'string',
'StartAfterDateTime': datetime(2015, 1, 1)
},
],
'DataSources': [
{
'DataSourceId': 'string',
'Name': 'string',
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string'
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
]
},
'FailureAction': 'DO_NOTHING'|'ROLLBACK',
'RequestId': 'string',
'Status': 123,
'OverridePermissions': {
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
},
'LinkSharingConfiguration': {
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
}
},
]
},
'OverrideTags': {
'VPCConnections': [
{
'VPCConnectionIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
'OverrideValidationStrategy': {
'StrictModeForAllResources': True|False
}
}
Response Structure
(dict) --
JobStatus (string) --
Indicates the status of a job through its queuing and execution.
Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:
SUCCESSFUL
FAILED
FAILED_ROLLBACK_COMPLETED
FAILED_ROLLBACK_ERROR
Errors (list) --
An array of error records that describes any failures that occurred during the export job processing.
Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred within an Asset Bundle import execution.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type or the error that occurred.
Message (string) --
A description of the error.
RollbackErrors (list) --
An array of error records that describes any failures that occurred while an import job was attempting a rollback.
Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred within an Asset Bundle import execution.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type or the error that occurred.
Message (string) --
A description of the error.
Arn (string) --
The Amazon Resource Name (ARN) for the import job.
CreatedTime (datetime) --
The time that the import job was created.
AssetBundleImportJobId (string) --
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
AwsAccountId (string) --
The ID of the Amazon Web Services account the import job was executed in.
AssetBundleImportSource (dict) --
The source of the asset bundle zip file that contains the data that is imported by the job.
Body (string) --
An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.
S3Uri (string) --
The Amazon S3 URI that you provided at the start of the import job.
OverrideParameters (dict) --
Optional overrides that are applied to the resource configuration before import.
ResourceIdOverrideConfiguration (dict) --
An optional structure that configures resource ID overrides to be applied within the import job.
PrefixForAllResources (string) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single VPC connection that is imported.
VPCConnectionId (string) --
The ID of the VPC Connection to apply overrides to.
Name (string) --
A new name for the VPC connection.
SubnetIds (list) --
A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
SecurityGroupIds (list) --
A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
DnsResolvers (list) --
An optional override of DNS resolvers to be used by the VPC connection.
(string) --
RoleArn (string) --
An optional override of the role ARN to be used by the VPC connection.
RefreshSchedules (list) --
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
(dict) --
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
DataSetId (string) --
A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
ScheduleId (string) --
A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
StartAfterDateTime (datetime) --
An override for the StartAfterDateTime of a RefreshSchedule . Make sure that the StartAfterDateTime is set to a time that takes place in the future.
DataSources (list) --
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single data source that is being imported.
DataSourceId (string) --
The ID of the data source to apply overrides to.
Name (string) --
A new name for the data source.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials .
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
VpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
Credentials (dict) --
An optional structure that provides the credentials to be used to create the imported data source.
CredentialPair (dict) --
A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
Username (string) --
The username for the data source connection.
Password (string) --
The password for the data source connection.
SecretArn (string) --
The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
DataSets (list) --
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dataset that is being imported.
DataSetId (string) --
The ID of the dataset to apply overrides to.
Name (string) --
A new name for the dataset.
Themes (list) --
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single theme that is imported.
ThemeId (string) --
The ID of the theme to apply overrides to.
Name (string) --
A new name for the theme.
Analyses (list) --
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single analysis that is being imported.
AnalysisId (string) --
The ID of the analysis that you ant to apply overrides to.
Name (string) --
A new name for the analysis.
Dashboards (list) --
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dashboard that is being imported.
DashboardId (string) --
The ID of the dashboard that you want to apply overrides to.
Name (string) --
A new name for the dashboard.
FailureAction (string) --
The failure action for the import job.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the response.
OverridePermissions (dict) --
Optional permission overrides that are applied to the resource configuration before import.
DataSources (list) --
A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of data source IDs.
DataSourceIds (list) --
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the data source that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
DataSets (list) --
A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dataset IDs.
DataSetIds (list) --
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the datasets that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Themes (list) --
A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of theme IDs.
ThemeIds (list) --
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the themes that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Analyses (list) --
A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of analysis IDs.
AnalysisIds (list) --
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the analyses that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Dashboards (list) --
A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dashboard IDs.
DashboardIds (list) --
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the dashboards that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
LinkSharingConfiguration (dict) --
A structure that contains the link sharing configurations that you want to apply overrides to.
Permissions (dict) --
A list of link sharing permissions for the dashboards that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
OverrideTags (dict) --
Optional tag overrides that are applied to the resource configuration before import.
VPCConnections (list) --
A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
VPCConnectionIds (list) --
A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
(string) --
Tags (list) --
A list of tags for the VPC connections that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
DataSources (list) --
A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of data source IDs.
DataSourceIds (list) --
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Tags (list) --
A list of tags for the data source that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
DataSets (list) --
A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dataset IDs.
DataSetIds (list) --
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Tags (list) --
A list of tags for the datasets that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Themes (list) --
A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of theme IDs.
ThemeIds (list) --
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Tags (list) --
A list of tags for the themes that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Analyses (list) --
A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of analysis IDs.
AnalysisIds (list) --
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Tags (list) --
A list of tags for the analyses that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Dashboards (list) --
A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dashboard IDs.
DashboardIds (list) --
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Tags (list) --
A list of tags for the dashboards that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
OverrideValidationStrategy (dict) --
An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
{'DataSource': {'AlternateDataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}},
'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}},
'Type': {'BIGQUERY', 'STARBURST', 'TRINO'}}}
Describes a data source.
See also: AWS API Documentation
Request Syntax
client.describe_data_source(
AwsAccountId='string',
DataSourceId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
Response Syntax
{
'DataSource': {
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
],
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'ErrorInfo': {
'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
'Message': 'string'
},
'SecretArn': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSource (dict) --
The information on the data source.
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials .
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials .
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'AssetBundleExportJobSummaryList': {'IncludePermissions': 'boolean',
'IncludeTags': 'boolean'}}
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
See also: AWS API Documentation
Request Syntax
client.list_asset_bundle_export_jobs(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account that the export jobs were executed in.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'AssetBundleExportJobSummaryList': [
{
'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AssetBundleExportJobId': 'string',
'IncludeAllDependencies': True|False,
'ExportFormat': 'CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON',
'IncludePermissions': True|False,
'IncludeTags': True|False
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
AssetBundleExportJobSummaryList (list) --
A list of export job summaries.
(dict) --
A summary of the export job that includes details of the job's configuration and its current status.
JobStatus (string) --
The current status of the export job.
Arn (string) --
The ARN of the export job.
CreatedTime (datetime) --
The time that the export job was created.
AssetBundleExportJobId (string) --
The ID of the export job.
IncludeAllDependencies (boolean) --
The flag that determines the inclusion of resource dependencies in the returned asset bundle.
ExportFormat (string) --
The format for the export job.
IncludePermissions (boolean) --
The flag that determines the inclusion of permissions associated with each resource ARN.
IncludeTags (boolean) --
The flag that determines the inclusion of tags associated with each resource ARN.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSources': {'AlternateDataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}},
'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}},
'Type': {'BIGQUERY', 'STARBURST', 'TRINO'}}}
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_data_sources(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSources': [
{
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
],
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'ErrorInfo': {
'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
'Message': 'string'
},
'SecretArn': 'string'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSources (list) --
A list of data sources.
(dict) --
The structure of a data source.
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials .
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials .
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSourceSummaries': {'Type': {'BIGQUERY', 'STARBURST', 'TRINO'}}}
Use the SearchDataSources operation to search for data sources that belong to an account.
See also: AWS API Documentation
Request Syntax
client.search_data_sources(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASOURCE_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
list
[REQUIRED]
The filters to apply to the search.
(dict) --
A filter that you apply when searching for data sources.
Operator (string) -- [REQUIRED]
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
If you set the operator value to "StringEquals" , you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
If you set the value to "StringLike" , you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test" . The "StringLike" operator only supports the NAME value DATASOURCE_NAME .
Name (string) -- [REQUIRED]
The name of the value that you want to use as a filter, for example, "Name": "DIRECT_QUICKSIGHT_OWNER" .
Valid values are defined as follows:
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.
DATASOURCE_NAME : Any data sources whose names have a substring match to the provided value are returned.
Value (string) -- [REQUIRED]
The value of the named item, for example DIRECT_QUICKSIGHT_OWNER , that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSourceSummaries': [
{
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
DataSourceSummaries (list) --
A DataSourceSummaries object that returns a summary of a data source.
(dict) --
A DataSourceSummary object that returns a summary of a data source.
Arn (string) --
The arn of the datasource.
DataSourceId (string) --
The unique ID of the data source.
Name (string) --
The name of the data source.
Type (string) --
The type of the data source.
CreatedTime (datetime) --
The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.
LastUpdatedTime (datetime) --
The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'IncludePermissions': 'boolean',
'IncludeTags': 'boolean',
'ValidationStrategy': {'StrictModeForAllResources': 'boolean'}}
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
See also: AWS API Documentation
Request Syntax
client.start_asset_bundle_export_job(
AwsAccountId='string',
AssetBundleExportJobId='string',
ResourceArns=[
'string',
],
IncludeAllDependencies=True|False,
ExportFormat='CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON',
CloudFormationOverridePropertyConfiguration={
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': True|False
},
'VPCConnections': [
{
'Arn': 'string',
'Properties': [
'Name'|'DnsResolvers'|'RoleArn',
]
},
],
'RefreshSchedules': [
{
'Arn': 'string',
'Properties': [
'StartAfterDateTime',
]
},
],
'DataSources': [
{
'Arn': 'string',
'Properties': [
'Name'|'DisableSsl'|'SecretArn'|'Username'|'Password'|'Domain'|'WorkGroup'|'Host'|'Port'|'Database'|'DataSetName'|'Catalog'|'InstanceId'|'ClusterId'|'ManifestFileLocation'|'Warehouse'|'RoleArn',
]
},
],
'DataSets': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Themes': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Analyses': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Dashboards': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
]
},
IncludePermissions=True|False,
IncludeTags=True|False,
ValidationStrategy={
'StrictModeForAllResources': True|False
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account to export assets from.
string
[REQUIRED]
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
list
[REQUIRED]
An array of resource ARNs to export. The following resources are supported.
Analysis
Dashboard
DataSet
DataSource
RefreshSchedule
Theme
VPCConnection
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
(string) --
boolean
A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE , any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.
string
[REQUIRED]
The export data format.
dict
An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.
Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON .
ResourceIdOverrideConfiguration (dict) --
An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.
PrefixForAllResources (boolean) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.
(string) --
RefreshSchedules (list) --
An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSources (list) --
An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific DataSource resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of DataSource resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSets (list) --
An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific DataSet resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of DataSet resource properties to generate variables for in the returned CloudFormation template.
(string) --
Themes (list) --
An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Theme resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific Theme resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of Theme resource properties to generate variables for in the returned CloudFormation template.
(string) --
Analyses (list) --
An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific Analysis resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of Analysis resource properties to generate variables for in the returned CloudFormation template.
(string) --
Dashboards (list) --
An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific Dashboard resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.
(string) --
boolean
A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE , any permissions associated with each resource are exported.
boolean
A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE , any tags associated with each resource are exported.
dict
An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE , strict validation for every error is enforced. If it is set to FALSE , validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE .
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to export resources under strict or lenient mode.
dict
Response Syntax
{
'Arn': 'string',
'AssetBundleExportJobId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the export job.
AssetBundleExportJobId (string) --
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
RequestId (string) --
The Amazon Web Services response ID for this operation.
Status (integer) --
The HTTP status of the response.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}}}},
'OverridePermissions': {'Analyses': [{'AnalysisIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'Dashboards': [{'DashboardIds': ['string'],
'LinkSharingConfiguration': {'Permissions': {'Actions': ['string'],
'Principals': ['string']}},
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'DataSets': [{'DataSetIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'DataSources': [{'DataSourceIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'Themes': [{'Permissions': {'Actions': ['string'],
'Principals': ['string']},
'ThemeIds': ['string']}]},
'OverrideTags': {'Analyses': [{'AnalysisIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'Dashboards': [{'DashboardIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'DataSets': [{'DataSetIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'DataSources': [{'DataSourceIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'Themes': [{'Tags': [{'Key': 'string', 'Value': 'string'}],
'ThemeIds': ['string']}],
'VPCConnections': [{'Tags': [{'Key': 'string',
'Value': 'string'}],
'VPCConnectionIds': ['string']}]},
'OverrideValidationStrategy': {'StrictModeForAllResources': 'boolean'}}
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary "create" , "describe" , and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
See also: AWS API Documentation
Request Syntax
client.start_asset_bundle_import_job(
AwsAccountId='string',
AssetBundleImportJobId='string',
AssetBundleImportSource={
'Body': b'bytes',
'S3Uri': 'string'
},
OverrideParameters={
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': 'string'
},
'VPCConnections': [
{
'VPCConnectionId': 'string',
'Name': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'DnsResolvers': [
'string',
],
'RoleArn': 'string'
},
],
'RefreshSchedules': [
{
'DataSetId': 'string',
'ScheduleId': 'string',
'StartAfterDateTime': datetime(2015, 1, 1)
},
],
'DataSources': [
{
'DataSourceId': 'string',
'Name': 'string',
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string'
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
]
},
FailureAction='DO_NOTHING'|'ROLLBACK',
OverridePermissions={
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
},
'LinkSharingConfiguration': {
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
}
},
]
},
OverrideTags={
'VPCConnections': [
{
'VPCConnectionIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
OverrideValidationStrategy={
'StrictModeForAllResources': True|False
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account to import assets into.
string
[REQUIRED]
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
dict
[REQUIRED]
The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.
Body (bytes) --
The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.
S3Uri (string) --
The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 20 MB.
dict
Optional overrides that are applied to the resource configuration before import.
ResourceIdOverrideConfiguration (dict) --
An optional structure that configures resource ID overrides to be applied within the import job.
PrefixForAllResources (string) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single VPC connection that is imported.
VPCConnectionId (string) -- [REQUIRED]
The ID of the VPC Connection to apply overrides to.
Name (string) --
A new name for the VPC connection.
SubnetIds (list) --
A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
SecurityGroupIds (list) --
A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
DnsResolvers (list) --
An optional override of DNS resolvers to be used by the VPC connection.
(string) --
RoleArn (string) --
An optional override of the role ARN to be used by the VPC connection.
RefreshSchedules (list) --
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
(dict) --
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
DataSetId (string) -- [REQUIRED]
A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
ScheduleId (string) -- [REQUIRED]
A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
StartAfterDateTime (datetime) --
An override for the StartAfterDateTime of a RefreshSchedule . Make sure that the StartAfterDateTime is set to a time that takes place in the future.
DataSources (list) --
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single data source that is being imported.
DataSourceId (string) -- [REQUIRED]
The ID of the data source to apply overrides to.
Name (string) --
A new name for the data source.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials .
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
VpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
Credentials (dict) --
An optional structure that provides the credentials to be used to create the imported data source.
CredentialPair (dict) --
A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
Username (string) -- [REQUIRED]
The username for the data source connection.
Password (string) -- [REQUIRED]
The password for the data source connection.
SecretArn (string) --
The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
DataSets (list) --
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dataset that is being imported.
DataSetId (string) -- [REQUIRED]
The ID of the dataset to apply overrides to.
Name (string) --
A new name for the dataset.
Themes (list) --
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single theme that is imported.
ThemeId (string) -- [REQUIRED]
The ID of the theme to apply overrides to.
Name (string) --
A new name for the theme.
Analyses (list) --
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single analysis that is being imported.
AnalysisId (string) -- [REQUIRED]
The ID of the analysis that you ant to apply overrides to.
Name (string) --
A new name for the analysis.
Dashboards (list) --
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dashboard that is being imported.
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that you want to apply overrides to.
Name (string) --
A new name for the dashboard.
string
The failure action for the import job.
If you choose ROLLBACK , failed import jobs will attempt to undo any asset changes caused by the failed job.
If you choose DO_NOTHING , failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.
dict
Optional permission overrides that are applied to the resource configuration before import.
DataSources (list) --
A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of data source IDs.
DataSourceIds (list) -- [REQUIRED]
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the data source that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
DataSets (list) --
A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dataset IDs.
DataSetIds (list) -- [REQUIRED]
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the datasets that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Themes (list) --
A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of theme IDs.
ThemeIds (list) -- [REQUIRED]
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the themes that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Analyses (list) --
A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of analysis IDs.
AnalysisIds (list) -- [REQUIRED]
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the analyses that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Dashboards (list) --
A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dashboard IDs.
DashboardIds (list) -- [REQUIRED]
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the dashboards that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
LinkSharingConfiguration (dict) --
A structure that contains the link sharing configurations that you want to apply overrides to.
Permissions (dict) --
A list of link sharing permissions for the dashboards that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
dict
Optional tag overrides that are applied to the resource configuration before import.
VPCConnections (list) --
A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
VPCConnectionIds (list) -- [REQUIRED]
A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the VPC connections that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
DataSources (list) --
A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of data source IDs.
DataSourceIds (list) -- [REQUIRED]
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the data source that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
DataSets (list) --
A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dataset IDs.
DataSetIds (list) -- [REQUIRED]
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the datasets that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Themes (list) --
A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of theme IDs.
ThemeIds (list) -- [REQUIRED]
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the themes that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Analyses (list) --
A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of analysis IDs.
AnalysisIds (list) -- [REQUIRED]
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the analyses that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Dashboards (list) --
A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dashboard IDs.
DashboardIds (list) -- [REQUIRED]
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the dashboards that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
dict
Response Syntax
{
'Arn': 'string',
'AssetBundleImportJobId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the import job.
AssetBundleImportJobId (string) --
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
RequestId (string) --
The Amazon Web Services response ID for this operation.
Status (integer) --
The HTTP status of the response.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}}}},
'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}}}
Updates a data source.
See also: AWS API Documentation
Request Syntax
client.update_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
}
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
dict
The parameters that Amazon QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials .
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
dict
The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see `` CredentialPair `` .
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials .
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
dict
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
UpdateStatus (string) --
The update status of the data source's last update.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.