[ aws . quicksight ]
describe-dashboard-definition
Description
Provides a detailed description of the definition of a dashboard.
Note
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the `DescribeDashboard https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html`__ instead.See also: AWS API Documentation
Synopsis
describe-dashboard-definition
--aws-account-id <value>
--dashboard-id <value>
[--version-number <value>]
[--alias-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options
--aws-account-id (string)
--dashboard-id (string)
--version-number (long)
--alias-name (string)
--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output
DashboardId -> (string)
Errors -> (list)
Errors associated with this dashboard version.
(structure)
Dashboard error.
Type -> (string)
Message -> (string)
ViolatedEntities -> (list)
Lists the violated entities that caused the dashboard error.
(structure)
An object, structure, or sub-structure of an analysis, template, or dashboard.
Path -> (string)
Name -> (string)
ResourceStatus -> (string)
Status associated with the dashboard version.
CREATION_IN_PROGRESSCREATION_SUCCESSFULCREATION_FAILEDUPDATE_IN_PROGRESSUPDATE_SUCCESSFULUPDATE_FAILEDDELETED
ThemeArn -> (string)
Definition -> (structure)
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
DataSetIdentifierDeclarations -> (list)
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.
(structure)
A data set.
Identifier -> (string)
DataSetArn -> (string)
Sheets -> (list)
An array of sheet definitions for a dashboard.
(structure)
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)
Title -> (string)
Description -> (string)
Name -> (string)
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 .
(structure)
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 -> (structure)
A control from a date parameter that specifies date and time.
ParameterControlId -> (string)
ParameterDateTimePickerControl .Title -> (string)
ParameterDateTimePickerControl .SourceParameterName -> (string)
ParameterDateTimePickerControl .DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
HelperTextVisibility -> (string)
DateTimePickerControlDisplayOptions .DateIconVisibility -> (string)
DateTimePickerControlDisplayOptions .List -> (structure)
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
ParameterControlId -> (string)
ParameterListControl .Title -> (string)
ParameterListControl .SourceParameterName -> (string)
ParameterListControl .DisplayOptions -> (structure)
The display options of a control.
SearchOptions -> (structure)
The configuration of the search options in a list control.
Visibility -> (string)
SelectAllOptions -> (structure)
The configuration of the Select all options in a list control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
ParameterListControl .SelectableValues -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in ParameterSelectableValues .
(string)
LinkToDataSetColumn -> (structure)
The column identifier that fetches values from the data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
CascadingControlConfiguration -> (structure)
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.
(structure)
The source controls that are used in a CascadingControlConfiguration .
SourceSheetControlId -> (string)
CascadingControlSource .ColumnToMatch -> (structure)
The column identifier that determines which column to look up for the source sheet control.
DataSetIdentifier -> (string)
ColumnName -> (string)
Dropdown -> (structure)
A control to display a dropdown list with buttons that are used to select a single value.
ParameterControlId -> (string)
ParameterDropDownControl .Title -> (string)
ParameterDropDownControl .SourceParameterName -> (string)
ParameterDropDownControl .DisplayOptions -> (structure)
The display options of a control.
SelectAllOptions -> (structure)
The configuration of the Select all options in a dropdown control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
ParameterDropDownControl .SelectableValues -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in ParameterSelectableValues .
(string)
LinkToDataSetColumn -> (structure)
The column identifier that fetches values from the data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
CascadingControlConfiguration -> (structure)
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.
(structure)
The source controls that are used in a CascadingControlConfiguration .
SourceSheetControlId -> (string)
CascadingControlSource .ColumnToMatch -> (structure)
The column identifier that determines which column to look up for the source sheet control.
DataSetIdentifier -> (string)
ColumnName -> (string)
CommitMode -> (string)
ParameterDropDownControl .TextField -> (structure)
A control to display a text box that is used to enter a single entry.
ParameterControlId -> (string)
ParameterTextFieldControl .Title -> (string)
ParameterTextFieldControl .SourceParameterName -> (string)
ParameterTextFieldControl .DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text field control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
TextArea -> (structure)
A control to display a text box that is used to enter multiple entries.
ParameterControlId -> (string)
ParameterTextAreaControl .Title -> (string)
ParameterTextAreaControl .SourceParameterName -> (string)
ParameterTextAreaControl .Delimiter -> (string)
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text area control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Slider -> (structure)
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
ParameterControlId -> (string)
ParameterSliderControl .Title -> (string)
ParameterSliderControl .SourceParameterName -> (string)
ParameterSliderControl .DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
MaximumValue -> (double)
MinimumValue -> (double)
StepSize -> (double)
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 .
(structure)
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 -> (structure)
A control from a date filter that is used to specify date and time.
FilterControlId -> (string)
FilterDateTimePickerControl .Title -> (string)
FilterDateTimePickerControl .SourceFilterId -> (string)
FilterDateTimePickerControl .DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
HelperTextVisibility -> (string)
DateTimePickerControlDisplayOptions .DateIconVisibility -> (string)
DateTimePickerControlDisplayOptions .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.
CommitMode -> (string)
DateTimePickerControl .List -> (structure)
A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.
FilterControlId -> (string)
FilterListControl .Title -> (string)
FilterListControl .SourceFilterId -> (string)
FilterListControl .DisplayOptions -> (structure)
The display options of a control.
SearchOptions -> (structure)
The configuration of the search options in a list control.
Visibility -> (string)
SelectAllOptions -> (structure)
The configuration of the Select all options in a list control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the 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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
CascadingControlConfiguration -> (structure)
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.
(structure)
The source controls that are used in a CascadingControlConfiguration .
SourceSheetControlId -> (string)
CascadingControlSource .ColumnToMatch -> (structure)
The column identifier that determines which column to look up for the source sheet control.
DataSetIdentifier -> (string)
ColumnName -> (string)
Dropdown -> (structure)
A control to display a dropdown list with buttons that are used to select a single value.
FilterControlId -> (string)
FilterDropDownControl .Title -> (string)
FilterDropDownControl .SourceFilterId -> (string)
FilterDropDownControl .DisplayOptions -> (structure)
The display options of the FilterDropDownControl .
SelectAllOptions -> (structure)
The configuration of the Select all options in a dropdown control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
CascadingControlConfiguration -> (structure)
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.
(structure)
The source controls that are used in a CascadingControlConfiguration .
SourceSheetControlId -> (string)
CascadingControlSource .ColumnToMatch -> (structure)
The column identifier that determines which column to look up for the source sheet control.
DataSetIdentifier -> (string)
ColumnName -> (string)
CommitMode -> (string)
FilterDropDownControl .TextField -> (structure)
A control to display a text box that is used to enter a single entry.
FilterControlId -> (string)
FilterTextFieldControl .Title -> (string)
FilterTextFieldControl .SourceFilterId -> (string)
FilterTextFieldControl .DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text field control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
TextArea -> (structure)
A control to display a text box that is used to enter multiple entries.
FilterControlId -> (string)
FilterTextAreaControl .Title -> (string)
FilterTextAreaControl .SourceFilterId -> (string)
FilterTextAreaControl .Delimiter -> (string)
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text area control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Slider -> (structure)
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
FilterControlId -> (string)
FilterSliderControl .Title -> (string)
FilterSliderControl .SourceFilterId -> (string)
FilterSliderControl .DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the 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 -> (double)
MinimumValue -> (double)
StepSize -> (double)
RelativeDateTime -> (structure)
A control from a date filter that is used to specify the relative date.
FilterControlId -> (string)
FilterTextAreaControl .Title -> (string)
FilterTextAreaControl .SourceFilterId -> (string)
FilterTextAreaControl .DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
CommitMode -> (string)
FilterRelativeDateTimeControl .CrossSheet -> (structure)
A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet
FilterControlId -> (string)
FilterCrossSheetControl .SourceFilterId -> (string)
FilterCrossSheetControl .CascadingControlConfiguration -> (structure)
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.
(structure)
The source controls that are used in a CascadingControlConfiguration .
SourceSheetControlId -> (string)
CascadingControlSource .ColumnToMatch -> (structure)
The column identifier that determines which column to look up for the source sheet control.
DataSetIdentifier -> (string)
ColumnName -> (string)
Visuals -> (list)
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
(structure)
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 -> (structure)
A table visual.
For more information, see Using tables as visuals in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field wells of the visual.
TableAggregatedFieldWells -> (structure)
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.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The values field well for a pivot table. Values are aggregated based on group by fields.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
TableUnaggregatedFieldWells -> (structure)
The unaggregated field well for the table.
Values -> (list)
The values field well for a pivot table. Values are unaggregated for an unaggregated table.
(structure)
The unaggregated field for a table.
FieldId -> (string)
Column -> (structure)
The column that is used in the UnaggregatedField .
DataSetIdentifier -> (string)
ColumnName -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
StringFormatConfiguration -> (structure)
Formatting configuration for string fields.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumberFormatConfiguration -> (structure)
Formatting configuration for number fields.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateTimeFormatConfiguration -> (structure)
Formatting configuration for DateTime fields.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
SortConfiguration -> (structure)
The sort configuration for a TableVisual .
RowSort -> (list)
The field sort options for rows in the table.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The pagination configuration (page size, page number) for the table.
PageSize -> (long)
PageNumber -> (long)
TableOptions -> (structure)
The table options for a table visual.
Orientation -> (string)
HeaderStyle -> (structure)
The table cell style of a table header.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
CellStyle -> (structure)
The table cell style of table cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
RowAlternateColorOptions -> (structure)
The row alternate color options (widget status, row alternate colors) for a table.
Status -> (string)
RowAlternateColors -> (list)
Determines the list of row alternate colors.
(string)
UsePrimaryBackgroundColor -> (string)
TotalOptions -> (structure)
The total options for a table visual.
TotalsVisibility -> (string)
Placement -> (string)
ScrollStatus -> (string)
CustomLabel -> (string)
TotalCellStyle -> (structure)
Cell styling options for the total cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
TotalAggregationOptions -> (list)
The total aggregation settings for each value field.
(structure)
The total aggregation settings map of a field id.
FieldId -> (string)
TotalAggregationFunction -> (structure)
The total aggregation function that you want to set for a specified field id.
SimpleTotalAggregationFunction -> (string)
FieldOptions -> (structure)
The field options for a table visual.
SelectedFieldOptions -> (list)
The field options to be configured to a table.
(structure)
The options for a table field.
FieldId -> (string)
Width -> (string)
CustomLabel -> (string)
Visibility -> (string)
URLStyling -> (structure)
The URL configuration for a table field.
LinkConfiguration -> (structure)
The link configuration of a table field URL.
Target -> (string)
Content -> (structure)
The URL content (text, icon) for the table link configuration.
CustomTextContent -> (structure)
The custom text content (value, font configuration) for the table link content configuration.
Value -> (string)
FontConfiguration -> (structure)
The font configuration of the custom text content for the table URL link content.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomIconContent -> (structure)
The custom icon content for the table link content configuration.
Icon -> (string)
ImageConfiguration -> (structure)
The image configuration of a table field URL.
SizingOptions -> (structure)
The sizing options for the table image configuration.
TableCellImageScalingConfiguration -> (string)
Order -> (list)
The order of the field IDs that are configured as field options for a table visual.
(string)
PinnedFieldOptions -> (structure)
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)
TransposedTableOptions -> (list)
The TableOptions of a transposed table.
(structure)
The column option of the transposed table.
ColumnIndex -> (integer)
ColumnWidth -> (string)
ColumnType -> (string)
The column type of the column in a transposed table. Choose one of the following options:
-
ROW_HEADER_COLUMN: Refers to the leftmost column of the row header in the transposed table. -
VALUE_COLUMN: Refers to all value columns in the transposed table.
PaginatedReportOptions -> (structure)
The paginated report options for a table visual.
VerticalOverflowVisibility -> (string)
OverflowColumnHeaderVisibility -> (string)
TableInlineVisualizations -> (list)
A collection of inline visualizations to display within a chart.
(structure)
The inline visualization of a specific type to display within a chart.
DataBars -> (structure)
The configuration of the inline visualization of the data bars within a chart.
FieldId -> (string)
PositiveColor -> (string)
NegativeColor -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.ConditionalFormatting -> (structure)
The conditional formatting for a PivotTableVisual .
ConditionalFormattingOptions -> (list)
Conditional formatting options for a PivotTableVisual .
(structure)
Conditional formatting options for a PivotTableVisual .
Cell -> (structure)
The cell conditional formatting option for a table.
FieldId -> (string)
TextFormat -> (structure)
The text format of the cell for conditional formatting.
BackgroundColor -> (structure)
The conditional formatting for the text background color.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
TextColor -> (structure)
The conditional formatting for the text color.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
Icon -> (structure)
The conditional formatting for the icon.
IconSet -> (structure)
Formatting configuration for icon set.
Expression -> (string)
IconSetType -> (string)
CustomCondition -> (structure)
Determines the custom condition for an icon set.
Expression -> (string)
IconOptions -> (structure)
Custom icon options for an icon set.
Icon -> (string)
UnicodeIcon -> (string)
Color -> (string)
DisplayConfiguration -> (structure)
Determines the icon display configuration.
IconDisplayOption -> (string)
Row -> (structure)
The row conditional formatting option for a table.
BackgroundColor -> (structure)
The conditional formatting color (solid, gradient) of the background for a table row.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
TextColor -> (structure)
The conditional formatting color (solid, gradient) of the text for a table row.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
VisualContentAltText -> (string)
PivotTableVisual -> (structure)
A pivot table.
For more information, see Using pivot tables in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field wells of the visual.
PivotTableAggregatedFieldWells -> (structure)
The aggregated field well for the pivot table.
Rows -> (list)
The rows field well for a pivot table. Values are grouped by rows fields.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Columns -> (list)
The columns field well for a pivot table. Values are grouped by columns fields.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The values field well for a pivot table. Values are aggregated based on rows and columns fields.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SortConfiguration -> (structure)
The sort configuration for a PivotTableVisual .
FieldSortOptions -> (list)
The field sort options for a pivot table sort configuration.
(structure)
The field sort options for a pivot table sort configuration.
FieldId -> (string)
SortBy -> (structure)
The sort by field for the field sort options.
Field -> (structure)
The field sort (field id, direction) for the pivot table sort by options.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
Column -> (structure)
The column sort (field id, direction) for the pivot table sort by options.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The data path sort (data path value, direction) for the pivot table sort by options.
Direction -> (string)
SortPaths -> (list)
The list of data paths that need to be sorted.
(structure)
The data path that needs to be sorted.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
TableOptions -> (structure)
The table options for a pivot table visual.
MetricPlacement -> (string)
SingleMetricVisibility -> (string)
ColumnNamesVisibility -> (string)
ToggleButtonsVisibility -> (string)
ColumnHeaderStyle -> (structure)
The table cell style of the column header.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
RowHeaderStyle -> (structure)
The table cell style of the row headers.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
CellStyle -> (structure)
The table cell style of cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
RowFieldNamesStyle -> (structure)
The table cell style of row field names.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
RowAlternateColorOptions -> (structure)
The row alternate color options (widget status, row alternate colors).
Status -> (string)
RowAlternateColors -> (list)
Determines the list of row alternate colors.
(string)
UsePrimaryBackgroundColor -> (string)
CollapsedRowDimensionsVisibility -> (string)
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 -> (structure)
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)
CustomLabel -> (string)
DefaultCellWidth -> (string)
TotalOptions -> (structure)
The total options for a pivot table visual.
RowSubtotalOptions -> (structure)
The row subtotal options.
TotalsVisibility -> (string)
CustomLabel -> (string)
FieldLevel -> (string)
FieldLevelOptions -> (list)
The optional configuration of subtotal cells.
(structure)
The optional configuration of subtotals cells.
FieldId -> (string)
TotalCellStyle -> (structure)
The cell styling options for the subtotal cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
ValueCellStyle -> (structure)
The cell styling options for the subtotals of value cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
MetricHeaderCellStyle -> (structure)
The cell styling options for the subtotals of header cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
StyleTargets -> (list)
The style targets options for subtotals.
(structure)
The table style target.
CellType -> (string)
ColumnSubtotalOptions -> (structure)
The column subtotal options.
TotalsVisibility -> (string)
CustomLabel -> (string)
FieldLevel -> (string)
FieldLevelOptions -> (list)
The optional configuration of subtotal cells.
(structure)
The optional configuration of subtotals cells.
FieldId -> (string)
TotalCellStyle -> (structure)
The cell styling options for the subtotal cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
ValueCellStyle -> (structure)
The cell styling options for the subtotals of value cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
MetricHeaderCellStyle -> (structure)
The cell styling options for the subtotals of header cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
StyleTargets -> (list)
The style targets options for subtotals.
(structure)
The table style target.
CellType -> (string)
RowTotalOptions -> (structure)
The row total options.
TotalsVisibility -> (string)
Placement -> (string)
ScrollStatus -> (string)
CustomLabel -> (string)
TotalCellStyle -> (structure)
The cell styling options for the total cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
ValueCellStyle -> (structure)
The cell styling options for the totals of value cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
MetricHeaderCellStyle -> (structure)
The cell styling options for the total of header cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
TotalAggregationOptions -> (list)
The total aggregation options for each value field.
(structure)
The total aggregation settings map of a field id.
FieldId -> (string)
TotalAggregationFunction -> (structure)
The total aggregation function that you want to set for a specified field id.
SimpleTotalAggregationFunction -> (string)
ColumnTotalOptions -> (structure)
The column total options.
TotalsVisibility -> (string)
Placement -> (string)
ScrollStatus -> (string)
CustomLabel -> (string)
TotalCellStyle -> (structure)
The cell styling options for the total cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
ValueCellStyle -> (structure)
The cell styling options for the totals of value cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
MetricHeaderCellStyle -> (structure)
The cell styling options for the total of header cells.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the table cells.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
TextWrap -> (string)
HorizontalTextAlignment -> (string)
VerticalTextAlignment -> (string)
BackgroundColor -> (string)
Height -> (integer)
Border -> (structure)
The borders for the table cells.
UniformBorder -> (structure)
Determines the options for uniform border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
SideSpecificBorder -> (structure)
Determines the options for side specific border.
InnerVertical -> (structure)
The table border options of the inner vertical border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
InnerHorizontal -> (structure)
The table border options of the inner horizontal border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Left -> (structure)
The table border options of the left border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Right -> (structure)
The table border options of the right border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Top -> (structure)
The table border options of the top border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
Bottom -> (structure)
The table border options of the bottom border.
Color -> (string)
Thickness -> (integer)
Style -> (string)
TotalAggregationOptions -> (list)
The total aggregation options for each value field.
(structure)
The total aggregation settings map of a field id.
FieldId -> (string)
TotalAggregationFunction -> (structure)
The total aggregation function that you want to set for a specified field id.
SimpleTotalAggregationFunction -> (string)
FieldOptions -> (structure)
The field options for a pivot table visual.
SelectedFieldOptions -> (list)
The selected field options for the pivot table field options.
(structure)
The selected field options for the pivot table field options.
FieldId -> (string)
CustomLabel -> (string)
Visibility -> (string)
DataPathOptions -> (list)
The data path options for the pivot table field options.
(structure)
The data path options for the pivot table field options.
DataPathList -> (list)
The list of data path values for the data path options.
(structure)
The data path that needs to be sorted.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Width -> (string)
CollapseStateOptions -> (list)
The collapse state options for the pivot table field options.
(structure)
The collapse state options for the pivot table field options.
Target -> (structure)
A tagged-union object that sets the collapse state.
FieldId -> (string)
FieldDataPathValues -> (list)
The data path of the pivot table’s header. Used to set the collapse state.
(structure)
The data path that needs to be sorted.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
State -> (string)
The state of the field target of a pivot table. Choose one of the following options:
COLLAPSEDEXPANDED
PaginatedReportOptions -> (structure)
The paginated report options for a pivot table visual.
VerticalOverflowVisibility -> (string)
OverflowColumnHeaderVisibility -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.ConditionalFormatting -> (structure)
The conditional formatting for a PivotTableVisual .
ConditionalFormattingOptions -> (list)
Conditional formatting options for a PivotTableVisual .
(structure)
Conditional formatting options for a PivotTableVisual .
Cell -> (structure)
The cell conditional formatting option for a pivot table.
FieldId -> (string)
TextFormat -> (structure)
The text format of the cell for conditional formatting.
BackgroundColor -> (structure)
The conditional formatting for the text background color.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
TextColor -> (structure)
The conditional formatting for the text color.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
Icon -> (structure)
The conditional formatting for the icon.
IconSet -> (structure)
Formatting configuration for icon set.
Expression -> (string)
IconSetType -> (string)
CustomCondition -> (structure)
Determines the custom condition for an icon set.
Expression -> (string)
IconOptions -> (structure)
Custom icon options for an icon set.
Icon -> (string)
UnicodeIcon -> (string)
Color -> (string)
DisplayConfiguration -> (structure)
Determines the icon display configuration.
IconDisplayOption -> (string)
Scope -> (structure)
The scope of the cell for conditional formatting.
Role -> (string)
Scopes -> (list)
A list of cell scopes for conditional formatting.
(structure)
The scope of the cell for conditional formatting.
Role -> (string)
Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
VisualContentAltText -> (string)
BarChartVisual -> (structure)
A bar chart.
For more information, see Using bar charts in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field wells of the visual.
BarChartAggregatedFieldWells -> (structure)
The aggregated field wells of a bar chart.
Category -> (list)
The category (y-axis) field well of a bar chart.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The value field wells of a bar chart. Values are aggregated by category.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Colors -> (list)
The color (group/color) field well of a bar chart.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
SmallMultiples -> (list)
The small multiples field well of a bar chart.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
SortConfiguration -> (structure)
The sort configuration of a BarChartVisual .
CategorySort -> (list)
The sort configuration of category fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of categories displayed in a bar chart.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
ColorSort -> (list)
The sort configuration of color fields in a bar chart.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of values displayed in a bar chart.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
SmallMultiplesSort -> (list)
The sort configuration of the small multiples field.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of small multiples panels that are displayed.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
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)
VisualPalette -> (structure)
The palette (chart color) display setup of the visual.
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
SmallMultiplesOptions -> (structure)
The small multiples setup for the visual.
MaxVisibleRows -> (long)
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 -> (long)
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 -> (structure)
Configures the display options for each small multiples panel.
Title -> (structure)
Configures the title display within each small multiples panel.
Visibility -> (string)
FontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
HorizontalTextAlignment -> (string)
BorderVisibility -> (string)
BorderThickness -> (string)
BorderStyle -> (string)
BorderColor -> (string)
GutterVisibility -> (string)
GutterSpacing -> (string)
BackgroundVisibility -> (string)
BackgroundColor -> (string)
XAxis -> (structure)
The properties of a small multiples X axis.
Scale -> (string)
SHARED .Placement -> (string)
OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.YAxis -> (structure)
The properties of a small multiples Y axis.
Scale -> (string)
SHARED .Placement -> (string)
OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.CategoryAxis -> (structure)
The label display options (grid line, range, scale, axis step) for bar chart category.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
CategoryLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
ValueAxis -> (structure)
The label display options (grid line, range, scale, axis step) for a bar chart value.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
ValueLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColorLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Legend -> (structure)
The legend display setup of the visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
DataLabels -> (structure)
The options that determine if visual data labels are displayed.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
Tooltip -> (structure)
The tooltip display setup of the visual.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
ReferenceLines -> (list)
The reference line setup of the visual.
(structure)
The reference line visual display options.
Status -> (string)
The status of the reference line. Choose one of the following options:
ENABLEDISABLE
DataConfiguration -> (structure)
The data configuration of the reference line.
StaticConfiguration -> (structure)
The static data configuration of the reference line data configuration.
Value -> (double)
DynamicConfiguration -> (structure)
The dynamic configuration of the reference line data configuration.
Column -> (structure)
The column that the dynamic data targets.
DataSetIdentifier -> (string)
ColumnName -> (string)
MeasureAggregationFunction -> (structure)
The aggregation function that is used in the dynamic data.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
AxisBinding -> (string)
The axis binding type of the reference line. Choose one of the following options:
PrimaryYSecondaryY
SeriesType -> (string)
The series type of the reference line data configuration. Choose one of the following options:
BARLINE
StyleConfiguration -> (structure)
The style configuration of the reference line.
Pattern -> (string)
The pattern type of the line style. Choose one of the following options:
SOLIDDASHEDDOTTED
Color -> (string)
LabelConfiguration -> (structure)
The label configuration of the reference line.
ValueLabelConfiguration -> (structure)
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_LABELAFTER_CUSTOM_LABEL
FormatConfiguration -> (structure)
The format configuration of the value label.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CustomLabelConfiguration -> (structure)
The custom label configuration of the label in a reference line.
CustomLabel -> (string)
FontConfiguration -> (structure)
The font configuration of the label in a reference line.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
FontColor -> (string)
HorizontalPosition -> (string)
The horizontal position configuration of the label in a reference line. Choose one of the following options:
LEFTCENTERRIGHT
VerticalPosition -> (string)
The vertical position configuration of the label in a reference line. Choose one of the following options:
ABOVEBELOW
ContributionAnalysisDefaults -> (list)
The contribution analysis (anomaly configuration) setup of the visual.
(structure)
The contribution analysis visual display for a line, pie, or bar chart.
MeasureFieldId -> (string)
ContributorDimensions -> (list)
The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
KPIVisual -> (structure)
A key performance indicator (KPI).
For more information, see Using KPIs in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration of a KPI visual.
FieldWells -> (structure)
The field well configuration of a KPI visual.
Values -> (list)
The value field wells of a KPI visual.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
TargetValues -> (list)
The target value field wells of a KPI visual.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
TrendGroups -> (list)
The trend group field wells of a KPI visual.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
SortConfiguration -> (structure)
The sort configuration of a KPI visual.
TrendGroupSort -> (list)
The sort configuration of the trend group fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The options that determine the presentation of a KPI visual.
ProgressBar -> (structure)
The options that determine the presentation of the progress bar of a KPI visual.
Visibility -> (string)
TrendArrows -> (structure)
The options that determine the presentation of trend arrows in a KPI visual.
Visibility -> (string)
SecondaryValue -> (structure)
The options that determine the presentation of the secondary value of a KPI visual.
Visibility -> (string)
Comparison -> (structure)
The comparison configuration of a KPI visual.
ComparisonMethod -> (string)
The method of the comparison. Choose from the following options:
DIFFERENCEPERCENT_DIFFERENCEPERCENT
ComparisonFormat -> (structure)
The format of the comparison.
NumberDisplayFormatConfiguration -> (structure)
The number display format.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The percentage display format.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PrimaryValueDisplayType -> (string)
PrimaryValueFontConfiguration -> (structure)
The options that determine the primary value font configuration.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
SecondaryValueFontConfiguration -> (structure)
The options that determine the secondary value font configuration.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
Sparkline -> (structure)
The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
Visibility -> (string)
Type -> (string)
Color -> (string)
TooltipVisibility -> (string)
VisualLayoutOptions -> (structure)
The options that determine the layout a KPI visual.
StandardLayout -> (structure)
The standard layout of the KPI visual.
Type -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.ConditionalFormatting -> (structure)
The conditional formatting of a KPI visual.
ConditionalFormattingOptions -> (list)
The conditional formatting options of a KPI visual.
(structure)
The conditional formatting options of a KPI visual.
PrimaryValue -> (structure)
The conditional formatting for the primary value of a KPI visual.
TextColor -> (structure)
The conditional formatting of the primary value’s text color.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
Icon -> (structure)
The conditional formatting of the primary value’s icon.
IconSet -> (structure)
Formatting configuration for icon set.
Expression -> (string)
IconSetType -> (string)
CustomCondition -> (structure)
Determines the custom condition for an icon set.
Expression -> (string)
IconOptions -> (structure)
Custom icon options for an icon set.
Icon -> (string)
UnicodeIcon -> (string)
Color -> (string)
DisplayConfiguration -> (structure)
Determines the icon display configuration.
IconDisplayOption -> (string)
ProgressBar -> (structure)
The conditional formatting for the progress bar of a KPI visual.
ForegroundColor -> (structure)
The conditional formatting of the progress bar’s foreground color.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
ActualValue -> (structure)
The conditional formatting for the actual value of a KPI visual.
TextColor -> (structure)
The conditional formatting of the actual value’s text color.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
Icon -> (structure)
The conditional formatting of the actual value’s icon.
IconSet -> (structure)
Formatting configuration for icon set.
Expression -> (string)
IconSetType -> (string)
CustomCondition -> (structure)
Determines the custom condition for an icon set.
Expression -> (string)
IconOptions -> (structure)
Custom icon options for an icon set.
Icon -> (string)
UnicodeIcon -> (string)
Color -> (string)
DisplayConfiguration -> (structure)
Determines the icon display configuration.
IconDisplayOption -> (string)
ComparisonValue -> (structure)
The conditional formatting for the comparison value of a KPI visual.
TextColor -> (structure)
The conditional formatting of the comparison value’s text color.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
Icon -> (structure)
The conditional formatting of the comparison value’s icon.
IconSet -> (structure)
Formatting configuration for icon set.
Expression -> (string)
IconSetType -> (string)
CustomCondition -> (structure)
Determines the custom condition for an icon set.
Expression -> (string)
IconOptions -> (structure)
Custom icon options for an icon set.
Icon -> (string)
UnicodeIcon -> (string)
Color -> (string)
DisplayConfiguration -> (structure)
Determines the icon display configuration.
IconDisplayOption -> (string)
Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
PieChartVisual -> (structure)
A pie or donut chart.
For more information, see Using pie charts in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration of a pie chart.
FieldWells -> (structure)
The field wells of the visual.
PieChartAggregatedFieldWells -> (structure)
The field well configuration of a pie chart.
Category -> (list)
The category (group/color) field wells of a pie chart.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The value field wells of a pie chart. Values are aggregated based on categories.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SmallMultiples -> (list)
The small multiples field well of a pie chart.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
SortConfiguration -> (structure)
The sort configuration of a pie chart.
CategorySort -> (list)
The sort configuration of the category fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of categories that are displayed in a pie chart.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
SmallMultiplesSort -> (list)
The sort configuration of the small multiples field.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of small multiples panels that are displayed.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
DonutOptions -> (structure)
The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.
ArcOptions -> (structure)
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)
GaugeChartVisual .DonutCenterOptions -> (structure)
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)
'Show total' .SmallMultiplesOptions -> (structure)
The small multiples setup for the visual.
MaxVisibleRows -> (long)
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 -> (long)
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 -> (structure)
Configures the display options for each small multiples panel.
Title -> (structure)
Configures the title display within each small multiples panel.
Visibility -> (string)
FontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
HorizontalTextAlignment -> (string)
BorderVisibility -> (string)
BorderThickness -> (string)
BorderStyle -> (string)
BorderColor -> (string)
GutterVisibility -> (string)
GutterSpacing -> (string)
BackgroundVisibility -> (string)
BackgroundColor -> (string)
XAxis -> (structure)
The properties of a small multiples X axis.
Scale -> (string)
SHARED .Placement -> (string)
OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.YAxis -> (structure)
The properties of a small multiples Y axis.
Scale -> (string)
SHARED .Placement -> (string)
OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.CategoryLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
ValueLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Legend -> (structure)
The legend display setup of the visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
DataLabels -> (structure)
The options that determine if visual data labels are displayed.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
Tooltip -> (structure)
The tooltip display setup of the visual.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
VisualPalette -> (structure)
The palette (chart color) display setup of the visual.
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
ContributionAnalysisDefaults -> (list)
The contribution analysis (anomaly configuration) setup of the visual.
(structure)
The contribution analysis visual display for a line, pie, or bar chart.
MeasureFieldId -> (string)
ContributorDimensions -> (list)
The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
GaugeChartVisual -> (structure)
A gauge chart.
For more information, see Using gauge charts in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration of a GaugeChartVisual .
FieldWells -> (structure)
The field well configuration of a GaugeChartVisual .
Values -> (list)
The value field wells of a GaugeChartVisual .
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
TargetValues -> (list)
The target value field wells of a GaugeChartVisual .
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
GaugeChartOptions -> (structure)
The options that determine the presentation of the GaugeChartVisual .
PrimaryValueDisplayType -> (string)
Comparison -> (structure)
The comparison configuration of a GaugeChartVisual .
ComparisonMethod -> (string)
The method of the comparison. Choose from the following options:
DIFFERENCEPERCENT_DIFFERENCEPERCENT
ComparisonFormat -> (structure)
The format of the comparison.
NumberDisplayFormatConfiguration -> (structure)
The number display format.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The percentage display format.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
ArcAxis -> (structure)
The arc axis configuration of a GaugeChartVisual .
Range -> (structure)
The arc axis range of a GaugeChartVisual .
Min -> (double)
Max -> (double)
ReserveRange -> (integer)
Arc -> (structure)
The arc configuration of a GaugeChartVisual .
ArcAngle -> (double)
GaugeChartVisual .ArcThickness -> (string)
GaugeChartVisual .PrimaryValueFontConfiguration -> (structure)
The options that determine the primary value font configuration.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
DataLabels -> (structure)
The data label configuration of a GaugeChartVisual .
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
TooltipOptions -> (structure)
The tooltip configuration of a GaugeChartVisual .
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
VisualPalette -> (structure)
The visual palette configuration of a GaugeChartVisual .
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
ColorConfiguration -> (structure)
The color configuration of a GaugeChartVisual .
ForegroundColor -> (string)
GaugeChartVisual .BackgroundColor -> (string)
GaugeChartVisual .Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.ConditionalFormatting -> (structure)
The conditional formatting of a GaugeChartVisual .
ConditionalFormattingOptions -> (list)
Conditional formatting options of a GaugeChartVisual .
(structure)
Conditional formatting options of a GaugeChartVisual .
PrimaryValue -> (structure)
The conditional formatting for the primary value of a GaugeChartVisual .
TextColor -> (structure)
The conditional formatting of the primary value text color.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
Icon -> (structure)
The conditional formatting of the primary value icon.
IconSet -> (structure)
Formatting configuration for icon set.
Expression -> (string)
IconSetType -> (string)
CustomCondition -> (structure)
Determines the custom condition for an icon set.
Expression -> (string)
IconOptions -> (structure)
Custom icon options for an icon set.
Icon -> (string)
UnicodeIcon -> (string)
Color -> (string)
DisplayConfiguration -> (structure)
Determines the icon display configuration.
IconDisplayOption -> (string)
Arc -> (structure)
The options that determine the presentation of the arc of a GaugeChartVisual .
ForegroundColor -> (structure)
The conditional formatting of the arc foreground color.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
VisualContentAltText -> (string)
LineChartVisual -> (structure)
A line chart.
For more information, see Using line charts in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration of a line chart.
FieldWells -> (structure)
The field well configuration of a line chart.
LineChartAggregatedFieldWells -> (structure)
The field well configuration of a line chart.
Category -> (list)
The category field wells of a line chart. Values are grouped by category fields.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The value field wells of a line chart. Values are aggregated based on categories.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Colors -> (list)
The color field wells of a line chart. Values are grouped by category fields.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
SmallMultiples -> (list)
The small multiples field well of a line chart.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
SortConfiguration -> (structure)
The sort configuration of a line chart.
CategorySort -> (list)
The sort configuration of the category fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of categories that are displayed in a line chart.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
ColorItemsLimitConfiguration -> (structure)
The limit on the number of lines that are displayed in a line chart.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
SmallMultiplesSort -> (list)
The sort configuration of the small multiples field.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of small multiples panels that are displayed.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
ForecastConfigurations -> (list)
The forecast configuration of a line chart.
(structure)
The forecast configuration that is used in a line chart’s display properties.
ForecastProperties -> (structure)
The forecast properties setup of a forecast in the line chart.
PeriodsForward -> (integer)
PeriodsBackward -> (integer)
UpperBoundary -> (double)
LowerBoundary -> (double)
PredictionInterval -> (integer)
Seasonality -> (integer)
The seasonality setup of a forecast computation. Choose one of the following options:
-
NULL: The input is set toNULL. -
NON_NULL: The input is set to a custom value.
Scenario -> (structure)
The forecast scenario of a forecast in the line chart.
WhatIfPointScenario -> (structure)
The what-if analysis forecast setup with the target date.
Date -> (timestamp)
Value -> (double)
WhatIfRangeScenario -> (structure)
The what-if analysis forecast setup with the date range.
StartDate -> (timestamp)
EndDate -> (timestamp)
Value -> (double)
Type -> (string)
SmallMultiplesOptions -> (structure)
The small multiples setup for the visual.
MaxVisibleRows -> (long)
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 -> (long)
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 -> (structure)
Configures the display options for each small multiples panel.
Title -> (structure)
Configures the title display within each small multiples panel.
Visibility -> (string)
FontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
HorizontalTextAlignment -> (string)
BorderVisibility -> (string)
BorderThickness -> (string)
BorderStyle -> (string)
BorderColor -> (string)
GutterVisibility -> (string)
GutterSpacing -> (string)
BackgroundVisibility -> (string)
BackgroundColor -> (string)
XAxis -> (structure)
The properties of a small multiples X axis.
Scale -> (string)
SHARED .Placement -> (string)
OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.YAxis -> (structure)
The properties of a small multiples Y axis.
Scale -> (string)
SHARED .Placement -> (string)
OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.XAxisDisplayOptions -> (structure)
The options that determine the presentation of the x-axis.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
XAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
PrimaryYAxisDisplayOptions -> (structure)
The series axis configuration of a line chart.
AxisOptions -> (structure)
The options that determine the presentation of the line series axis.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
MissingDataConfigurations -> (list)
The configuration options that determine how missing data is treated during the rendering of a line chart.
(structure)
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 value0. -
SHOW_AS_BLANK: Display a blank space when rendering missing data.
PrimaryYAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
SecondaryYAxisDisplayOptions -> (structure)
The series axis configuration of a line chart.
AxisOptions -> (structure)
The options that determine the presentation of the line series axis.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
MissingDataConfigurations -> (list)
The configuration options that determine how missing data is treated during the rendering of a line chart.
(structure)
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 value0. -
SHOW_AS_BLANK: Display a blank space when rendering missing data.
SecondaryYAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
SingleAxisOptions -> (structure)
The settings of a chart’s single axis configuration.
YAxisOptions -> (structure)
The Y axis options of a single axis configuration.
YAxis -> (string)
The Y axis type to be used in the chart.
If you choose PRIMARY_Y_AXIS , the primary Y Axis is located on the leftmost vertical axis of the chart.
DefaultSeriesSettings -> (structure)
The options that determine the default presentation of all line series in LineChartVisual .
AxisBinding -> (string)
LineStyleSettings -> (structure)
Line styles options for all line series in the visual.
LineVisibility -> (string)
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)
MarkerStyleSettings -> (structure)
Marker styles options for all line series in the visual.
MarkerVisibility -> (string)
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)
MarkerColor -> (string)
Series -> (list)
The series item configuration of a line chart.
(structure)
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 -> (structure)
The field series item configuration of a line chart.
FieldId -> (string)
AxisBinding -> (string)
Settings -> (structure)
The options that determine the presentation of line series associated to the field.
LineStyleSettings -> (structure)
Line styles options for a line series in LineChartVisual .
LineVisibility -> (string)
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)
MarkerStyleSettings -> (structure)
Marker styles options for a line series in LineChartVisual .
MarkerVisibility -> (string)
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)
MarkerColor -> (string)
DataFieldSeriesItem -> (structure)
The data field series item configuration of a line chart.
FieldId -> (string)
FieldValue -> (string)
AxisBinding -> (string)
Settings -> (structure)
The options that determine the presentation of line series associated to the field.
LineStyleSettings -> (structure)
Line styles options for a line series in LineChartVisual .
LineVisibility -> (string)
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)
MarkerStyleSettings -> (structure)
Marker styles options for a line series in LineChartVisual .
MarkerVisibility -> (string)
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)
MarkerColor -> (string)
Legend -> (structure)
The legend configuration of a line chart.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
DataLabels -> (structure)
The data label configuration of a line chart.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
ReferenceLines -> (list)
The reference lines configuration of a line chart.
(structure)
The reference line visual display options.
Status -> (string)
The status of the reference line. Choose one of the following options:
ENABLEDISABLE
DataConfiguration -> (structure)
The data configuration of the reference line.
StaticConfiguration -> (structure)
The static data configuration of the reference line data configuration.
Value -> (double)
DynamicConfiguration -> (structure)
The dynamic configuration of the reference line data configuration.
Column -> (structure)
The column that the dynamic data targets.
DataSetIdentifier -> (string)
ColumnName -> (string)
MeasureAggregationFunction -> (structure)
The aggregation function that is used in the dynamic data.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
AxisBinding -> (string)
The axis binding type of the reference line. Choose one of the following options:
PrimaryYSecondaryY
SeriesType -> (string)
The series type of the reference line data configuration. Choose one of the following options:
BARLINE
StyleConfiguration -> (structure)
The style configuration of the reference line.
Pattern -> (string)
The pattern type of the line style. Choose one of the following options:
SOLIDDASHEDDOTTED
Color -> (string)
LabelConfiguration -> (structure)
The label configuration of the reference line.
ValueLabelConfiguration -> (structure)
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_LABELAFTER_CUSTOM_LABEL
FormatConfiguration -> (structure)
The format configuration of the value label.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CustomLabelConfiguration -> (structure)
The custom label configuration of the label in a reference line.
CustomLabel -> (string)
FontConfiguration -> (structure)
The font configuration of the label in a reference line.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
FontColor -> (string)
HorizontalPosition -> (string)
The horizontal position configuration of the label in a reference line. Choose one of the following options:
LEFTCENTERRIGHT
VerticalPosition -> (string)
The vertical position configuration of the label in a reference line. Choose one of the following options:
ABOVEBELOW
Tooltip -> (structure)
The tooltip configuration of a line chart.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
ContributionAnalysisDefaults -> (list)
The default configuration of a line chart’s contribution analysis.
(structure)
The contribution analysis visual display for a line, pie, or bar chart.
MeasureFieldId -> (string)
ContributorDimensions -> (list)
The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
VisualPalette -> (structure)
The visual palette configuration of a line chart.
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
HeatMapVisual -> (structure)
A heat map.
For more information, see Using heat maps in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration of a heat map.
FieldWells -> (structure)
The field wells of the visual.
HeatMapAggregatedFieldWells -> (structure)
The aggregated field wells of a heat map.
Rows -> (list)
The rows field well of a heat map.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Columns -> (list)
The columns field well of a heat map.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The values field well of a heat map.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SortConfiguration -> (structure)
The sort configuration of a heat map.
HeatMapRowSort -> (list)
The field sort configuration of the rows fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of rows that are displayed in a heat map.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
HeatMapColumnItemsLimitConfiguration -> (structure)
The limit on the number of columns that are displayed in a heat map.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
RowLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColorScale -> (structure)
The color options (gradient color, point of divergence) in a heat map.
Colors -> (list)
Determines the list of colors that are applied to the visual.
(structure)
Determines the color that is applied to a particular data value.
Color -> (string)
DataValue -> (double)
ColorFillType -> (string)
NullValueColor -> (structure)
Determines the color that is applied to null values.
Color -> (string)
DataValue -> (double)
Legend -> (structure)
The legend display setup of the visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
DataLabels -> (structure)
The options that determine if visual data labels are displayed.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
Tooltip -> (structure)
The tooltip display setup of the visual.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
VisualContentAltText -> (string)
TreeMapVisual -> (structure)
A tree map.
For more information, see Using tree maps in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field wells of the visual.
TreeMapAggregatedFieldWells -> (structure)
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.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Sizes -> (list)
The size field well of a tree map. Values are aggregated based on group by fields.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Colors -> (list)
The color field well of a tree map. Values are grouped by aggregations based on group by fields.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SortConfiguration -> (structure)
The sort configuration of a tree map.
TreeMapSort -> (list)
The sort configuration of group by fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of groups that are displayed.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
GroupLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
SizeLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColorLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColorScale -> (structure)
The color options (gradient color, point of divergence) of a tree map.
Colors -> (list)
Determines the list of colors that are applied to the visual.
(structure)
Determines the color that is applied to a particular data value.
Color -> (string)
DataValue -> (double)
ColorFillType -> (string)
NullValueColor -> (structure)
Determines the color that is applied to null values.
Color -> (string)
DataValue -> (double)
Legend -> (structure)
The legend display setup of the visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
DataLabels -> (structure)
The options that determine if visual data labels are displayed.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
Tooltip -> (structure)
The tooltip display setup of the visual.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
GeospatialMapVisual -> (structure)
A geospatial map or a points on map visual.
For more information, see Creating point maps in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field wells of the visual.
GeospatialMapAggregatedFieldWells -> (structure)
The aggregated field well for a geospatial map.
Geospatial -> (list)
The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The size field wells of a geospatial map. Values are aggregated based on geospatial fields.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Colors -> (list)
The color field wells of a geospatial map.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Legend -> (structure)
The legend display setup of the visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
Tooltip -> (structure)
The tooltip display setup of the visual.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
WindowOptions -> (structure)
The window options of the geospatial map.
Bounds -> (structure)
The bounds options (north, south, west, east) of the geospatial window options.
North -> (double)
South -> (double)
West -> (double)
East -> (double)
MapZoomMode -> (string)
MapStyleOptions -> (structure)
The map style options of the geospatial map.
BaseMapStyle -> (string)
PointStyleOptions -> (structure)
The point style options of the geospatial map.
SelectedPointStyle -> (string)
ClusterMarkerConfiguration -> (structure)
The cluster marker configuration of the geospatial point style.
ClusterMarker -> (structure)
The cluster marker that is a part of the cluster marker configuration.
SimpleClusterMarker -> (structure)
The simple cluster marker of the cluster marker.
Color -> (string)
HeatmapConfiguration -> (structure)
The heatmap configuration of the geospatial point style.
HeatmapColor -> (structure)
The color scale specification for the heatmap point style.
Colors -> (list)
The list of colors to be used in heatmap point style.
(structure)
The color to be used in the heatmap point style.
Color -> (string)
VisualPalette -> (structure)
The visual display options for the visual palette.
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
VisualContentAltText -> (string)
FilledMapVisual -> (structure)
A filled map.
For more information, see Creating filled maps in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field wells of the visual.
FilledMapAggregatedFieldWells -> (structure)
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.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The aggregated color field well of a filled map. Values are aggregated based on location fields.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SortConfiguration -> (structure)
The sort configuration of a FilledMapVisual .
CategorySort -> (list)
The sort configuration of the location fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The legend display setup of the visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
Tooltip -> (structure)
The tooltip display setup of the visual.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
WindowOptions -> (structure)
The window options of the filled map visual.
Bounds -> (structure)
The bounds options (north, south, west, east) of the geospatial window options.
North -> (double)
South -> (double)
West -> (double)
East -> (double)
MapZoomMode -> (string)
MapStyleOptions -> (structure)
The map style options of the filled map visual.
BaseMapStyle -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.ConditionalFormatting -> (structure)
The conditional formatting of a FilledMapVisual .
ConditionalFormattingOptions -> (list)
Conditional formatting options of a FilledMapVisual .
(structure)
Conditional formatting options of a FilledMapVisual .
Shape -> (structure)
The conditional formatting that determines the shape of the filled map.
FieldId -> (string)
Format -> (structure)
The conditional formatting that determines the background color of a filled map’s shape.
BackgroundColor -> (structure)
The conditional formatting for the shape background color of a filled map visual.
Solid -> (structure)
Formatting configuration for solid color.
Expression -> (string)
Color -> (string)
Gradient -> (structure)
Formatting configuration for gradient color.
Expression -> (string)
Color -> (structure)
Determines the color.
Stops -> (list)
The list of gradient color stops.
(structure)
Determines the gradient stop configuration.
GradientOffset -> (double)
DataValue -> (double)
Color -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
VisualContentAltText -> (string)
LayerMapVisual -> (structure)
The properties for a layer map visual
VisualId -> (string)
Title -> (structure)
The title label options for a visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle label options for a visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
Legend -> (structure)
The options for the legend setup of a visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
MapLayers -> (list)
The geospatial layers to visualize on the map.
(structure)
The properties for a single geospatial layer.
LayerId -> (string)
LayerType -> (string)
DataSource -> (structure)
The data source for the layer.
StaticFileDataSource -> (structure)
The static file data source properties for the geospatial data.
StaticFileId -> (string)
Label -> (string)
Visibility -> (string)
LayerDefinition -> (structure)
The definition properties for a layer.
PointLayer -> (structure)
The definition for a point layer.
Style -> (structure)
The visualization style for a point layer.
CircleSymbolStyle -> (structure)
The circle symbol style for a point layer.
FillColor -> (structure)
The color and opacity values for the fill color.
Solid -> (structure)
The visualization properties for the solid color.
Color -> (string)
State -> (string)
Gradient -> (structure)
The visualization properties for the gradient color.
StepColors -> (list)
A list of gradient step colors for the gradient.
(structure)
The gradient step color for a single step.
Color -> (string)
DataValue -> (double)
NullDataVisibility -> (string)
NullDataSettings -> (structure)
The null data visualization settings.
SymbolStyle -> (structure)
The symbol style for null data.
FillColor -> (string)
StrokeColor -> (string)
StrokeWidth -> (double)
DefaultOpacity -> (double)
Categorical -> (structure)
The visualization properties for the categorical color.
CategoryDataColors -> (list)
A list of categorical data colors for each category.
(structure)
The categorical data color for a single category.
Color -> (string)
DataValue -> (string)
NullDataVisibility -> (string)
NullDataSettings -> (structure)
The null data visualization settings.
SymbolStyle -> (structure)
The symbol style for null data.
FillColor -> (string)
StrokeColor -> (string)
StrokeWidth -> (double)
DefaultOpacity -> (double)
StrokeColor -> (structure)
The color and opacity values for the stroke color.
Solid -> (structure)
The visualization properties for the solid color.
Color -> (string)
State -> (string)
Gradient -> (structure)
The visualization properties for the gradient color.
StepColors -> (list)
A list of gradient step colors for the gradient.
(structure)
The gradient step color for a single step.
Color -> (string)
DataValue -> (double)
NullDataVisibility -> (string)
NullDataSettings -> (structure)
The null data visualization settings.
SymbolStyle -> (structure)
The symbol style for null data.
FillColor -> (string)
StrokeColor -> (string)
StrokeWidth -> (double)
DefaultOpacity -> (double)
Categorical -> (structure)
The visualization properties for the categorical color.
CategoryDataColors -> (list)
A list of categorical data colors for each category.
(structure)
The categorical data color for a single category.
Color -> (string)
DataValue -> (string)
NullDataVisibility -> (string)
NullDataSettings -> (structure)
The null data visualization settings.
SymbolStyle -> (structure)
The symbol style for null data.
FillColor -> (string)
StrokeColor -> (string)
StrokeWidth -> (double)
DefaultOpacity -> (double)
StrokeWidth -> (structure)
The width of the stroke (border).
LineWidth -> (double)
CircleRadius -> (structure)
The radius of the circle.
Radius -> (double)
LineLayer -> (structure)
The definition for a line layer.
Style -> (structure)
The visualization style for a line layer.
LineSymbolStyle -> (structure)
The symbol style for a line style.
FillColor -> (structure)
The color and opacity values for the fill color.
Solid -> (structure)
The visualization properties for the solid color.
Color -> (string)
State -> (string)
Gradient -> (structure)
The visualization properties for the gradient color.
StepColors -> (list)
A list of gradient step colors for the gradient.
(structure)
The gradient step color for a single step.
Color -> (string)
DataValue -> (double)
NullDataVisibility -> (string)
NullDataSettings -> (structure)
The null data visualization settings.
SymbolStyle -> (structure)
The symbol style for null data.
FillColor -> (string)
StrokeColor -> (string)
StrokeWidth -> (double)
DefaultOpacity -> (double)
Categorical -> (structure)
The visualization properties for the categorical color.
CategoryDataColors -> (list)
A list of categorical data colors for each category.
(structure)
The categorical data color for a single category.
Color -> (string)
DataValue -> (string)
NullDataVisibility -> (string)
NullDataSettings -> (structure)
The null data visualization settings.
SymbolStyle -> (structure)
The symbol style for null data.
FillColor -> (string)
StrokeColor -> (string)
StrokeWidth -> (double)
DefaultOpacity -> (double)
LineWidth -> (structure)
The width value for a line.
LineWidth -> (double)
PolygonLayer -> (structure)
The definition for a polygon layer.
Style -> (structure)
The visualization style for a polygon layer.
PolygonSymbolStyle -> (structure)
The polygon symbol style for a polygon layer.
FillColor -> (structure)
The color and opacity values for the fill color.
Solid -> (structure)
The visualization properties for the solid color.
Color -> (string)
State -> (string)
Gradient -> (structure)
The visualization properties for the gradient color.
StepColors -> (list)
A list of gradient step colors for the gradient.
(structure)
The gradient step color for a single step.
Color -> (string)
DataValue -> (double)
NullDataVisibility -> (string)
NullDataSettings -> (structure)
The null data visualization settings.
SymbolStyle -> (structure)
The symbol style for null data.
FillColor -> (string)
StrokeColor -> (string)
StrokeWidth -> (double)
DefaultOpacity -> (double)
Categorical -> (structure)
The visualization properties for the categorical color.
CategoryDataColors -> (list)
A list of categorical data colors for each category.
(structure)
The categorical data color for a single category.
Color -> (string)
DataValue -> (string)
NullDataVisibility -> (string)
NullDataSettings -> (structure)
The null data visualization settings.
SymbolStyle -> (structure)
The symbol style for null data.
FillColor -> (string)
StrokeColor -> (string)
StrokeWidth -> (double)
DefaultOpacity -> (double)
StrokeColor -> (structure)
The color and opacity values for the stroke color.
Solid -> (structure)
The visualization properties for the solid color.
Color -> (string)
State -> (string)
Gradient -> (structure)
The visualization properties for the gradient color.
StepColors -> (list)
A list of gradient step colors for the gradient.
(structure)
The gradient step color for a single step.
Color -> (string)
DataValue -> (double)
NullDataVisibility -> (string)
NullDataSettings -> (structure)
The null data visualization settings.
SymbolStyle -> (structure)
The symbol style for null data.
FillColor -> (string)
StrokeColor -> (string)
StrokeWidth -> (double)
DefaultOpacity -> (double)
Categorical -> (structure)
The visualization properties for the categorical color.
CategoryDataColors -> (list)
A list of categorical data colors for each category.
(structure)
The categorical data color for a single category.
Color -> (string)
DataValue -> (string)
NullDataVisibility -> (string)
NullDataSettings -> (structure)
The null data visualization settings.
SymbolStyle -> (structure)
The symbol style for null data.
FillColor -> (string)
StrokeColor -> (string)
StrokeWidth -> (double)
DefaultOpacity -> (double)
StrokeWidth -> (structure)
The width of the border stroke.
LineWidth -> (double)
Tooltip -> (structure)
The display options for the visual tooltip.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
JoinDefinition -> (structure)
The join definition properties for a layer.
ShapeKeyField -> (string)
DatasetKeyField -> (structure)
The unaggregated field for a table.
FieldId -> (string)
Column -> (structure)
The column that is used in the UnaggregatedField .
DataSetIdentifier -> (string)
ColumnName -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
StringFormatConfiguration -> (structure)
Formatting configuration for string fields.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumberFormatConfiguration -> (structure)
Formatting configuration for number fields.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateTimeFormatConfiguration -> (structure)
Formatting configuration for DateTime fields.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
ColorField -> (structure)
The geospatial color field for the join definition.
ColorDimensionsFields -> (list)
A list of color dimension fields.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
ColorValuesFields -> (list)
A list of color measure fields.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Actions -> (list)
A list of custom actions for a layer.
(structure)
A layer custom action.
CustomActionId -> (string)
Name -> (string)
Status -> (string)
LayerCustomAction .Trigger -> (string)
The trigger of the LayerCustomAction .
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)
A list of LayerCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
MapState -> (structure)
The map state properties for the map.
Bounds -> (structure)
The bound options (north, south, west, east) of the geospatial window options.
North -> (double)
South -> (double)
West -> (double)
East -> (double)
MapNavigation -> (string)
MapStyle -> (structure)
The map style properties for the map.
BaseMapStyle -> (string)
BackgroundColor -> (string)
BaseMapVisibility -> (string)
Interactions -> (structure)
The general visual interactions setup for visual publish options
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.DataSetIdentifier -> (string)
VisualContentAltText -> (string)
FunnelChartVisual -> (structure)
A funnel chart.
For more information, see Using funnel charts in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration of a FunnelChartVisual .
FieldWells -> (structure)
The field well configuration of a FunnelChartVisual .
FunnelChartAggregatedFieldWells -> (structure)
The field well configuration of a FunnelChartVisual .
Category -> (list)
The category field wells of a funnel chart. Values are grouped by category fields.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The value field wells of a funnel chart. Values are aggregated based on categories.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SortConfiguration -> (structure)
The sort configuration of a FunnelChartVisual .
CategorySort -> (list)
The sort configuration of the category fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of categories displayed.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
CategoryLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
ValueLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Tooltip -> (structure)
The tooltip configuration of a FunnelChartVisual .
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
DataLabelOptions -> (structure)
The options that determine the presentation of the data labels.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
Position -> (string)
LabelFontConfiguration -> (structure)
The font configuration for the data labels.
Only the FontSize attribute of the font configuration is used for data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
MeasureDataLabelStyle -> (string)
VisualPalette -> (structure)
The visual palette configuration of a FunnelChartVisual .
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
ScatterPlotVisual -> (structure)
A scatter plot.
For more information, see Using scatter plots in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field wells of the visual.
ScatterPlotCategoricallyAggregatedFieldWells -> (structure)
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.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
YAxis -> (list)
The y-axis field well of a scatter plot.
The y-axis is aggregated by category.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Category -> (list)
The category field well of a scatter plot.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Size -> (list)
The size field well of a scatter plot.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Label -> (list)
The label field well of a scatter plot.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
ScatterPlotUnaggregatedFieldWells -> (structure)
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.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
YAxis -> (list)
The y-axis field well of a scatter plot.
The y-axis is a dimension field and cannot be aggregated.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Size -> (list)
The size field well of a scatter plot.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Category -> (list)
The category field well of a scatter plot.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Label -> (list)
The label field well of a scatter plot.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
SortConfiguration -> (structure)
The sort configuration of a scatter plot.
ScatterPlotLimitConfiguration -> (structure)
The limit configuration of the visual display for an axis.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
XAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
XAxisDisplayOptions -> (structure)
The label display options (grid line, range, scale, and axis step) of the scatter plot’s x-axis.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
YAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
YAxisDisplayOptions -> (structure)
The label display options (grid line, range, scale, and axis step) of the scatter plot’s y-axis.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
Legend -> (structure)
The legend display setup of the visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
DataLabels -> (structure)
The options that determine if visual data labels are displayed.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
Tooltip -> (structure)
The legend display setup of the visual.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
VisualPalette -> (structure)
The palette (chart color) display setup of the visual.
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
ComboChartVisual -> (structure)
A combo chart.
For more information, see Using combo charts in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field wells of the visual.
ComboChartAggregatedFieldWells -> (structure)
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.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
BarValues -> (list)
The aggregated BarValues field well of a combo chart.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Colors -> (list)
The aggregated colors field well of a combo chart.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
LineValues -> (list)
The aggregated LineValues field well of a combo chart.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SortConfiguration -> (structure)
The sort configuration of a ComboChartVisual .
CategorySort -> (list)
The sort configuration of the category field well in a combo chart.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The item limit configuration for the category field well of a combo chart.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
ColorSort -> (list)
The sort configuration of the color field well in a combo chart.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The item limit configuration of the color field well in a combo chart.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
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 -> (structure)
The category axis of a combo chart.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
CategoryLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
PrimaryYAxisDisplayOptions -> (structure)
The label display options (grid line, range, scale, and axis step) of a combo chart’s primary y-axis (bar) field well.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
PrimaryYAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
SecondaryYAxisDisplayOptions -> (structure)
The label display options (grid line, range, scale, axis step) of a combo chart’s secondary y-axis (line) field well.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
SecondaryYAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
SingleAxisOptions -> (structure)
The settings of a chart’s single axis configuration.
YAxisOptions -> (structure)
The Y axis options of a single axis configuration.
YAxis -> (string)
The Y axis type to be used in the chart.
If you choose PRIMARY_Y_AXIS , the primary Y Axis is located on the leftmost vertical axis of the chart.
ColorLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Legend -> (structure)
The legend display setup of the visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
BarDataLabels -> (structure)
The options that determine if visual data labels are displayed.
The data label options for a bar in a combo chart.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
LineDataLabels -> (structure)
The options that determine if visual data labels are displayed.
The data label options for a line in a combo chart.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
Tooltip -> (structure)
The legend display setup of the visual.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
ReferenceLines -> (list)
The reference line setup of the visual.
(structure)
The reference line visual display options.
Status -> (string)
The status of the reference line. Choose one of the following options:
ENABLEDISABLE
DataConfiguration -> (structure)
The data configuration of the reference line.
StaticConfiguration -> (structure)
The static data configuration of the reference line data configuration.
Value -> (double)
DynamicConfiguration -> (structure)
The dynamic configuration of the reference line data configuration.
Column -> (structure)
The column that the dynamic data targets.
DataSetIdentifier -> (string)
ColumnName -> (string)
MeasureAggregationFunction -> (structure)
The aggregation function that is used in the dynamic data.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
AxisBinding -> (string)
The axis binding type of the reference line. Choose one of the following options:
PrimaryYSecondaryY
SeriesType -> (string)
The series type of the reference line data configuration. Choose one of the following options:
BARLINE
StyleConfiguration -> (structure)
The style configuration of the reference line.
Pattern -> (string)
The pattern type of the line style. Choose one of the following options:
SOLIDDASHEDDOTTED
Color -> (string)
LabelConfiguration -> (structure)
The label configuration of the reference line.
ValueLabelConfiguration -> (structure)
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_LABELAFTER_CUSTOM_LABEL
FormatConfiguration -> (structure)
The format configuration of the value label.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CustomLabelConfiguration -> (structure)
The custom label configuration of the label in a reference line.
CustomLabel -> (string)
FontConfiguration -> (structure)
The font configuration of the label in a reference line.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
FontColor -> (string)
HorizontalPosition -> (string)
The horizontal position configuration of the label in a reference line. Choose one of the following options:
LEFTCENTERRIGHT
VerticalPosition -> (string)
The vertical position configuration of the label in a reference line. Choose one of the following options:
ABOVEBELOW
VisualPalette -> (structure)
The palette (chart color) display setup of the visual.
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
BoxPlotVisual -> (structure)
A box plot.
For more information, see Using box plots in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field wells of the visual.
BoxPlotAggregatedFieldWells -> (structure)
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.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The value field well of a box plot chart. Values are aggregated based on group by fields.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SortConfiguration -> (structure)
The sort configuration of a BoxPlotVisual .
CategorySort -> (list)
The sort configuration of a group by fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The pagination configuration of a table visual or box plot.
PageSize -> (long)
PageNumber -> (long)
BoxPlotOptions -> (structure)
The box plot chart options for a box plot visual
StyleOptions -> (structure)
The style options of the box plot.
FillStyle -> (string)
OutlierVisibility -> (string)
AllDataPointsVisibility -> (string)
CategoryAxis -> (structure)
The label display options (grid line, range, scale, axis step) of a box plot category.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
CategoryLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
PrimaryYAxisDisplayOptions -> (structure)
The label display options (grid line, range, scale, axis step) of a box plot category.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
PrimaryYAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Legend -> (structure)
The options for the legend setup of a visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
Tooltip -> (structure)
The tooltip display setup of the visual.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
ReferenceLines -> (list)
The reference line setup of the visual.
(structure)
The reference line visual display options.
Status -> (string)
The status of the reference line. Choose one of the following options:
ENABLEDISABLE
DataConfiguration -> (structure)
The data configuration of the reference line.
StaticConfiguration -> (structure)
The static data configuration of the reference line data configuration.
Value -> (double)
DynamicConfiguration -> (structure)
The dynamic configuration of the reference line data configuration.
Column -> (structure)
The column that the dynamic data targets.
DataSetIdentifier -> (string)
ColumnName -> (string)
MeasureAggregationFunction -> (structure)
The aggregation function that is used in the dynamic data.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
AxisBinding -> (string)
The axis binding type of the reference line. Choose one of the following options:
PrimaryYSecondaryY
SeriesType -> (string)
The series type of the reference line data configuration. Choose one of the following options:
BARLINE
StyleConfiguration -> (structure)
The style configuration of the reference line.
Pattern -> (string)
The pattern type of the line style. Choose one of the following options:
SOLIDDASHEDDOTTED
Color -> (string)
LabelConfiguration -> (structure)
The label configuration of the reference line.
ValueLabelConfiguration -> (structure)
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_LABELAFTER_CUSTOM_LABEL
FormatConfiguration -> (structure)
The format configuration of the value label.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CustomLabelConfiguration -> (structure)
The custom label configuration of the label in a reference line.
CustomLabel -> (string)
FontConfiguration -> (structure)
The font configuration of the label in a reference line.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
FontColor -> (string)
HorizontalPosition -> (string)
The horizontal position configuration of the label in a reference line. Choose one of the following options:
LEFTCENTERRIGHT
VerticalPosition -> (string)
The vertical position configuration of the label in a reference line. Choose one of the following options:
ABOVEBELOW
VisualPalette -> (structure)
The palette (chart color) display setup of the visual.
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
WaterfallVisual -> (structure)
A waterfall chart.
For more information, see Using waterfall charts in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration for a waterfall visual.
FieldWells -> (structure)
The field well configuration of a waterfall visual.
WaterfallChartAggregatedFieldWells -> (structure)
The field well configuration of a waterfall visual.
Categories -> (list)
The category field wells of a waterfall visual.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The value field wells of a waterfall visual.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Breakdowns -> (list)
The breakdown field wells of a waterfall visual.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
SortConfiguration -> (structure)
The sort configuration of a waterfall visual.
CategorySort -> (list)
The sort configuration of the category fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of bar groups that are displayed.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
WaterfallChartOptions -> (structure)
The options that determine the presentation of a waterfall visual.
TotalBarLabel -> (string)
CategoryAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryAxisDisplayOptions -> (structure)
The options that determine the presentation of the category axis.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
PrimaryYAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
PrimaryYAxisDisplayOptions -> (structure)
The options that determine the presentation of the y-axis.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
Legend -> (structure)
The legend configuration of a waterfall visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
DataLabels -> (structure)
The data label configuration of a waterfall visual.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
VisualPalette -> (structure)
The visual palette configuration of a waterfall visual.
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
ColorConfiguration -> (structure)
The color configuration of a waterfall visual.
GroupColorConfiguration -> (structure)
The color configuration for individual groups within a waterfall visual.
PositiveBarColor -> (string)
NegativeBarColor -> (string)
TotalBarColor -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
HistogramVisual -> (structure)
A histogram.
For more information, see Using histograms in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration for a HistogramVisual .
FieldWells -> (structure)
The field well configuration of a histogram.
HistogramAggregatedFieldWells -> (structure)
The field well configuration of a histogram.
Values -> (list)
The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT .
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
XAxisDisplayOptions -> (structure)
The options that determine the presentation of the x-axis.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
XAxisLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
YAxisDisplayOptions -> (structure)
The options that determine the presentation of the y-axis.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
BinOptions -> (structure)
The options that determine the presentation of histogram bins.
SelectedBinType -> (string)
BinCount -> (structure)
The options that determine the bin count of a histogram.
Value -> (integer)
BinWidth -> (structure)
The options that determine the bin width of a histogram.
Value -> (double)
BinCountLimit -> (long)
StartValue -> (double)
DataLabels -> (structure)
The data label configuration of a histogram.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
Tooltip -> (structure)
The tooltip configuration of a histogram.
TooltipVisibility -> (string)
SelectedTooltipType -> (string)
The selected type for the tooltip. Choose one of the following options:
-
BASIC: A basic tooltip. -
DETAILED: A detailed tooltip.
FieldBasedTooltip -> (structure)
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
AggregationVisibility -> (string)
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.
(structure)
The tooltip.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FieldTooltipItem -> (structure)
The tooltip item for the fields.
FieldId -> (string)
Label -> (string)
Visibility -> (string)
TooltipTarget -> (string)
ColumnTooltipItem -> (structure)
The tooltip item for the columns that are not part of a field well.
Column -> (structure)
The target column of the tooltip item.
DataSetIdentifier -> (string)
ColumnName -> (string)
Label -> (string)
Visibility -> (string)
Aggregation -> (structure)
The aggregation function of the column tooltip item.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.TooltipTarget -> (string)
VisualPalette -> (structure)
The visual palette configuration of a histogram.
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
VisualContentAltText -> (string)
WordCloudVisual -> (structure)
A word cloud.
For more information, see Using word clouds in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field wells of the visual.
WordCloudAggregatedFieldWells -> (structure)
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.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Size -> (list)
The size field well of a word cloud. Values are aggregated based on group by fields.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SortConfiguration -> (structure)
The sort configuration of a word cloud visual.
CategoryItemsLimit -> (structure)
The limit on the number of groups that are displayed in a word cloud.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
CategorySort -> (list)
The sort configuration of group by fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
WordCloudOptions -> (structure)
The options for a word cloud visual.
WordOrientation -> (string)
WordScaling -> (string)
CloudLayout -> (string)
WordCasing -> (string)
WordPadding -> (string)
MaximumStringLength -> (integer)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
InsightVisual -> (structure)
An insight visual.
For more information, see Working with insights in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
InsightConfiguration -> (structure)
The configuration of an insight visual.
Computations -> (list)
The computations configurations of the insight visual
(structure)
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 -> (structure)
The top ranked and bottom ranked computation configuration.
ComputationId -> (string)
Name -> (string)
Category -> (structure)
The category field that is used in a computation.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Value -> (structure)
The value field that is used in a computation.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
ResultSize -> (integer)
Type -> (string)
The computation type. Choose one of the following options:
- TOP: A top ranked computation.
- BOTTOM: A bottom ranked computation.
TopBottomMovers -> (structure)
The top movers and bottom movers computation configuration.
ComputationId -> (string)
Name -> (string)
Time -> (structure)
The time field that is used in a computation.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Category -> (structure)
The category field that is used in a computation.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Value -> (structure)
The value field that is used in a computation.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
MoverSize -> (integer)
SortOrder -> (string)
Type -> (string)
The computation type. Choose from the following options:
- TOP: Top movers computation.
- BOTTOM: Bottom movers computation.
TotalAggregation -> (structure)
The total aggregation computation configuration.
ComputationId -> (string)
Name -> (string)
Value -> (structure)
The value field that is used in a computation.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
MaximumMinimum -> (structure)
The maximum and minimum computation configuration.
ComputationId -> (string)
Name -> (string)
Time -> (structure)
The time field that is used in a computation.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Value -> (structure)
The value field that is used in a computation.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Type -> (string)
The type of computation. Choose one of the following options:
- MAXIMUM: A maximum computation.
- MINIMUM: A minimum computation.
MetricComparison -> (structure)
The metric comparison computation configuration.
ComputationId -> (string)
Name -> (string)
Time -> (structure)
The time field that is used in a computation.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
FromValue -> (structure)
The field that is used in a metric comparison from value setup.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
TargetValue -> (structure)
The field that is used in a metric comparison to value setup.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
PeriodOverPeriod -> (structure)
The period over period computation configuration.
ComputationId -> (string)
Name -> (string)
Time -> (structure)
The time field that is used in a computation.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Value -> (structure)
The value field that is used in a computation.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
PeriodToDate -> (structure)
The period to DataSetIdentifier computation configuration.
ComputationId -> (string)
Name -> (string)
Time -> (structure)
The time field that is used in a computation.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Value -> (structure)
The value field that is used in a computation.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
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 -> (structure)
The growth rate computation configuration.
ComputationId -> (string)
Name -> (string)
Time -> (structure)
The time field that is used in a computation.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Value -> (structure)
The value field that is used in a computation.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
PeriodSize -> (integer)
UniqueValues -> (structure)
The unique values computation configuration.
ComputationId -> (string)
Name -> (string)
Category -> (structure)
The category field that is used in a computation.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Forecast -> (structure)
The forecast computation configuration.
ComputationId -> (string)
Name -> (string)
Time -> (structure)
The time field that is used in a computation.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Value -> (structure)
The value field that is used in a computation.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
PeriodsForward -> (integer)
PeriodsBackward -> (integer)
UpperBoundary -> (double)
LowerBoundary -> (double)
PredictionInterval -> (integer)
Seasonality -> (string)
The seasonality setup of a forecast computation. Choose one of the following options:
AUTOMATIC-
CUSTOM: Checks the custom seasonality value.
CustomSeasonalityValue -> (integer)
CustomNarrative -> (structure)
The custom narrative of the insight visual.
Narrative -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DataSetIdentifier -> (string)
VisualContentAltText -> (string)
SankeyDiagramVisual -> (structure)
A sankey diagram.
For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration of a sankey diagram.
FieldWells -> (structure)
The field well configuration of a sankey diagram.
SankeyDiagramAggregatedFieldWells -> (structure)
The field well configuration of a sankey diagram.
Source -> (list)
The source field wells of a sankey diagram.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Destination -> (list)
The destination field wells of a sankey diagram.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Weight -> (list)
The weight field wells of a sankey diagram.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SortConfiguration -> (structure)
The sort configuration of a sankey diagram.
WeightSort -> (list)
The sort configuration of the weight fields.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The limit on the number of source nodes that are displayed in a sankey diagram.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
DestinationItemsLimit -> (structure)
The limit on the number of destination nodes that are displayed in a sankey diagram.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
DataLabels -> (structure)
The data label configuration of a sankey diagram.
Visibility -> (string)
CategoryLabelVisibility -> (string)
MeasureLabelVisibility -> (string)
DataLabelTypes -> (list)
The option that determines the data label type.
(structure)
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 -> (structure)
Determines the label configuration for the entire field.
FieldId -> (string)
Visibility -> (string)
DataPathLabelType -> (structure)
The option that specifies individual data values for labels.
FieldId -> (string)
FieldValue -> (string)
Visibility -> (string)
RangeEndsLabelType -> (structure)
Determines the label configuration for range end value in a visual.
Visibility -> (string)
MinimumLabelType -> (structure)
Determines the label configuration for the minimum value in a visual.
Visibility -> (string)
MaximumLabelType -> (structure)
Determines the label configuration for the maximum value in a visual.
Visibility -> (string)
Position -> (string)
LabelContent -> (string)
LabelFontConfiguration -> (structure)
Determines the font configuration of the data labels.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
LabelColor -> (string)
Overlap -> (string)
TotalsVisibility -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
VisualContentAltText -> (string)
CustomContentVisual -> (structure)
A visual that contains custom content.
For more information, see Using custom visual content in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration of a CustomContentVisual .
ContentUrl -> (string)
ContentType -> (string)
ImageScaling -> (string)
ContentType of the visual is 'IMAGE' .Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DataSetIdentifier -> (string)
VisualContentAltText -> (string)
EmptyVisual -> (structure)
An empty visual.
VisualId -> (string)
DataSetIdentifier -> (string)
Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
RadarChartVisual -> (structure)
A radar chart visual.
For more information, see Using radar charts in the Amazon QuickSight User Guide .
VisualId -> (string)
Title -> (structure)
The title that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle that is displayed on the visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
The configuration settings of the visual.
FieldWells -> (structure)
The field well configuration of a RadarChartVisual .
RadarChartAggregatedFieldWells -> (structure)
The aggregated field wells of a radar chart visual.
Category -> (list)
The aggregated field well categories of a radar chart.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Color -> (list)
The color that are assigned to the aggregated field wells of a radar chart.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Values -> (list)
The values that are assigned to the aggregated field wells of a radar chart.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
SortConfiguration -> (structure)
The sort configuration of a RadarChartVisual .
CategorySort -> (list)
The category sort options of a radar chart.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The category items limit for a radar chart.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
ColorSort -> (list)
The color sort configuration of a radar chart.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 -> (structure)
The color items limit of a radar chart.
ItemsLimit -> (long)
OtherCategories -> (string)
The Show other of an axis in the chart. Choose one of the following options:
INCLUDEEXCLUDE
Shape -> (string)
BaseSeriesSettings -> (structure)
The base sreies settings of a radar chart.
AreaStyleSettings -> (structure)
The area style settings of a radar chart.
Visibility -> (string)
StartAngle -> (double)
VisualPalette -> (structure)
The palette (chart color) display setup of the visual.
ChartColor -> (string)
ColorMap -> (list)
The color map options for the visual palette.
(structure)
The color map that determines the color options for a particular element.
Element -> (structure)
The element that the color needs to be applied to.
FieldId -> (string)
FieldValue -> (string)
DataPathType -> (structure)
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, whenRowsLayoutis set toHIERARCHY. -
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 inColumnsFieldWelland the row is set to Metric Placement. -
COUNT_METRIC_COLUMN- The type of data path for the column withCOUNTas the metric, when there is no field in theValuesFieldWell.
Color -> (string)
TimeGranularity -> (string)
AlternateBandColorsVisibility -> (string)
AlternateBandEvenColor -> (string)
AlternateBandOddColor -> (string)
CategoryAxis -> (structure)
The category axis of a radar chart.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
CategoryLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColorAxis -> (structure)
The color axis of a radar chart.
TickLabelOptions -> (structure)
The tick label options of an axis.
LabelOptions -> (structure)
Determines whether or not the axis ticks are visible.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
RotationAngle -> (double)
AxisLineVisibility -> (string)
GridLineVisibility -> (string)
DataOptions -> (structure)
The data options for an axis.
NumericAxisOptions -> (structure)
The options for an axis with a numeric field.
Scale -> (structure)
The scale setup of a numeric axis.
Linear -> (structure)
The linear axis scale setup.
StepCount -> (integer)
StepSize -> (double)
Logarithmic -> (structure)
The logarithmic axis scale setup.
Base -> (double)
Range -> (structure)
The range setup of a numeric axis.
MinMax -> (structure)
The minimum and maximum setup of an axis display range.
Minimum -> (double)
Maximum -> (double)
DataDriven -> (structure)
DateAxisOptions -> (structure)
The options for an axis with a date field.
MissingDateVisibility -> (string)
ScrollbarOptions -> (structure)
The scroll bar options for an axis.
Visibility -> (string)
VisibleRange -> (structure)
The visibility range for the data zoom scroll bar.
PercentRange -> (structure)
The percent range in the visible range.
From -> (double)
To -> (double)
AxisOffset -> (string)
ColorLabelOptions -> (structure)
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)
AxisLabelOptions -> (list)
The label options for a chart axis.
(structure)
The label options for a chart axis. You must specify the field that the label is targeted to.
FontConfiguration -> (structure)
The font configuration of the axis label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
ApplyTo -> (structure)
The options that indicate which field the label belongs to.
FieldId -> (string)
Column -> (structure)
The column that the axis label is targeted to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Legend -> (structure)
The legend display setup of the visual.
Visibility -> (string)
Title -> (structure)
The custom title for the legend.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
Position -> (string)
The positions for the legend. Choose one of the following options:
AUTORIGHTBOTTOMLEFT
Width -> (string)
Height -> (string)
ValueFontConfiguration -> (structure)
Configures the display properties of the given text.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
AxesRangeScale -> (string)
Interactions -> (structure)
The general visual interactions setup for a visual.
VisualMenuOption -> (structure)
The on-visual menu options for a visual.
AvailabilityStatus -> (string)
ContextMenuOption -> (structure)
The context menu options for a visual.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the context menu.Actions -> (list)
The list of custom actions that are configured for a visual.
(structure)
A custom action defined on a visual.
CustomActionId -> (string)
VisualCustomAction .Name -> (string)
VisualCustomAction .Status -> (string)
VisualCustomAction .Trigger -> (string)
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)
A list of VisualCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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 -> (structure)
The filter operation that filters data included in a visual or in an entire sheet.
SelectedFieldsConfiguration -> (structure)
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.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
TargetVisualsConfiguration -> (structure)
The configuration that chooses the target visuals to be filtered.
SameSheetTargetVisualConfiguration -> (structure)
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 -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
ColumnHierarchies -> (list)
The column hierarchy that is used during drill-downs and drill-ups.
(structure)
The option that determines the hierarchy of the fields for a visual element.
ExplicitHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the explicit hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the explicit hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.DateTimeHierarchy -> (structure)
The option that determines the hierarchy of any DateTime fields.
HierarchyId -> (string)
DateTime hierarchy.DrillDownFilters -> (list)
The option that determines the drill down filters for the DateTime hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.PredefinedHierarchy -> (structure)
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)
Columns -> (list)
The list of columns that define the predefined hierarchy.
(structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
DrillDownFilters -> (list)
The option that determines the drill down filters for the predefined hierarchy.
(structure)
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 -> (structure)
The numeric equality type drill down filter. This filter is used for number type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
CategoryFilter -> (structure)
The category type drill down filter. This filter is used for string type columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
CategoryValues -> (list)
A list of the string inputs that are the values of the category drill down filter.
(string)
TimeRangeFilter -> (structure)
The time range drill down filter. This filter is used for date time columns.
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
RangeMinimum -> (timestamp)
RangeMaximum -> (timestamp)
TimeGranularity -> (string)
DateTime values.VisualContentAltText -> (string)
PluginVisual -> (structure)
The custom plugin visual type.
VisualId -> (string)
PluginArn -> (string)
Title -> (structure)
The title label options for a visual.
Visibility -> (string)
FormatText -> (structure)
The short text format of the title label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
Subtitle -> (structure)
The subtitle label options for a visual.
Visibility -> (string)
FormatText -> (structure)
The long text format of the subtitle label, such as plain text or rich text.
PlainText -> (string)
RichText -> (string)
ChartConfiguration -> (structure)
A description of the plugin field wells and their persisted properties.
FieldWells -> (list)
The field wells configuration of the plugin visual.
(structure)
A collection of field wells for a plugin visual.
AxisName -> (string)
Dimensions -> (list)
A list of dimensions for the field well.
(structure)
The dimension type field.
NumericalDimensionField -> (structure)
The dimension type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalDimensionField -> (structure)
The dimension type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateDimensionField -> (structure)
The dimension type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateDimensionField .
DataSetIdentifier -> (string)
ColumnName -> (string)
DateGranularity -> (string)
The date granularity of the DateDimensionField . Choose one of the following options:
YEARQUARTERMONTHWEEKDAYHOURMINUTESECONDMILLISECOND
HierarchyId -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Measures -> (list)
A list of measures that exist in the field well.
(structure)
The measure (metric) type field.
NumericalMeasureField -> (structure)
The measure type field with numerical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the NumericalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
FormatConfiguration -> (structure)
The format configuration of the field.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CategoricalMeasureField -> (structure)
The measure type field with categorical type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the CategoricalMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateMeasureField -> (structure)
The measure type field with date type columns.
FieldId -> (string)
Column -> (structure)
The column that is used in the DateMeasureField .
DataSetIdentifier -> (string)
ColumnName -> (string)
AggregationFunction -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CalculatedMeasureField -> (structure)
The calculated measure field only used in pivot tables.
FieldId -> (string)
Expression -> (string)
Unaggregated -> (list)
A list of unaggregated fields that exist in the field well.
(structure)
The unaggregated field for a table.
FieldId -> (string)
Column -> (structure)
The column that is used in the UnaggregatedField .
DataSetIdentifier -> (string)
ColumnName -> (string)
FormatConfiguration -> (structure)
The format configuration of the field.
StringFormatConfiguration -> (structure)
Formatting configuration for string fields.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumberFormatConfiguration -> (structure)
Formatting configuration for number fields.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateTimeFormatConfiguration -> (structure)
Formatting configuration for DateTime fields.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
VisualOptions -> (structure)
The persisted properties of the plugin visual.
VisualProperties -> (list)
The persisted properties and their values.
(structure)
The key value pair of the persisted property.
Name -> (string)
Value -> (string)
SortConfiguration -> (structure)
The sort configuration of the plugin visual.
PluginVisualTableQuerySort -> (structure)
The table query sorting options for the plugin visual.
RowSort -> (list)
Determines how data is sorted in the response.
(structure)
The field sort options in a chart configuration.
FieldSort -> (structure)
The sort configuration for a field in a field well.
FieldId -> (string)
Direction -> (string)
The sort direction. Choose one of the following options:
-
ASC: Ascending -
DESC: Descending
ColumnSort -> (structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.ItemsLimitConfiguration -> (structure)
The maximum amount of data to be returned by a query.
ItemsLimit -> (long)
VisualContentAltText -> (string)
TextBoxes -> (list)
The text boxes that are on a sheet.
(structure)
A text box.
SheetTextBoxId -> (string)
Content -> (string)
Images -> (list)
A list of images on a sheet.
(structure)
An image that is located on a sheet.
SheetImageId -> (string)
Source -> (structure)
The source of the image.
SheetImageStaticFileSource -> (structure)
The source of the static file that contains the image.
StaticFileId -> (string)
Scaling -> (structure)
Determines how the image is scaled.
ScalingType -> (string)
The scaling option to use when fitting the image inside the container.
Valid values are defined as follows:
-
SCALE_TO_WIDTH: The image takes up the entire width of the container. The image aspect ratio is preserved. -
SCALE_TO_HEIGHT: The image takes up the entire height of the container. The image aspect ratio is preserved. -
SCALE_TO_CONTAINER: The image takes up the entire width and height of the container. The image aspect ratio is not preserved. -
SCALE_NONE: The image is displayed in its original size and is not scaled to the container.
Tooltip -> (structure)
The tooltip to be shown when hovering over the image.
TooltipText -> (structure)
The text that appears in the tooltip.
PlainText -> (string)
Visibility -> (string)
ImageContentAltText -> (string)
Interactions -> (structure)
The general image interactions setup for an image.
ImageMenuOption -> (structure)
The menu options for the image.
AvailabilityStatus -> (string)
ENABLED , dashboard readers can interact with the image menu.Actions -> (list)
A list of custom actions that are configured for an image.
(structure)
A custom action defined on an image.
CustomActionId -> (string)
Name -> (string)
Status -> (string)
Trigger -> (string)
The trigger of the VisualCustomAction .
Valid values are defined as follows:
-
CLICK: Initiates a custom action by a left pointer click on a data point. -
MENU: Initiates a custom action by right pointer click from the menu.
ActionOperations -> (list)
A list of ImageCustomActionOperations .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
(structure)
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.
NavigationOperation -> (structure)
The navigation operation that navigates between different sheets in the same analysis.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
LocalNavigationConfiguration -> (structure)
The configuration that chooses the navigation target.
TargetSheetId -> (string)
URLOperation -> (structure)
The URL operation that opens a link to another webpage.
URLTemplate -> (string)
CustomActionURLOperation .URLTarget -> (string)
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 -> (structure)
The set parameter operation that sets parameters in custom action.
ParameterValueConfigurations -> (list)
The parameter that determines the value configuration.
(structure)
The configuration of adding parameters in action.
DestinationParameterName -> (string)
SetParameterValueConfiguration .Value -> (structure)
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 -> (structure)
The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
IncludeNullValue -> (boolean)
CustomValues -> (structure)
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.
(long)
DecimalValues -> (list)
A list of decimal-type parameter values.
(double)
DateTimeValues -> (list)
A list of datetime-type parameter values.
(timestamp)
SelectAllValueOptions -> (string)
SourceParameterName -> (string)
SourceField -> (string)
SourceColumn -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
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 .
(structure)
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 -> (structure)
The configuration that determines what the type of layout for a sheet.
GridLayout -> (structure)
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)
The elements that are included in a grid layout.
(structure)
An element within a grid layout.
ElementId -> (string)
ElementType -> (string)
ColumnIndex -> (integer)
ColumnSpan -> (integer)
RowIndex -> (integer)
RowSpan -> (integer)
CanvasSizeOptions -> (structure)
Configuration options for the canvas of a grid layout.
ScreenCanvasSizeOptions -> (structure)
The options that determine the sizing of the canvas used in a grid layout.
ResizeOption -> (string)
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 calledClassic. -
RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is calledTiled.
OptimizedViewPortWidth -> (string)
FreeFormLayout -> (structure)
A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
Elements -> (list)
The elements that are included in a free-form layout.
(structure)
An element within a free-form layout.
ElementId -> (string)
ElementType -> (string)
XAxisLocation -> (string)
YAxisLocation -> (string)
Width -> (string)
Height -> (string)
Visibility -> (string)
RenderingRules -> (list)
The rendering rules that determine when an element should be displayed within a free-form layout.
(structure)
The rendering rules of a sheet that uses a free-form layout.
Expression -> (string)
ConfigurationOverrides -> (structure)
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:
VISIBLEHIDDEN
BorderStyle -> (structure)
The border style configuration of a free-form layout element.
Visibility -> (string)
Color -> (string)
SelectedBorderStyle -> (structure)
The border style configuration of a free-form layout element. This border style is used when the element is selected.
Visibility -> (string)
Color -> (string)
BackgroundStyle -> (structure)
The background style configuration of a free-form layout element.
Visibility -> (string)
Color -> (string)
LoadingAnimation -> (structure)
The loading animation configuration of a free-form layout element.
Visibility -> (string)
LoadingAnimation .CanvasSizeOptions -> (structure)
Configuration options for the canvas of a free-form layout.
ScreenCanvasSizeOptions -> (structure)
The options that determine the sizing of the canvas used in a free-form layout.
OptimizedViewPortWidth -> (string)
SectionBasedLayout -> (structure)
A section based layout organizes visuals into multiple sections and has customized header, footer and page break.
HeaderSections -> (list)
A list of header section configurations.
(structure)
The configuration of a header or footer section.
SectionId -> (string)
Layout -> (structure)
The layout configuration of the header or footer section.
FreeFormLayout -> (structure)
The free-form layout configuration of a section.
Elements -> (list)
The elements that are included in the free-form layout.
(structure)
An element within a free-form layout.
ElementId -> (string)
ElementType -> (string)
XAxisLocation -> (string)
YAxisLocation -> (string)
Width -> (string)
Height -> (string)
Visibility -> (string)
RenderingRules -> (list)
The rendering rules that determine when an element should be displayed within a free-form layout.
(structure)
The rendering rules of a sheet that uses a free-form layout.
Expression -> (string)
ConfigurationOverrides -> (structure)
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:
VISIBLEHIDDEN
BorderStyle -> (structure)
The border style configuration of a free-form layout element.
Visibility -> (string)
Color -> (string)
SelectedBorderStyle -> (structure)
The border style configuration of a free-form layout element. This border style is used when the element is selected.
Visibility -> (string)
Color -> (string)
BackgroundStyle -> (structure)
The background style configuration of a free-form layout element.
Visibility -> (string)
Color -> (string)
LoadingAnimation -> (structure)
The loading animation configuration of a free-form layout element.
Visibility -> (string)
LoadingAnimation .Style -> (structure)
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 -> (structure)
The spacing between section content and its top, bottom, left, and right edges.
There is no padding by default.
Top -> (string)
Bottom -> (string)
Left -> (string)
Right -> (string)
BodySections -> (list)
A list of body section configurations.
(structure)
The configuration of a body section.
SectionId -> (string)
Content -> (structure)
The configuration of content in a body section.
Layout -> (structure)
The layout configuration of a body section.
FreeFormLayout -> (structure)
The free-form layout configuration of a section.
Elements -> (list)
The elements that are included in the free-form layout.
(structure)
An element within a free-form layout.
ElementId -> (string)
ElementType -> (string)
XAxisLocation -> (string)
YAxisLocation -> (string)
Width -> (string)
Height -> (string)
Visibility -> (string)
RenderingRules -> (list)
The rendering rules that determine when an element should be displayed within a free-form layout.
(structure)
The rendering rules of a sheet that uses a free-form layout.
Expression -> (string)
ConfigurationOverrides -> (structure)
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:
VISIBLEHIDDEN
BorderStyle -> (structure)
The border style configuration of a free-form layout element.
Visibility -> (string)
Color -> (string)
SelectedBorderStyle -> (structure)
The border style configuration of a free-form layout element. This border style is used when the element is selected.
Visibility -> (string)
Color -> (string)
BackgroundStyle -> (structure)
The background style configuration of a free-form layout element.
Visibility -> (string)
Color -> (string)
LoadingAnimation -> (structure)
The loading animation configuration of a free-form layout element.
Visibility -> (string)
LoadingAnimation .Style -> (structure)
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 -> (structure)
The spacing between section content and its top, bottom, left, and right edges.
There is no padding by default.
Top -> (string)
Bottom -> (string)
Left -> (string)
Right -> (string)
PageBreakConfiguration -> (structure)
The configuration of a page break for a section.
After -> (structure)
The configuration of a page break after a section.
Status -> (string)
RepeatConfiguration -> (structure)
Describes the configurations that are required to declare a section as repeating.
DimensionConfigurations -> (list)
List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.
(structure)
Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either Category or Numeric column configuration
DynamicCategoryDimensionConfiguration -> (structure)
Describes the Category dataset column and constraints around the dynamic values that will be used in repeating the section contents.
Column -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Limit -> (integer)
SortByMetrics -> (list)
Sort criteria on the column values that you use for repetition.
(structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.DynamicNumericDimensionConfiguration -> (structure)
Describes the Numeric dataset column and constraints around the dynamic values used to repeat the contents of a section.
Column -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Limit -> (integer)
SortByMetrics -> (list)
Sort criteria on the column values that you use for repetition.
(structure)
The sort configuration for a column that is not used in a field well.
SortBy -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Direction -> (string)
AggregationFunction -> (structure)
The aggregation function that is defined in the column sort.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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 ‘*’.PageBreakConfiguration -> (structure)
Page break configuration to apply for each repeating instance.
After -> (structure)
The configuration of a page break after a section.
Status -> (string)
NonRepeatingVisuals -> (list)
List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.
(string)
FooterSections -> (list)
A list of footer section configurations.
(structure)
The configuration of a header or footer section.
SectionId -> (string)
Layout -> (structure)
The layout configuration of the header or footer section.
FreeFormLayout -> (structure)
The free-form layout configuration of a section.
Elements -> (list)
The elements that are included in the free-form layout.
(structure)
An element within a free-form layout.
ElementId -> (string)
ElementType -> (string)
XAxisLocation -> (string)
YAxisLocation -> (string)
Width -> (string)
Height -> (string)
Visibility -> (string)
RenderingRules -> (list)
The rendering rules that determine when an element should be displayed within a free-form layout.
(structure)
The rendering rules of a sheet that uses a free-form layout.
Expression -> (string)
ConfigurationOverrides -> (structure)
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:
VISIBLEHIDDEN
BorderStyle -> (structure)
The border style configuration of a free-form layout element.
Visibility -> (string)
Color -> (string)
SelectedBorderStyle -> (structure)
The border style configuration of a free-form layout element. This border style is used when the element is selected.
Visibility -> (string)
Color -> (string)
BackgroundStyle -> (structure)
The background style configuration of a free-form layout element.
Visibility -> (string)
Color -> (string)
LoadingAnimation -> (structure)
The loading animation configuration of a free-form layout element.
Visibility -> (string)
LoadingAnimation .Style -> (structure)
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 -> (structure)
The spacing between section content and its top, bottom, left, and right edges.
There is no padding by default.
Top -> (string)
Bottom -> (string)
Left -> (string)
Right -> (string)
CanvasSizeOptions -> (structure)
The options for the canvas of a section-based layout.
PaperCanvasSizeOptions -> (structure)
The options for a paper canvas of a section-based layout.
PaperSize -> (string)
PaperOrientation -> (string)
The paper orientation that is used to define canvas dimensions. Choose one of the following options:
- PORTRAIT
- LANDSCAPE
PaperMargin -> (structure)
Defines the spacing between the canvas content and the top, bottom, left, and right edges.
Top -> (string)
Bottom -> (string)
Left -> (string)
Right -> (string)
SheetControlLayouts -> (list)
The control layouts of the sheet.
(structure)
A grid layout to define the placement of sheet control.
Configuration -> (structure)
The configuration that determines the elements and canvas size options of sheet control.
GridLayout -> (structure)
The configuration that determines the elements and canvas size options of sheet control.
Elements -> (list)
The elements that are included in a grid layout.
(structure)
An element within a grid layout.
ElementId -> (string)
ElementType -> (string)
ColumnIndex -> (integer)
ColumnSpan -> (integer)
RowIndex -> (integer)
RowSpan -> (integer)
CanvasSizeOptions -> (structure)
Configuration options for the canvas of a grid layout.
ScreenCanvasSizeOptions -> (structure)
The options that determine the sizing of the canvas used in a grid layout.
ResizeOption -> (string)
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 calledClassic. -
RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is calledTiled.
OptimizedViewPortWidth -> (string)
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.
CustomActionDefaults -> (structure)
A list of visual custom actions for the sheet.
highlightOperation -> (structure)
A list of highlight operations available for visuals in an analysis or sheet.
Trigger -> (string)
CalculatedFields -> (list)
An array of calculated field definitions for the dashboard.
(structure)
The calculated field of an analysis.
DataSetIdentifier -> (string)
Name -> (string)
Expression -> (string)
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 .
(structure)
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 -> (structure)
A parameter declaration for the String data type.
ParameterValueType -> (string)
Name -> (string)
DefaultValues -> (structure)
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
DynamicValue -> (structure)
The dynamic value of the StringDefaultValues . Different defaults displayed according to users, groups, and values mapping.
UserNameColumn -> (structure)
The column that contains the username.
DataSetIdentifier -> (string)
ColumnName -> (string)
GroupNameColumn -> (structure)
The column that contains the group name.
DataSetIdentifier -> (string)
ColumnName -> (string)
DefaultValueColumn -> (structure)
The column that contains the default value of each user or group.
DataSetIdentifier -> (string)
ColumnName -> (string)
StaticValues -> (list)
The static values of the DecimalDefaultValues .
(string)
ValueWhenUnset -> (structure)
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: TheNULLvalue.
CustomValue -> (string)
MappedDataSetParameters -> (list)
A list of dataset parameters that are mapped to an analysis parameter.
(structure)
A dataset parameter that is mapped to an analysis parameter.
DataSetIdentifier -> (string)
DataSetParameterName -> (string)
DecimalParameterDeclaration -> (structure)
A parameter declaration for the Decimal data type.
ParameterValueType -> (string)
Name -> (string)
DefaultValues -> (structure)
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
DynamicValue -> (structure)
The dynamic value of the DecimalDefaultValues . Different defaults are displayed according to users, groups, and values mapping.
UserNameColumn -> (structure)
The column that contains the username.
DataSetIdentifier -> (string)
ColumnName -> (string)
GroupNameColumn -> (structure)
The column that contains the group name.
DataSetIdentifier -> (string)
ColumnName -> (string)
DefaultValueColumn -> (structure)
The column that contains the default value of each user or group.
DataSetIdentifier -> (string)
ColumnName -> (string)
StaticValues -> (list)
The static values of the DecimalDefaultValues .
(double)
ValueWhenUnset -> (structure)
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: TheNULLvalue.
CustomValue -> (double)
MappedDataSetParameters -> (list)
A list of dataset parameters that are mapped to an analysis parameter.
(structure)
A dataset parameter that is mapped to an analysis parameter.
DataSetIdentifier -> (string)
DataSetParameterName -> (string)
IntegerParameterDeclaration -> (structure)
A parameter declaration for the Integer data type.
ParameterValueType -> (string)
Name -> (string)
DefaultValues -> (structure)
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
DynamicValue -> (structure)
The dynamic value of the IntegerDefaultValues . Different defaults are displayed according to users, groups, and values mapping.
UserNameColumn -> (structure)
The column that contains the username.
DataSetIdentifier -> (string)
ColumnName -> (string)
GroupNameColumn -> (structure)
The column that contains the group name.
DataSetIdentifier -> (string)
ColumnName -> (string)
DefaultValueColumn -> (structure)
The column that contains the default value of each user or group.
DataSetIdentifier -> (string)
ColumnName -> (string)
StaticValues -> (list)
The static values of the IntegerDefaultValues .
(long)
ValueWhenUnset -> (structure)
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: TheNULLvalue.
CustomValue -> (long)
MappedDataSetParameters -> (list)
A list of dataset parameters that are mapped to an analysis parameter.
(structure)
A dataset parameter that is mapped to an analysis parameter.
DataSetIdentifier -> (string)
DataSetParameterName -> (string)
DateTimeParameterDeclaration -> (structure)
A parameter declaration for the DateTime data type.
Name -> (string)
DefaultValues -> (structure)
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
DynamicValue -> (structure)
The dynamic value of the DataTimeDefaultValues . Different defaults are displayed according to users, groups, and values mapping.
UserNameColumn -> (structure)
The column that contains the username.
DataSetIdentifier -> (string)
ColumnName -> (string)
GroupNameColumn -> (structure)
The column that contains the group name.
DataSetIdentifier -> (string)
ColumnName -> (string)
DefaultValueColumn -> (structure)
The column that contains the default value of each user or group.
DataSetIdentifier -> (string)
ColumnName -> (string)
StaticValues -> (list)
The static values of the DataTimeDefaultValues .
(timestamp)
RollingDate -> (structure)
The rolling date of the DataTimeDefaultValues . The date is determined from the dataset based on input expression.
DataSetIdentifier -> (string)
Expression -> (string)
TimeGranularity -> (string)
DateTime values.ValueWhenUnset -> (structure)
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: TheNULLvalue.
CustomValue -> (timestamp)
MappedDataSetParameters -> (list)
A list of dataset parameters that are mapped to an analysis parameter.
(structure)
A dataset parameter that is mapped to an analysis parameter.
DataSetIdentifier -> (string)
DataSetParameterName -> (string)
FilterGroups -> (list)
The filter definitions for a dashboard.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide .
(structure)
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)
FilterGroup within a dashboard, template, or analysis.Filters -> (list)
The list of filters that are present in a FilterGroup .
(structure)
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 -> (structure)
A CategoryFilter filters text values.
For more information, see Adding text filters in the Amazon QuickSight User Guide .
FilterId -> (string)
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Configuration -> (structure)
The configuration for a CategoryFilter .
FilterListConfiguration -> (structure)
A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.
MatchOperator -> (string)
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 -> (structure)
A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.
MatchOperator -> (string)
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.
CustomFilterConfiguration -> (structure)
A custom filter that filters based on a single value. This filter can be partially matched.
MatchOperator -> (string)
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)
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.
DefaultFilterControlConfiguration -> (structure)
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Title -> (string)
DefaultFilterControlConfiguration . This title is shared by all controls that are tied to this filter.ControlOptions -> (structure)
The control option for the DefaultFilterControlConfiguration .
DefaultDateTimePickerOptions -> (structure)
The default options that correspond to the filter control type of a DateTimePicker .
Type -> (string)
The date time picker type of the DefaultDateTimePickerControlOptions . 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.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
HelperTextVisibility -> (string)
DateTimePickerControlDisplayOptions .DateIconVisibility -> (string)
DateTimePickerControlDisplayOptions .CommitMode -> (string)
DateTimePickerControl .DefaultListOptions -> (structure)
The default options that correspond to the List filter control type.
DisplayOptions -> (structure)
The display options of a control.
SearchOptions -> (structure)
The configuration of the search options in a list control.
Visibility -> (string)
SelectAllOptions -> (structure)
The configuration of the Select all options in a list control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultFilterListControlOptions . 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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
DefaultDropdownOptions -> (structure)
The default options that correspond to the Dropdown filter control type.
DisplayOptions -> (structure)
The display options of a control.
SelectAllOptions -> (structure)
The configuration of the Select all options in a dropdown control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
CommitMode -> (string)
FilterDropDownControl .DefaultTextFieldOptions -> (structure)
The default options that correspond to the TextField filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text field control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultTextAreaOptions -> (structure)
The default options that correspond to the TextArea filter control type.
Delimiter -> (string)
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text area control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultSliderOptions -> (structure)
The default options that correspond to the Slider filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultSliderControlOptions . 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 -> (double)
MinimumValue -> (double)
StepSize -> (double)
DefaultRelativeDateTimeOptions -> (structure)
The default options that correspond to the RelativeDateTime filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
CommitMode -> (string)
RelativeDateTimeControl .NumericRangeFilter -> (structure)
A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
FilterId -> (string)
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
IncludeMinimum -> (boolean)
IncludeMaximum -> (boolean)
RangeMinimum -> (structure)
The minimum value for the filter value range.
StaticValue -> (double)
Parameter -> (string)
RangeMaximum -> (structure)
The maximum value for the filter value range.
StaticValue -> (double)
Parameter -> (string)
SelectAllOptions -> (string)
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
AggregationFunction -> (structure)
The aggregation function of the filter.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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)
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.
DefaultFilterControlConfiguration -> (structure)
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Title -> (string)
DefaultFilterControlConfiguration . This title is shared by all controls that are tied to this filter.ControlOptions -> (structure)
The control option for the DefaultFilterControlConfiguration .
DefaultDateTimePickerOptions -> (structure)
The default options that correspond to the filter control type of a DateTimePicker .
Type -> (string)
The date time picker type of the DefaultDateTimePickerControlOptions . 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.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
HelperTextVisibility -> (string)
DateTimePickerControlDisplayOptions .DateIconVisibility -> (string)
DateTimePickerControlDisplayOptions .CommitMode -> (string)
DateTimePickerControl .DefaultListOptions -> (structure)
The default options that correspond to the List filter control type.
DisplayOptions -> (structure)
The display options of a control.
SearchOptions -> (structure)
The configuration of the search options in a list control.
Visibility -> (string)
SelectAllOptions -> (structure)
The configuration of the Select all options in a list control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultFilterListControlOptions . 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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
DefaultDropdownOptions -> (structure)
The default options that correspond to the Dropdown filter control type.
DisplayOptions -> (structure)
The display options of a control.
SelectAllOptions -> (structure)
The configuration of the Select all options in a dropdown control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
CommitMode -> (string)
FilterDropDownControl .DefaultTextFieldOptions -> (structure)
The default options that correspond to the TextField filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text field control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultTextAreaOptions -> (structure)
The default options that correspond to the TextArea filter control type.
Delimiter -> (string)
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text area control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultSliderOptions -> (structure)
The default options that correspond to the Slider filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultSliderControlOptions . 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 -> (double)
MinimumValue -> (double)
StepSize -> (double)
DefaultRelativeDateTimeOptions -> (structure)
The default options that correspond to the RelativeDateTime filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
CommitMode -> (string)
RelativeDateTimeControl .NumericEqualityFilter -> (structure)
A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
FilterId -> (string)
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (double)
SelectAllOptions -> (string)
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
MatchOperator -> (string)
AggregationFunction -> (structure)
The aggregation function of the filter.
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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)
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.
DefaultFilterControlConfiguration -> (structure)
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Title -> (string)
DefaultFilterControlConfiguration . This title is shared by all controls that are tied to this filter.ControlOptions -> (structure)
The control option for the DefaultFilterControlConfiguration .
DefaultDateTimePickerOptions -> (structure)
The default options that correspond to the filter control type of a DateTimePicker .
Type -> (string)
The date time picker type of the DefaultDateTimePickerControlOptions . 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.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
HelperTextVisibility -> (string)
DateTimePickerControlDisplayOptions .DateIconVisibility -> (string)
DateTimePickerControlDisplayOptions .CommitMode -> (string)
DateTimePickerControl .DefaultListOptions -> (structure)
The default options that correspond to the List filter control type.
DisplayOptions -> (structure)
The display options of a control.
SearchOptions -> (structure)
The configuration of the search options in a list control.
Visibility -> (string)
SelectAllOptions -> (structure)
The configuration of the Select all options in a list control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultFilterListControlOptions . 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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
DefaultDropdownOptions -> (structure)
The default options that correspond to the Dropdown filter control type.
DisplayOptions -> (structure)
The display options of a control.
SelectAllOptions -> (structure)
The configuration of the Select all options in a dropdown control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
CommitMode -> (string)
FilterDropDownControl .DefaultTextFieldOptions -> (structure)
The default options that correspond to the TextField filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text field control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultTextAreaOptions -> (structure)
The default options that correspond to the TextArea filter control type.
Delimiter -> (string)
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text area control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultSliderOptions -> (structure)
The default options that correspond to the Slider filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultSliderControlOptions . 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 -> (double)
MinimumValue -> (double)
StepSize -> (double)
DefaultRelativeDateTimeOptions -> (structure)
The default options that correspond to the RelativeDateTime filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
CommitMode -> (string)
RelativeDateTimeControl .TimeEqualityFilter -> (structure)
A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
FilterId -> (string)
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Value -> (timestamp)
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)
DateTime values.RollingDate -> (structure)
The rolling date input for the TimeEquality filter.
This field is mutually exclusive to Value and ParameterName .
DataSetIdentifier -> (string)
Expression -> (string)
DefaultFilterControlConfiguration -> (structure)
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Title -> (string)
DefaultFilterControlConfiguration . This title is shared by all controls that are tied to this filter.ControlOptions -> (structure)
The control option for the DefaultFilterControlConfiguration .
DefaultDateTimePickerOptions -> (structure)
The default options that correspond to the filter control type of a DateTimePicker .
Type -> (string)
The date time picker type of the DefaultDateTimePickerControlOptions . 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.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
HelperTextVisibility -> (string)
DateTimePickerControlDisplayOptions .DateIconVisibility -> (string)
DateTimePickerControlDisplayOptions .CommitMode -> (string)
DateTimePickerControl .DefaultListOptions -> (structure)
The default options that correspond to the List filter control type.
DisplayOptions -> (structure)
The display options of a control.
SearchOptions -> (structure)
The configuration of the search options in a list control.
Visibility -> (string)
SelectAllOptions -> (structure)
The configuration of the Select all options in a list control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultFilterListControlOptions . 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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
DefaultDropdownOptions -> (structure)
The default options that correspond to the Dropdown filter control type.
DisplayOptions -> (structure)
The display options of a control.
SelectAllOptions -> (structure)
The configuration of the Select all options in a dropdown control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
CommitMode -> (string)
FilterDropDownControl .DefaultTextFieldOptions -> (structure)
The default options that correspond to the TextField filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text field control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultTextAreaOptions -> (structure)
The default options that correspond to the TextArea filter control type.
Delimiter -> (string)
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text area control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultSliderOptions -> (structure)
The default options that correspond to the Slider filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultSliderControlOptions . 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 -> (double)
MinimumValue -> (double)
StepSize -> (double)
DefaultRelativeDateTimeOptions -> (structure)
The default options that correspond to the RelativeDateTime filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
CommitMode -> (string)
RelativeDateTimeControl .TimeRangeFilter -> (structure)
A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
FilterId -> (string)
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
IncludeMinimum -> (boolean)
IncludeMaximum -> (boolean)
RangeMinimumValue -> (structure)
The minimum value for the filter value range.
StaticValue -> (timestamp)
RollingDate -> (structure)
The rolling date input value.
DataSetIdentifier -> (string)
Expression -> (string)
Parameter -> (string)
RangeMaximumValue -> (structure)
The maximum value for the filter value range.
StaticValue -> (timestamp)
RollingDate -> (structure)
The rolling date input value.
DataSetIdentifier -> (string)
Expression -> (string)
Parameter -> (string)
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.
ExcludePeriodConfiguration -> (structure)
The exclude period of the time range filter.
Amount -> (integer)
Granularity -> (string)
Status -> (string)
The status of the exclude period. Choose from the following options:
ENABLEDDISABLED
TimeGranularity -> (string)
DateTime values.DefaultFilterControlConfiguration -> (structure)
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Title -> (string)
DefaultFilterControlConfiguration . This title is shared by all controls that are tied to this filter.ControlOptions -> (structure)
The control option for the DefaultFilterControlConfiguration .
DefaultDateTimePickerOptions -> (structure)
The default options that correspond to the filter control type of a DateTimePicker .
Type -> (string)
The date time picker type of the DefaultDateTimePickerControlOptions . 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.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
HelperTextVisibility -> (string)
DateTimePickerControlDisplayOptions .DateIconVisibility -> (string)
DateTimePickerControlDisplayOptions .CommitMode -> (string)
DateTimePickerControl .DefaultListOptions -> (structure)
The default options that correspond to the List filter control type.
DisplayOptions -> (structure)
The display options of a control.
SearchOptions -> (structure)
The configuration of the search options in a list control.
Visibility -> (string)
SelectAllOptions -> (structure)
The configuration of the Select all options in a list control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultFilterListControlOptions . 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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
DefaultDropdownOptions -> (structure)
The default options that correspond to the Dropdown filter control type.
DisplayOptions -> (structure)
The display options of a control.
SelectAllOptions -> (structure)
The configuration of the Select all options in a dropdown control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
CommitMode -> (string)
FilterDropDownControl .DefaultTextFieldOptions -> (structure)
The default options that correspond to the TextField filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text field control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultTextAreaOptions -> (structure)
The default options that correspond to the TextArea filter control type.
Delimiter -> (string)
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text area control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultSliderOptions -> (structure)
The default options that correspond to the Slider filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultSliderControlOptions . 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 -> (double)
MinimumValue -> (double)
StepSize -> (double)
DefaultRelativeDateTimeOptions -> (structure)
The default options that correspond to the RelativeDateTime filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
CommitMode -> (string)
RelativeDateTimeControl .RelativeDatesFilter -> (structure)
A RelativeDatesFilter filters date values that are relative to a given date.
FilterId -> (string)
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
AnchorDateConfiguration -> (structure)
The date configuration of the filter.
AnchorOption -> (string)
The options for the date configuration. Choose one of the options below:
NOW
ParameterName -> (string)
MinimumGranularity -> (string)
TimeGranularity -> (string)
DateTime values.RelativeDateType -> (string)
The range date type of the filter. Choose one of the options below:
PREVIOUSTHISLASTNOWNEXT
RelativeDateValue -> (integer)
ParameterName -> (string)
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.
ExcludePeriodConfiguration -> (structure)
The configuration for the exclude period of the filter.
Amount -> (integer)
Granularity -> (string)
Status -> (string)
The status of the exclude period. Choose from the following options:
ENABLEDDISABLED
DefaultFilterControlConfiguration -> (structure)
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Title -> (string)
DefaultFilterControlConfiguration . This title is shared by all controls that are tied to this filter.ControlOptions -> (structure)
The control option for the DefaultFilterControlConfiguration .
DefaultDateTimePickerOptions -> (structure)
The default options that correspond to the filter control type of a DateTimePicker .
Type -> (string)
The date time picker type of the DefaultDateTimePickerControlOptions . 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.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
HelperTextVisibility -> (string)
DateTimePickerControlDisplayOptions .DateIconVisibility -> (string)
DateTimePickerControlDisplayOptions .CommitMode -> (string)
DateTimePickerControl .DefaultListOptions -> (structure)
The default options that correspond to the List filter control type.
DisplayOptions -> (structure)
The display options of a control.
SearchOptions -> (structure)
The configuration of the search options in a list control.
Visibility -> (string)
SelectAllOptions -> (structure)
The configuration of the Select all options in a list control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultFilterListControlOptions . 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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
DefaultDropdownOptions -> (structure)
The default options that correspond to the Dropdown filter control type.
DisplayOptions -> (structure)
The display options of a control.
SelectAllOptions -> (structure)
The configuration of the Select all options in a dropdown control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
CommitMode -> (string)
FilterDropDownControl .DefaultTextFieldOptions -> (structure)
The default options that correspond to the TextField filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text field control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultTextAreaOptions -> (structure)
The default options that correspond to the TextArea filter control type.
Delimiter -> (string)
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text area control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultSliderOptions -> (structure)
The default options that correspond to the Slider filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultSliderControlOptions . 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 -> (double)
MinimumValue -> (double)
StepSize -> (double)
DefaultRelativeDateTimeOptions -> (structure)
The default options that correspond to the RelativeDateTime filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
CommitMode -> (string)
RelativeDateTimeControl .TopBottomFilter -> (structure)
A TopBottomFilter filters data to the top or bottom values for a given column.
FilterId -> (string)
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
Limit -> (integer)
AggregationSortConfigurations -> (list)
The aggregation and sort configuration of the top bottom filter.
(structure)
The configuration options to sort aggregated values.
Column -> (structure)
The column that determines the sort order of aggregated values.
DataSetIdentifier -> (string)
ColumnName -> (string)
SortDirection -> (string)
The sort direction of values.
-
ASC: Sort in ascending order. -
DESC: Sort in descending order.
AggregationFunction -> (structure)
The function that aggregates the values in Column .
NumericalAggregationFunction -> (structure)
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 -> (structure)
An aggregation based on the percentile of values in a dimension or measure.
PercentileValue -> (double)
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 -> (structure)
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)
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)
DateTime values.ParameterName -> (string)
DefaultFilterControlConfiguration -> (structure)
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Title -> (string)
DefaultFilterControlConfiguration . This title is shared by all controls that are tied to this filter.ControlOptions -> (structure)
The control option for the DefaultFilterControlConfiguration .
DefaultDateTimePickerOptions -> (structure)
The default options that correspond to the filter control type of a DateTimePicker .
Type -> (string)
The date time picker type of the DefaultDateTimePickerControlOptions . 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.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
HelperTextVisibility -> (string)
DateTimePickerControlDisplayOptions .DateIconVisibility -> (string)
DateTimePickerControlDisplayOptions .CommitMode -> (string)
DateTimePickerControl .DefaultListOptions -> (structure)
The default options that correspond to the List filter control type.
DisplayOptions -> (structure)
The display options of a control.
SearchOptions -> (structure)
The configuration of the search options in a list control.
Visibility -> (string)
SelectAllOptions -> (structure)
The configuration of the Select all options in a list control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultFilterListControlOptions . 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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
DefaultDropdownOptions -> (structure)
The default options that correspond to the Dropdown filter control type.
DisplayOptions -> (structure)
The display options of a control.
SelectAllOptions -> (structure)
The configuration of the Select all options in a dropdown control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
CommitMode -> (string)
FilterDropDownControl .DefaultTextFieldOptions -> (structure)
The default options that correspond to the TextField filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text field control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultTextAreaOptions -> (structure)
The default options that correspond to the TextArea filter control type.
Delimiter -> (string)
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text area control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultSliderOptions -> (structure)
The default options that correspond to the Slider filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultSliderControlOptions . 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 -> (double)
MinimumValue -> (double)
StepSize -> (double)
DefaultRelativeDateTimeOptions -> (structure)
The default options that correspond to the RelativeDateTime filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
CommitMode -> (string)
RelativeDateTimeControl .NestedFilter -> (structure)
A NestedFilter filters data with a subset of data that is defined by the nested inner filter.
FilterId -> (string)
Column -> (structure)
The column that the filter is applied to.
DataSetIdentifier -> (string)
ColumnName -> (string)
IncludeInnerSet -> (boolean)
InnerFilter -> (structure)
The InnerFilter defines the subset of data to be used with the NestedFilter .
CategoryInnerFilter -> (structure)
A CategoryInnerFilter filters text values for the NestedFilter .
Column -> (structure)
A column of a data set.
DataSetIdentifier -> (string)
ColumnName -> (string)
Configuration -> (structure)
The configuration for a CategoryFilter .
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
FilterListConfiguration -> (structure)
A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.
MatchOperator -> (string)
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 -> (structure)
A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.
MatchOperator -> (string)
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.
CustomFilterConfiguration -> (structure)
A custom filter that filters based on a single value. This filter can be partially matched.
MatchOperator -> (string)
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)
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.
DefaultFilterControlConfiguration -> (structure)
The default configuration for all dependent controls of the filter.
Title -> (string)
DefaultFilterControlConfiguration . This title is shared by all controls that are tied to this filter.ControlOptions -> (structure)
The control option for the DefaultFilterControlConfiguration .
DefaultDateTimePickerOptions -> (structure)
The default options that correspond to the filter control type of a DateTimePicker .
Type -> (string)
The date time picker type of the DefaultDateTimePickerControlOptions . 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.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
HelperTextVisibility -> (string)
DateTimePickerControlDisplayOptions .DateIconVisibility -> (string)
DateTimePickerControlDisplayOptions .CommitMode -> (string)
DateTimePickerControl .DefaultListOptions -> (structure)
The default options that correspond to the List filter control type.
DisplayOptions -> (structure)
The display options of a control.
SearchOptions -> (structure)
The configuration of the search options in a list control.
Visibility -> (string)
SelectAllOptions -> (structure)
The configuration of the Select all options in a list control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultFilterListControlOptions . 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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
DefaultDropdownOptions -> (structure)
The default options that correspond to the Dropdown filter control type.
DisplayOptions -> (structure)
The display options of a control.
SelectAllOptions -> (structure)
The configuration of the Select all options in a dropdown control.
Visibility -> (string)
Select all options in a list control.TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
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 -> (structure)
A list of selectable values that are used in a control.
Values -> (list)
The values that are used in the FilterSelectableValues .
(string)
CommitMode -> (string)
FilterDropDownControl .DefaultTextFieldOptions -> (structure)
The default options that correspond to the TextField filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text field control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultTextAreaOptions -> (structure)
The default options that correspond to the TextArea filter control type.
Delimiter -> (string)
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
PlaceholderOptions -> (structure)
The configuration of the placeholder options in a text area control.
Visibility -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
DefaultSliderOptions -> (structure)
The default options that correspond to the Slider filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
Type -> (string)
The type of the DefaultSliderControlOptions . 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 -> (double)
MinimumValue -> (double)
StepSize -> (double)
DefaultRelativeDateTimeOptions -> (structure)
The default options that correspond to the RelativeDateTime filter control type.
DisplayOptions -> (structure)
The display options of a control.
TitleOptions -> (structure)
The options to configure the title visibility, name, and font size.
Visibility -> (string)
FontConfiguration -> (structure)
The font configuration of the label.
FontSize -> (structure)
The option that determines the text display size.
Relative -> (string)
Absolute -> (string)
FontDecoration -> (string)
FontColor -> (string)
FontWeight -> (structure)
The option that determines the text display weight, or boldness.
Name -> (string)
FontStyle -> (string)
FontFamily -> (string)
CustomLabel -> (string)
DateTimeFormat -> (string)
InfoIconLabelOptions -> (structure)
The configuration of info icon label options.
Visibility -> (string)
InfoIconText -> (string)
CommitMode -> (string)
RelativeDateTimeControl .ScopeConfiguration -> (structure)
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 -> (structure)
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.
(structure)
The filter that is applied to the options.
SheetId -> (string)
Scope -> (string)
The scope of the applied entities. Choose one of the following options:
ALL_VISUALSSELECTED_VISUALS
VisualIds -> (list)
The selected visuals that the filter is applied to.
(string)
AllSheets -> (structure)
AllSheets as the value for a FilterScopeConfiguration , this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.Status -> (string)
FilterGroup .CrossDataset -> (string)
The filter new feature which can apply filter group to all data sets. Choose one of the following options:
ALL_DATASETSSINGLE_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.
(structure)
The general configuration of a column.
Column -> (structure)
The column.
DataSetIdentifier -> (string)
ColumnName -> (string)
FormatConfiguration -> (structure)
The format configuration of a column.
StringFormatConfiguration -> (structure)
Formatting configuration for string fields.
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric strings.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumberFormatConfiguration -> (structure)
Formatting configuration for number fields.
FormatConfiguration -> (structure)
The options that determine the numeric format configuration.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
DateTimeFormatConfiguration -> (structure)
Formatting configuration for DateTime fields.
DateTimeFormat -> (string)
DateTime format.NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
NumericFormatConfiguration -> (structure)
The formatting configuration for numeric DateTime fields.
NumberDisplayFormatConfiguration -> (structure)
The options that determine the number display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
CurrencyDisplayFormatConfiguration -> (structure)
The options that determine the currency display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.Symbol -> (string)
DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NumberScale -> (string)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
PercentageDisplayFormatConfiguration -> (structure)
The options that determine the percentage display format configuration.
Prefix -> (string)
Suffix -> (string)
SeparatorConfiguration -> (structure)
The options that determine the numeric separator configuration.
DecimalSeparator -> (string)
ThousandsSeparator -> (structure)
The options that determine the thousands separator configuration.
Symbol -> (string)
Visibility -> (string)
GroupingStyle -> (string)
DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.DecimalPlacesConfiguration -> (structure)
The option that determines the decimal places configuration.
DecimalPlaces -> (long)
NegativeValueConfiguration -> (structure)
The options that determine the negative value configuration.
DisplayMode -> (string)
NullValueFormatConfiguration -> (structure)
The options that determine the null value format configuration.
NullString -> (string)
Role -> (string)
ColorsConfiguration -> (structure)
The color configurations of the column.
CustomColors -> (list)
A list of up to 50 custom colors.
(structure)
Determines the color that’s applied to a particular data value in a column.
FieldValue -> (string)
Color -> (string)
SpecialValue -> (string)
AnalysisDefaults -> (structure)
The configuration for default analysis settings.
DefaultNewSheetConfiguration -> (structure)
The configuration for default new sheet settings.
InteractiveLayoutConfiguration -> (structure)
The options that determine the default settings for interactive layout configuration.
Grid -> (structure)
The options that determine the default settings for a grid layout configuration.
CanvasSizeOptions -> (structure)
Determines the screen canvas size options for a grid layout.
ScreenCanvasSizeOptions -> (structure)
The options that determine the sizing of the canvas used in a grid layout.
ResizeOption -> (string)
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 calledClassic. -
RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is calledTiled.
OptimizedViewPortWidth -> (string)
FreeForm -> (structure)
The options that determine the default settings of a free-form layout configuration.
CanvasSizeOptions -> (structure)
Determines the screen canvas size options for a free-form layout.
ScreenCanvasSizeOptions -> (structure)
The options that determine the sizing of the canvas used in a free-form layout.
OptimizedViewPortWidth -> (string)
PaginatedLayoutConfiguration -> (structure)
The options that determine the default settings for a paginated layout configuration.
SectionBased -> (structure)
The options that determine the default settings for a section-based layout configuration.
CanvasSizeOptions -> (structure)
Determines the screen canvas size options for a section-based layout.
PaperCanvasSizeOptions -> (structure)
The options for a paper canvas of a section-based layout.
PaperSize -> (string)
PaperOrientation -> (string)
The paper orientation that is used to define canvas dimensions. Choose one of the following options:
- PORTRAIT
- LANDSCAPE
PaperMargin -> (structure)
Defines the spacing between the canvas content and the top, bottom, left, and right edges.
Top -> (string)
Bottom -> (string)
Left -> (string)
Right -> (string)
SheetContentType -> (string)
Options -> (structure)
An array of option definitions for a dashboard.
Timezone -> (string)
WeekStart -> (string)
QBusinessInsightsStatus -> (string)
ExcludedDataSetArns -> (list)
A list of dataset ARNS to exclude from Dashboard Q&A.
(string)
CustomActionDefaults -> (structure)
A list of visual custom actions for the analysis.
highlightOperation -> (structure)
A list of highlight operations available for visuals in an analysis or sheet.
Trigger -> (string)
StaticFiles -> (list)
The static files for the definition.
(structure)
The static file.
ImageStaticFile -> (structure)
The image static file.
StaticFileId -> (string)
Source -> (structure)
The source of the image static file.
UrlOptions -> (structure)
The structure that contains the URL to download the static file from.
Url -> (string)
S3Options -> (structure)
The structure that contains the Amazon S3 location to download the static file from.
BucketName -> (string)
ObjectKey -> (string)
Region -> (string)
SpatialStaticFile -> (structure)
The spacial static file.
StaticFileId -> (string)
Source -> (structure)
The source of the spatial static file.
UrlOptions -> (structure)
The structure that contains the URL to download the static file from.
Url -> (string)
S3Options -> (structure)
The structure that contains the Amazon S3 location to download the static file from.
BucketName -> (string)
ObjectKey -> (string)
Region -> (string)
Status -> (integer)
RequestId -> (string)
DashboardPublishOptions -> (structure)
Options for publishing the dashboard:
-
AvailabilityStatusforAdHocFilteringOption- This status can be eitherENABLEDorDISABLED. When this is set toDISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLEDby default. -
AvailabilityStatusforExportToCSVOption- This status can be eitherENABLEDorDISABLED. The visual option to export data to .CSV format isn’t enabled when this is set toDISABLED. This option isENABLEDby default. -
VisibilityStateforSheetControlsOption- This visibility state can be eitherCOLLAPSEDorEXPANDED. This option isCOLLAPSEDby default.
AdHocFilteringOption -> (structure)
Ad hoc (one-time) filtering option.
AvailabilityStatus -> (string)
ExportToCSVOption -> (structure)
Export to .csv option.
AvailabilityStatus -> (string)
SheetControlsOption -> (structure)
Sheet controls option.
VisibilityState -> (string)
VisualPublishOptions -> (structure)
The visual publish options of a visual in a dashboard.
ExportHiddenFieldsOption -> (structure)
Determines if hidden fields are included in an exported dashboard.
AvailabilityStatus -> (string)
SheetLayoutElementMaximizationOption -> (structure)
The sheet layout maximization options of a dashbaord.
AvailabilityStatus -> (string)
VisualMenuOption -> (structure)
The menu options of a visual in a dashboard.
AvailabilityStatus -> (string)
VisualAxisSortOption -> (structure)
The axis sort options of a dashboard.
AvailabilityStatus -> (string)
ExportWithHiddenFieldsOption -> (structure)
Determines if hidden fields are exported with a dashboard.
AvailabilityStatus -> (string)
DataPointDrillUpDownOption -> (structure)
The drill-down options of data points in a dashboard.
AvailabilityStatus -> (string)
DataPointMenuLabelOption -> (structure)
The data point menu label options of a dashboard.
AvailabilityStatus -> (string)
DataPointTooltipOption -> (structure)
The data point tool tip options of a dashboard.
AvailabilityStatus -> (string)
DataQAEnabledOption -> (structure)
Adds Q&A capabilities to an Amazon QuickSight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.
AvailabilityStatus -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
