import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdateDashboardRequest, UpdateDashboardResponse } from "../models/models_4"; import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateDashboardCommand}. */ export interface UpdateDashboardCommandInput extends UpdateDashboardRequest { } /** * @public * * The output of {@link UpdateDashboardCommand}. */ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, __MetadataBearer { } declare const UpdateDashboardCommand_base: { new (input: UpdateDashboardCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: UpdateDashboardCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Updates a dashboard in an Amazon Web Services account.

* *

Updating a Dashboard creates a new dashboard version but does not immediately * publish the new version. You can update the published version of a dashboard by * using the * UpdateDashboardPublishedVersion * API operation.

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QuickSightClient, UpdateDashboardCommand } from "@aws-sdk/client-quicksight"; // ES Modules import * // const { QuickSightClient, UpdateDashboardCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import * // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight"; * const config = {}; // type is QuickSightClientConfig * const client = new QuickSightClient(config); * const input = { // UpdateDashboardRequest * AwsAccountId: "STRING_VALUE", // required * DashboardId: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * SourceEntity: { // DashboardSourceEntity * SourceTemplate: { // DashboardSourceTemplate * DataSetReferences: [ // DataSetReferenceList // required * { // DataSetReference * DataSetPlaceholder: "STRING_VALUE", // required * DataSetArn: "STRING_VALUE", // required * }, * ], * Arn: "STRING_VALUE", // required * }, * }, * Parameters: { // Parameters * StringParameters: [ // StringParameterList * { // StringParameter * Name: "STRING_VALUE", // required * Values: [ // SensitiveStringList // required * "STRING_VALUE", * ], * }, * ], * IntegerParameters: [ // IntegerParameterList * { // IntegerParameter * Name: "STRING_VALUE", // required * Values: [ // SensitiveLongList // required * Number("long"), * ], * }, * ], * DecimalParameters: [ // DecimalParameterList * { // DecimalParameter * Name: "STRING_VALUE", // required * Values: [ // SensitiveDoubleList // required * Number("double"), * ], * }, * ], * DateTimeParameters: [ // DateTimeParameterList * { // DateTimeParameter * Name: "STRING_VALUE", // required * Values: [ // SensitiveTimestampList // required * new Date("TIMESTAMP"), * ], * }, * ], * }, * VersionDescription: "STRING_VALUE", * DashboardPublishOptions: { // DashboardPublishOptions * AdHocFilteringOption: { // AdHocFilteringOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * ExportToCSVOption: { // ExportToCSVOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * SheetControlsOption: { // SheetControlsOption * VisibilityState: "EXPANDED" || "COLLAPSED", * }, * VisualPublishOptions: { // DashboardVisualPublishOptions * ExportHiddenFieldsOption: { // ExportHiddenFieldsOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * SheetLayoutElementMaximizationOption: { // SheetLayoutElementMaximizationOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * VisualMenuOption: { // VisualMenuOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * VisualAxisSortOption: { // VisualAxisSortOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * ExportWithHiddenFieldsOption: { // ExportWithHiddenFieldsOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * DataPointDrillUpDownOption: { // DataPointDrillUpDownOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * DataPointMenuLabelOption: { // DataPointMenuLabelOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * DataPointTooltipOption: { // DataPointTooltipOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * DataQAEnabledOption: { // DataQAEnabledOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * QuickSuiteActionsOption: { // QuickSuiteActionsOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * ExecutiveSummaryOption: { // ExecutiveSummaryOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * DataStoriesSharingOption: { // DataStoriesSharingOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * ThemeArn: "STRING_VALUE", * Definition: { // DashboardVersionDefinition * DataSetIdentifierDeclarations: [ // DataSetIdentifierDeclarationList // required * { // DataSetIdentifierDeclaration * Identifier: "STRING_VALUE", // required * DataSetArn: "STRING_VALUE", // required * }, * ], * Sheets: [ // SheetDefinitionList * { // SheetDefinition * SheetId: "STRING_VALUE", // required * Title: "STRING_VALUE", * Description: "STRING_VALUE", * Name: "STRING_VALUE", * ParameterControls: [ // ParameterControlList * { // ParameterControl * DateTimePicker: { // ParameterDateTimePickerControl * ParameterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceParameterName: "STRING_VALUE", // required * DisplayOptions: { // DateTimePickerControlDisplayOptions * TitleOptions: { // LabelOptions * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: { // FontConfiguration * FontSize: { // FontSize * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", * FontWeight: { // FontWeight * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: { // SheetControlInfoIconLabelOptions * Visibility: "HIDDEN" || "VISIBLE", * InfoIconText: "STRING_VALUE", * }, * HelperTextVisibility: "HIDDEN" || "VISIBLE", * DateIconVisibility: "HIDDEN" || "VISIBLE", * }, * }, * List: { // ParameterListControl * ParameterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceParameterName: "STRING_VALUE", // required * DisplayOptions: { // ListControlDisplayOptions * SearchOptions: { // ListControlSearchOptions * Visibility: "HIDDEN" || "VISIBLE", * }, * SelectAllOptions: { // ListControlSelectAllOptions * Visibility: "HIDDEN" || "VISIBLE", * }, * TitleOptions: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", * FontWeight: { * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, * InfoIconLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", * InfoIconText: "STRING_VALUE", * }, * }, * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: { // ParameterSelectableValues * Values: [ // ParameterSelectableValueList * "STRING_VALUE", * ], * LinkToDataSetColumn: { // ColumnIdentifier * DataSetIdentifier: "STRING_VALUE", // required * ColumnName: "STRING_VALUE", // required * }, * }, * CascadingControlConfiguration: { // CascadingControlConfiguration * SourceControls: [ // CascadingControlSourceList * { // CascadingControlSource * SourceSheetControlId: "STRING_VALUE", * ColumnToMatch: { * DataSetIdentifier: "STRING_VALUE", // required * ColumnName: "STRING_VALUE", // required * }, * }, * ], * }, * }, * Dropdown: { // ParameterDropDownControl * ParameterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceParameterName: "STRING_VALUE", // required * DisplayOptions: { // DropDownControlDisplayOptions * SelectAllOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * TitleOptions: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", * FontWeight: { * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, * InfoIconLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", * InfoIconText: "STRING_VALUE", * }, * }, * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: { * Values: [ * "STRING_VALUE", * ], * LinkToDataSetColumn: { * DataSetIdentifier: "STRING_VALUE", // required * ColumnName: "STRING_VALUE", // required * }, * }, * CascadingControlConfiguration: { * SourceControls: [ * { * SourceSheetControlId: "STRING_VALUE", * ColumnToMatch: { * DataSetIdentifier: "STRING_VALUE", // required * ColumnName: "STRING_VALUE", // required * }, * }, * ], * }, * CommitMode: "AUTO" || "MANUAL", * }, * TextField: { // ParameterTextFieldControl * ParameterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceParameterName: "STRING_VALUE", // required * DisplayOptions: { // TextFieldControlDisplayOptions * TitleOptions: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", * FontWeight: { * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, * PlaceholderOptions: { // TextControlPlaceholderOptions * Visibility: "HIDDEN" || "VISIBLE", * }, * InfoIconLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", * InfoIconText: "STRING_VALUE", * }, * }, * }, * TextArea: { // ParameterTextAreaControl * ParameterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceParameterName: "STRING_VALUE", // required * Delimiter: "STRING_VALUE", * DisplayOptions: { // TextAreaControlDisplayOptions * TitleOptions: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: { * FontSize: { * Relative: "EXTRA_SMALL" || "SMALL" || "MEDIUM" || "LARGE" || "EXTRA_LARGE", * Absolute: "STRING_VALUE", * }, * FontDecoration: "UNDERLINE" || "NONE", * FontColor: "STRING_VALUE", * FontWeight: { * Name: "NORMAL" || "BOLD", * }, * FontStyle: "NORMAL" || "ITALIC", * FontFamily: "STRING_VALUE", * }, * CustomLabel: "STRING_VALUE", * }, * PlaceholderOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * InfoIconLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", * InfoIconText: "STRING_VALUE", * }, * }, * }, * Slider: { // ParameterSliderControl * ParameterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceParameterName: "STRING_VALUE", // required * DisplayOptions: { // SliderControlDisplayOptions * TitleOptions: "", * InfoIconLabelOptions: "", * }, * MaximumValue: Number("double"), // required * MinimumValue: Number("double"), // required * StepSize: Number("double"), // required * }, * }, * ], * FilterControls: [ // FilterControlList * { // FilterControl * DateTimePicker: { // FilterDateTimePickerControl * FilterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceFilterId: "STRING_VALUE", // required * DisplayOptions: { * TitleOptions: "", * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: "", * HelperTextVisibility: "HIDDEN" || "VISIBLE", * DateIconVisibility: "HIDDEN" || "VISIBLE", * }, * Type: "SINGLE_VALUED" || "DATE_RANGE", * CommitMode: "AUTO" || "MANUAL", * }, * List: { // FilterListControl * FilterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceFilterId: "STRING_VALUE", // required * DisplayOptions: { * SearchOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * SelectAllOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: { // FilterSelectableValues * Values: [ * "STRING_VALUE", * ], * }, * CascadingControlConfiguration: { * SourceControls: [ * { * SourceSheetControlId: "STRING_VALUE", * ColumnToMatch: { * DataSetIdentifier: "STRING_VALUE", // required * ColumnName: "STRING_VALUE", // required * }, * }, * ], * }, * }, * Dropdown: { // FilterDropDownControl * FilterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceFilterId: "STRING_VALUE", // required * DisplayOptions: { * SelectAllOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: { * Values: [ * "STRING_VALUE", * ], * }, * CascadingControlConfiguration: { * SourceControls: [ * { * SourceSheetControlId: "STRING_VALUE", * ColumnToMatch: "", * }, * ], * }, * CommitMode: "AUTO" || "MANUAL", * }, * TextField: { // FilterTextFieldControl * FilterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceFilterId: "STRING_VALUE", // required * DisplayOptions: { * TitleOptions: "", * PlaceholderOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * InfoIconLabelOptions: "", * }, * }, * TextArea: { // FilterTextAreaControl * FilterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceFilterId: "STRING_VALUE", // required * Delimiter: "STRING_VALUE", * DisplayOptions: { * TitleOptions: "", * PlaceholderOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * InfoIconLabelOptions: "", * }, * }, * Slider: { // FilterSliderControl * FilterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceFilterId: "STRING_VALUE", // required * DisplayOptions: { * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "SINGLE_POINT" || "RANGE", * MaximumValue: Number("double"), // required * MinimumValue: Number("double"), // required * StepSize: Number("double"), // required * }, * RelativeDateTime: { // FilterRelativeDateTimeControl * FilterControlId: "STRING_VALUE", // required * Title: "STRING_VALUE", // required * SourceFilterId: "STRING_VALUE", // required * DisplayOptions: { // RelativeDateTimeControlDisplayOptions * TitleOptions: "", * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: "", * }, * CommitMode: "AUTO" || "MANUAL", * }, * CrossSheet: { // FilterCrossSheetControl * FilterControlId: "STRING_VALUE", // required * SourceFilterId: "STRING_VALUE", // required * CascadingControlConfiguration: { * SourceControls: [ * { * SourceSheetControlId: "STRING_VALUE", * ColumnToMatch: "", * }, * ], * }, * }, * }, * ], * Visuals: [ // VisualList * { // Visual * TableVisual: { // TableVisual * VisualId: "STRING_VALUE", // required * Title: { // VisualTitleLabelOptions * Visibility: "HIDDEN" || "VISIBLE", * FormatText: { // ShortFormatText * PlainText: "STRING_VALUE", * RichText: "STRING_VALUE", * }, * }, * Subtitle: { // VisualSubtitleLabelOptions * Visibility: "HIDDEN" || "VISIBLE", * FormatText: { // LongFormatText * PlainText: "STRING_VALUE", * RichText: "STRING_VALUE", * }, * }, * ChartConfiguration: { // TableConfiguration * FieldWells: { // TableFieldWells * TableAggregatedFieldWells: { // TableAggregatedFieldWells * GroupBy: [ // DimensionFieldList * { // DimensionField * NumericalDimensionField: { // NumericalDimensionField * FieldId: "STRING_VALUE", // required * Column: "", // required * HierarchyId: "STRING_VALUE", * FormatConfiguration: { // NumberFormatConfiguration * FormatConfiguration: { // NumericFormatConfiguration * NumberDisplayFormatConfiguration: { // NumberDisplayFormatConfiguration * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: { // NumericSeparatorConfiguration * DecimalSeparator: "COMMA" || "DOT" || "SPACE", * ThousandsSeparator: { // ThousandSeparatorOptions * Symbol: "COMMA" || "DOT" || "SPACE", * Visibility: "HIDDEN" || "VISIBLE", * GroupingStyle: "DEFAULT" || "LAKHS", * }, * }, * DecimalPlacesConfiguration: { // DecimalPlacesConfiguration * DecimalPlaces: Number("long"), // required * }, * NumberScale: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeValueConfiguration: { // NegativeValueConfiguration * DisplayMode: "POSITIVE" || "NEGATIVE", // required * }, * NullValueFormatConfiguration: { // NullValueFormatConfiguration * NullString: "STRING_VALUE", // required * }, * }, * CurrencyDisplayFormatConfiguration: { // CurrencyDisplayFormatConfiguration * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: { * DecimalSeparator: "COMMA" || "DOT" || "SPACE", * ThousandsSeparator: { * Symbol: "COMMA" || "DOT" || "SPACE", * Visibility: "HIDDEN" || "VISIBLE", * GroupingStyle: "DEFAULT" || "LAKHS", * }, * }, * Symbol: "STRING_VALUE", * DecimalPlacesConfiguration: { * DecimalPlaces: Number("long"), // required * }, * NumberScale: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeValueConfiguration: { * DisplayMode: "POSITIVE" || "NEGATIVE", // required * }, * NullValueFormatConfiguration: { * NullString: "STRING_VALUE", // required * }, * }, * PercentageDisplayFormatConfiguration: { // PercentageDisplayFormatConfiguration * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: { * DecimalSeparator: "COMMA" || "DOT" || "SPACE", * ThousandsSeparator: { * Symbol: "COMMA" || "DOT" || "SPACE", * Visibility: "HIDDEN" || "VISIBLE", * GroupingStyle: "DEFAULT" || "LAKHS", * }, * }, * DecimalPlacesConfiguration: { * DecimalPlaces: Number("long"), // required * }, * NegativeValueConfiguration: { * DisplayMode: "POSITIVE" || "NEGATIVE", // required * }, * NullValueFormatConfiguration: { * NullString: "STRING_VALUE", // required * }, * }, * }, * }, * }, * CategoricalDimensionField: { // CategoricalDimensionField * FieldId: "STRING_VALUE", // required * Column: "", // required * HierarchyId: "STRING_VALUE", * FormatConfiguration: { // StringFormatConfiguration * NullValueFormatConfiguration: { * NullString: "STRING_VALUE", // required * }, * NumericFormatConfiguration: { * NumberDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: { * DecimalSeparator: "COMMA" || "DOT" || "SPACE", * ThousandsSeparator: { * Symbol: "COMMA" || "DOT" || "SPACE", * Visibility: "HIDDEN" || "VISIBLE", * GroupingStyle: "DEFAULT" || "LAKHS", * }, * }, * DecimalPlacesConfiguration: { * DecimalPlaces: Number("long"), // required * }, * NumberScale: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeValueConfiguration: { * DisplayMode: "POSITIVE" || "NEGATIVE", // required * }, * NullValueFormatConfiguration: { * NullString: "STRING_VALUE", // required * }, * }, * CurrencyDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: { * DecimalSeparator: "COMMA" || "DOT" || "SPACE", * ThousandsSeparator: { * Symbol: "COMMA" || "DOT" || "SPACE", * Visibility: "HIDDEN" || "VISIBLE", * GroupingStyle: "DEFAULT" || "LAKHS", * }, * }, * Symbol: "STRING_VALUE", * DecimalPlacesConfiguration: { * DecimalPlaces: Number("long"), // required * }, * NumberScale: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeValueConfiguration: { * DisplayMode: "POSITIVE" || "NEGATIVE", // required * }, * NullValueFormatConfiguration: "", * }, * PercentageDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: "", * DecimalPlacesConfiguration: "", * NegativeValueConfiguration: "", * NullValueFormatConfiguration: "", * }, * }, * }, * }, * DateDimensionField: { // DateDimensionField * FieldId: "STRING_VALUE", // required * Column: "", // required * DateGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * HierarchyId: "STRING_VALUE", * FormatConfiguration: { // DateTimeFormatConfiguration * DateTimeFormat: "STRING_VALUE", * NullValueFormatConfiguration: "", * NumericFormatConfiguration: { * NumberDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: "", * DecimalPlacesConfiguration: "", * NumberScale: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeValueConfiguration: "", * NullValueFormatConfiguration: "", * }, * CurrencyDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: "", * Symbol: "STRING_VALUE", * DecimalPlacesConfiguration: "", * NumberScale: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeValueConfiguration: "", * NullValueFormatConfiguration: "", * }, * PercentageDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: "", * DecimalPlacesConfiguration: "", * NegativeValueConfiguration: "", * NullValueFormatConfiguration: "", * }, * }, * }, * }, * }, * ], * Values: [ // MeasureFieldList * { // MeasureField * NumericalMeasureField: { // NumericalMeasureField * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: { // NumericalAggregationFunction * SimpleNumericalAggregation: "SUM" || "AVERAGE" || "MIN" || "MAX" || "COUNT" || "DISTINCT_COUNT" || "VAR" || "VARP" || "STDEV" || "STDEVP" || "MEDIAN", * PercentileAggregation: { // PercentileAggregation * PercentileValue: Number("double"), * }, * }, * FormatConfiguration: { * FormatConfiguration: { * NumberDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: "", * DecimalPlacesConfiguration: "", * NumberScale: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeValueConfiguration: "", * NullValueFormatConfiguration: "", * }, * CurrencyDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: "", * Symbol: "STRING_VALUE", * DecimalPlacesConfiguration: "", * NumberScale: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeValueConfiguration: "", * NullValueFormatConfiguration: "", * }, * PercentageDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: "", * DecimalPlacesConfiguration: "", * NegativeValueConfiguration: "", * NullValueFormatConfiguration: "", * }, * }, * }, * }, * CategoricalMeasureField: { // CategoricalMeasureField * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "COUNT" || "DISTINCT_COUNT", * FormatConfiguration: { * NullValueFormatConfiguration: "", * NumericFormatConfiguration: { * NumberDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: "", * DecimalPlacesConfiguration: "", * NumberScale: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeValueConfiguration: "", * NullValueFormatConfiguration: "", * }, * CurrencyDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: "", * Symbol: "STRING_VALUE", * DecimalPlacesConfiguration: "", * NumberScale: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeValueConfiguration: "", * NullValueFormatConfiguration: "", * }, * PercentageDisplayFormatConfiguration: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * SeparatorConfiguration: "", * DecimalPlacesConfiguration: "", * NegativeValueConfiguration: "", * NullValueFormatConfiguration: "", * }, * }, * }, * }, * DateMeasureField: { // DateMeasureField * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX", * FormatConfiguration: { * DateTimeFormat: "STRING_VALUE", * NullValueFormatConfiguration: "", * NumericFormatConfiguration: "", * }, * }, * CalculatedMeasureField: { // CalculatedMeasureField * FieldId: "STRING_VALUE", // required * Expression: "STRING_VALUE", // required * }, * }, * ], * }, * TableUnaggregatedFieldWells: { // TableUnaggregatedFieldWells * Values: [ // TableUnaggregatedFieldList * { // UnaggregatedField * FieldId: "STRING_VALUE", // required * Column: "", // required * FormatConfiguration: { // FormatConfiguration * StringFormatConfiguration: { * NullValueFormatConfiguration: "", * NumericFormatConfiguration: "", * }, * NumberFormatConfiguration: { * FormatConfiguration: "", * }, * DateTimeFormatConfiguration: { * DateTimeFormat: "STRING_VALUE", * NullValueFormatConfiguration: "", * NumericFormatConfiguration: "", * }, * }, * }, * ], * }, * }, * SortConfiguration: { // TableSortConfiguration * RowSort: [ // RowSortList * { // FieldSortOptions * FieldSort: { // FieldSort * FieldId: "STRING_VALUE", // required * Direction: "ASC" || "DESC", // required * }, * ColumnSort: { // ColumnSort * SortBy: "", // required * Direction: "ASC" || "DESC", // required * AggregationFunction: { // AggregationFunction * NumericalAggregationFunction: { * SimpleNumericalAggregation: "SUM" || "AVERAGE" || "MIN" || "MAX" || "COUNT" || "DISTINCT_COUNT" || "VAR" || "VARP" || "STDEV" || "STDEVP" || "MEDIAN", * PercentileAggregation: { * PercentileValue: Number("double"), * }, * }, * CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT", * DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX", * AttributeAggregationFunction: { // AttributeAggregationFunction * SimpleAttributeAggregation: "UNIQUE_VALUE", * ValueForMultipleValues: "STRING_VALUE", * }, * }, * }, * }, * ], * PaginationConfiguration: { // PaginationConfiguration * PageSize: Number("long"), // required * PageNumber: Number("long"), // required * }, * }, * TableOptions: { // TableOptions * Orientation: "VERTICAL" || "HORIZONTAL", * HeaderStyle: { // TableCellStyle * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: "", * TextWrap: "NONE" || "WRAP", * HorizontalTextAlignment: "LEFT" || "CENTER" || "RIGHT" || "AUTO", * VerticalTextAlignment: "TOP" || "MIDDLE" || "BOTTOM" || "AUTO", * BackgroundColor: "STRING_VALUE", * Height: Number("int"), * Border: { // GlobalTableBorderOptions * UniformBorder: { // TableBorderOptions * Color: "STRING_VALUE", * Thickness: Number("int"), * Style: "NONE" || "SOLID", * }, * SideSpecificBorder: { // TableSideBorderOptions * InnerVertical: { * Color: "STRING_VALUE", * Thickness: Number("int"), * Style: "NONE" || "SOLID", * }, * InnerHorizontal: { * Color: "STRING_VALUE", * Thickness: Number("int"), * Style: "NONE" || "SOLID", * }, * Left: { * Color: "STRING_VALUE", * Thickness: Number("int"), * Style: "NONE" || "SOLID", * }, * Right: { * Color: "STRING_VALUE", * Thickness: Number("int"), * Style: "NONE" || "SOLID", * }, * Top: "", * Bottom: "", * }, * }, * }, * CellStyle: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: "", * TextWrap: "NONE" || "WRAP", * HorizontalTextAlignment: "LEFT" || "CENTER" || "RIGHT" || "AUTO", * VerticalTextAlignment: "TOP" || "MIDDLE" || "BOTTOM" || "AUTO", * BackgroundColor: "STRING_VALUE", * Height: Number("int"), * Border: { * UniformBorder: "", * SideSpecificBorder: { * InnerVertical: "", * InnerHorizontal: "", * Left: "", * Right: "", * Top: "", * Bottom: "", * }, * }, * }, * RowAlternateColorOptions: { // RowAlternateColorOptions * Status: "ENABLED" || "DISABLED", * RowAlternateColors: [ // RowAlternateColorList * "STRING_VALUE", * ], * UsePrimaryBackgroundColor: "ENABLED" || "DISABLED", * }, * }, * TotalOptions: { // TotalOptions * TotalsVisibility: "HIDDEN" || "VISIBLE", * Placement: "START" || "END" || "AUTO", * ScrollStatus: "PINNED" || "SCROLLED", * CustomLabel: "STRING_VALUE", * TotalCellStyle: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: "", * TextWrap: "NONE" || "WRAP", * HorizontalTextAlignment: "LEFT" || "CENTER" || "RIGHT" || "AUTO", * VerticalTextAlignment: "TOP" || "MIDDLE" || "BOTTOM" || "AUTO", * BackgroundColor: "STRING_VALUE", * Height: Number("int"), * Border: { * UniformBorder: "", * SideSpecificBorder: { * InnerVertical: "", * InnerHorizontal: "", * Left: "", * Right: "", * Top: "", * Bottom: "", * }, * }, * }, * TotalAggregationOptions: [ // TotalAggregationOptionList * { // TotalAggregationOption * FieldId: "STRING_VALUE", // required * TotalAggregationFunction: { // TotalAggregationFunction * SimpleTotalAggregationFunction: "DEFAULT" || "SUM" || "AVERAGE" || "MIN" || "MAX" || "NONE", * }, * }, * ], * }, * FieldOptions: { // TableFieldOptions * SelectedFieldOptions: [ // TableFieldOptionList * { // TableFieldOption * FieldId: "STRING_VALUE", // required * Width: "STRING_VALUE", * CustomLabel: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * URLStyling: { // TableFieldURLConfiguration * LinkConfiguration: { // TableFieldLinkConfiguration * Target: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required * Content: { // TableFieldLinkContentConfiguration * CustomTextContent: { // TableFieldCustomTextContent * Value: "STRING_VALUE", * FontConfiguration: "", // required * }, * CustomIconContent: { // TableFieldCustomIconContent * Icon: "LINK", * }, * }, * }, * ImageConfiguration: { // TableFieldImageConfiguration * SizingOptions: { // TableCellImageSizingConfiguration * TableCellImageScalingConfiguration: "FIT_TO_CELL_HEIGHT" || "FIT_TO_CELL_WIDTH" || "DO_NOT_SCALE", * }, * }, * }, * }, * ], * Order: [ // FieldOrderList * "STRING_VALUE", * ], * PinnedFieldOptions: { // TablePinnedFieldOptions * PinnedLeftFields: [ // TableFieldOrderList * "STRING_VALUE", * ], * }, * TransposedTableOptions: [ // TransposedTableOptionList * { // TransposedTableOption * ColumnIndex: Number("int"), * ColumnWidth: "STRING_VALUE", * ColumnType: "ROW_HEADER_COLUMN" || "VALUE_COLUMN", // required * }, * ], * }, * PaginatedReportOptions: { // TablePaginatedReportOptions * VerticalOverflowVisibility: "HIDDEN" || "VISIBLE", * OverflowColumnHeaderVisibility: "HIDDEN" || "VISIBLE", * }, * TableInlineVisualizations: [ // TableInlineVisualizationList * { // TableInlineVisualization * DataBars: { // DataBarsOptions * FieldId: "STRING_VALUE", // required * PositiveColor: "STRING_VALUE", * NegativeColor: "STRING_VALUE", * }, * Sparklines: { // SparklinesOptions * FieldId: "STRING_VALUE", // required * XAxisField: { * NumericalDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * HierarchyId: "STRING_VALUE", * FormatConfiguration: { * FormatConfiguration: "", * }, * }, * CategoricalDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * HierarchyId: "STRING_VALUE", * FormatConfiguration: { * NullValueFormatConfiguration: "", * NumericFormatConfiguration: "", * }, * }, * DateDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * DateGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * HierarchyId: "STRING_VALUE", * FormatConfiguration: { * DateTimeFormat: "STRING_VALUE", * NullValueFormatConfiguration: "", * NumericFormatConfiguration: "", * }, * }, * }, * YAxisBehavior: "SHARED" || "INDEPENDENT", * VisualType: "LINE" || "AREA_LINE", * LineColor: "STRING_VALUE", * LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED", * AllPointsMarker: { // LineChartMarkerStyleSettings * MarkerVisibility: "HIDDEN" || "VISIBLE", * MarkerShape: "CIRCLE" || "TRIANGLE" || "SQUARE" || "DIAMOND" || "ROUNDED_SQUARE", * MarkerSize: "STRING_VALUE", * MarkerColor: "STRING_VALUE", * }, * MaxValueMarker: { * MarkerVisibility: "HIDDEN" || "VISIBLE", * MarkerShape: "CIRCLE" || "TRIANGLE" || "SQUARE" || "DIAMOND" || "ROUNDED_SQUARE", * MarkerSize: "STRING_VALUE", * MarkerColor: "STRING_VALUE", * }, * MinValueMarker: { * MarkerVisibility: "HIDDEN" || "VISIBLE", * MarkerShape: "CIRCLE" || "TRIANGLE" || "SQUARE" || "DIAMOND" || "ROUNDED_SQUARE", * MarkerSize: "STRING_VALUE", * MarkerColor: "STRING_VALUE", * }, * }, * }, * ], * Tooltip: { // TooltipOptions * TooltipVisibility: "HIDDEN" || "VISIBLE", * SelectedTooltipType: "BASIC" || "DETAILED" || "SHEET", * FieldBasedTooltip: { // FieldBasedTooltip * AggregationVisibility: "HIDDEN" || "VISIBLE", * TooltipTitleType: "NONE" || "PRIMARY_VALUE", * TooltipFields: [ // TooltipItemList * { // TooltipItem * FieldTooltipItem: { // FieldTooltipItem * FieldId: "STRING_VALUE", // required * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * TooltipTarget: "BOTH" || "BAR" || "LINE", * }, * ColumnTooltipItem: { // ColumnTooltipItem * Column: "", // required * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * Aggregation: { * NumericalAggregationFunction: { * SimpleNumericalAggregation: "SUM" || "AVERAGE" || "MIN" || "MAX" || "COUNT" || "DISTINCT_COUNT" || "VAR" || "VARP" || "STDEV" || "STDEVP" || "MEDIAN", * PercentileAggregation: { * PercentileValue: Number("double"), * }, * }, * CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT", * DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX", * AttributeAggregationFunction: { * SimpleAttributeAggregation: "UNIQUE_VALUE", * ValueForMultipleValues: "STRING_VALUE", * }, * }, * TooltipTarget: "BOTH" || "BAR" || "LINE", * }, * }, * ], * }, * SheetTooltip: { // SheetTooltip * SheetId: "STRING_VALUE", * }, * }, * DashboardCustomizationVisualOptions: { // DashboardCustomizationVisualOptions * FieldsConfiguration: { // VisualCustomizationFieldsConfiguration * Status: "ENABLED" || "DISABLED", * AdditionalFields: [ // VisualCustomizationAdditionalFieldsList * "", * ], * }, * }, * Interactions: { // VisualInteractionOptions * VisualMenuOption: { * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * ContextMenuOption: { // ContextMenuOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * }, * ConditionalFormatting: { // TableConditionalFormatting * ConditionalFormattingOptions: [ // TableConditionalFormattingOptionList * { // TableConditionalFormattingOption * Cell: { // TableCellConditionalFormatting * FieldId: "STRING_VALUE", // required * TextFormat: { // TextConditionalFormat * BackgroundColor: { // ConditionalFormattingColor * Solid: { // ConditionalFormattingSolidColor * Expression: "STRING_VALUE", // required * Color: "STRING_VALUE", * }, * Gradient: { // ConditionalFormattingGradientColor * Expression: "STRING_VALUE", // required * Color: { // GradientColor * Stops: [ // GradientStopList * { // GradientStop * GradientOffset: Number("double"), // required * DataValue: Number("double"), * Color: "STRING_VALUE", * }, * ], * }, * }, * }, * TextColor: { * Solid: { * Expression: "STRING_VALUE", // required * Color: "STRING_VALUE", * }, * Gradient: { * Expression: "STRING_VALUE", // required * Color: { * Stops: [ * { * GradientOffset: Number("double"), // required * DataValue: Number("double"), * Color: "STRING_VALUE", * }, * ], * }, * }, * }, * Icon: { // ConditionalFormattingIcon * IconSet: { // ConditionalFormattingIconSet * Expression: "STRING_VALUE", // required * IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW", * }, * CustomCondition: { // ConditionalFormattingCustomIconCondition * Expression: "STRING_VALUE", // required * IconOptions: { // ConditionalFormattingCustomIconOptions * Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X", * UnicodeIcon: "STRING_VALUE", * }, * Color: "STRING_VALUE", * DisplayConfiguration: { // ConditionalFormattingIconDisplayConfiguration * IconDisplayOption: "ICON_ONLY", * }, * }, * }, * }, * }, * Row: { // TableRowConditionalFormatting * BackgroundColor: { * Solid: { * Expression: "STRING_VALUE", // required * Color: "STRING_VALUE", * }, * Gradient: { * Expression: "STRING_VALUE", // required * Color: { * Stops: [ * { * GradientOffset: Number("double"), // required * DataValue: Number("double"), * Color: "STRING_VALUE", * }, * ], * }, * }, * }, * TextColor: { * Solid: { * Expression: "STRING_VALUE", // required * Color: "STRING_VALUE", * }, * Gradient: { * Expression: "STRING_VALUE", // required * Color: { * Stops: [ * { * GradientOffset: Number("double"), // required * DataValue: Number("double"), * Color: "STRING_VALUE", * }, * ], * }, * }, * }, * }, * }, * ], * }, * Actions: [ // VisualCustomActionList * { // VisualCustomAction * CustomActionId: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * Status: "ENABLED" || "DISABLED", * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required * ActionOperations: [ // VisualCustomActionOperationList // required * { // VisualCustomActionOperation * FilterOperation: { // CustomActionFilterOperation * SelectedFieldsConfiguration: { // FilterOperationSelectedFieldsConfiguration * SelectedFields: [ // SelectedFieldList * "STRING_VALUE", * ], * SelectedFieldOptions: "ALL_FIELDS", * SelectedColumns: [ // CustomActionColumnList * "", * ], * }, * TargetVisualsConfiguration: { // FilterOperationTargetVisualsConfiguration * SameSheetTargetVisualConfiguration: { // SameSheetTargetVisualConfiguration * TargetVisuals: [ // TargetVisualList * "STRING_VALUE", * ], * TargetVisualOptions: "ALL_VISUALS", * }, * }, * }, * NavigationOperation: { // CustomActionNavigationOperation * LocalNavigationConfiguration: { // LocalNavigationConfiguration * TargetSheetId: "STRING_VALUE", // required * }, * }, * URLOperation: { // CustomActionURLOperation * URLTemplate: "STRING_VALUE", // required * URLTarget: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required * }, * SetParametersOperation: { // CustomActionSetParametersOperation * ParameterValueConfigurations: [ // SetParameterValueConfigurationList // required * { // SetParameterValueConfiguration * DestinationParameterName: "STRING_VALUE", // required * Value: { // DestinationParameterValueConfiguration * CustomValuesConfiguration: { // CustomValuesConfiguration * IncludeNullValue: true || false, * CustomValues: { // CustomParameterValues * StringValues: [ // StringDefaultValueList * "STRING_VALUE", * ], * IntegerValues: [ // IntegerDefaultValueList * Number("long"), * ], * DecimalValues: [ // DecimalDefaultValueList * Number("double"), * ], * DateTimeValues: [ // DateTimeDefaultValueList * new Date("TIMESTAMP"), * ], * }, * }, * SelectAllValueOptions: "ALL_VALUES", * SourceParameterName: "STRING_VALUE", * SourceField: "STRING_VALUE", * SourceColumn: "", * }, * }, * ], * }, * }, * ], * }, * ], * VisualContentAltText: "STRING_VALUE", * }, * PivotTableVisual: { // PivotTableVisual * VisualId: "STRING_VALUE", // required * Title: { * Visibility: "HIDDEN" || "VISIBLE", * FormatText: { * PlainText: "STRING_VALUE", * RichText: "STRING_VALUE", * }, * }, * Subtitle: { * Visibility: "HIDDEN" || "VISIBLE", * FormatText: { * PlainText: "STRING_VALUE", * RichText: "STRING_VALUE", * }, * }, * ChartConfiguration: { // PivotTableConfiguration * FieldWells: { // PivotTableFieldWells * PivotTableAggregatedFieldWells: { // PivotTableAggregatedFieldWells * Rows: [ // PivotTableDimensionList * { * NumericalDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * HierarchyId: "STRING_VALUE", * FormatConfiguration: { * FormatConfiguration: "", * }, * }, * CategoricalDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * HierarchyId: "STRING_VALUE", * FormatConfiguration: { * NullValueFormatConfiguration: "", * NumericFormatConfiguration: "", * }, * }, * DateDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * DateGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * HierarchyId: "STRING_VALUE", * FormatConfiguration: { * DateTimeFormat: "STRING_VALUE", * NullValueFormatConfiguration: "", * NumericFormatConfiguration: "", * }, * }, * }, * ], * Columns: [ * { * NumericalDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * HierarchyId: "STRING_VALUE", * FormatConfiguration: "", * }, * CategoricalDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * HierarchyId: "STRING_VALUE", * FormatConfiguration: "", * }, * DateDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * DateGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * HierarchyId: "STRING_VALUE", * FormatConfiguration: "", * }, * }, * ], * Values: [ // PivotMeasureFieldList * { * NumericalMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: { * SimpleNumericalAggregation: "SUM" || "AVERAGE" || "MIN" || "MAX" || "COUNT" || "DISTINCT_COUNT" || "VAR" || "VARP" || "STDEV" || "STDEVP" || "MEDIAN", * PercentileAggregation: { * PercentileValue: Number("double"), * }, * }, * FormatConfiguration: "", * }, * CategoricalMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "COUNT" || "DISTINCT_COUNT", * FormatConfiguration: "", * }, * DateMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX", * FormatConfiguration: "", * }, * CalculatedMeasureField: { * FieldId: "STRING_VALUE", // required * Expression: "STRING_VALUE", // required * }, * }, * ], * }, * }, * SortConfiguration: { // PivotTableSortConfiguration * FieldSortOptions: [ // PivotFieldSortOptionsList * { // PivotFieldSortOptions * FieldId: "STRING_VALUE", // required * SortBy: { // PivotTableSortBy * Field: { * FieldId: "STRING_VALUE", // required * Direction: "ASC" || "DESC", // required * }, * Column: { * SortBy: "", // required * Direction: "ASC" || "DESC", // required * AggregationFunction: { * NumericalAggregationFunction: { * SimpleNumericalAggregation: "SUM" || "AVERAGE" || "MIN" || "MAX" || "COUNT" || "DISTINCT_COUNT" || "VAR" || "VARP" || "STDEV" || "STDEVP" || "MEDIAN", * PercentileAggregation: { * PercentileValue: Number("double"), * }, * }, * CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT", * DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX", * AttributeAggregationFunction: { * SimpleAttributeAggregation: "UNIQUE_VALUE", * ValueForMultipleValues: "STRING_VALUE", * }, * }, * }, * DataPath: { // DataPathSort * Direction: "ASC" || "DESC", // required * SortPaths: [ // DataPathValueList // required * { // DataPathValue * FieldId: "STRING_VALUE", * FieldValue: "STRING_VALUE", * DataPathType: { // DataPathType * PivotTableDataPathType: "HIERARCHY_ROWS_LAYOUT_COLUMN" || "MULTIPLE_ROW_METRICS_COLUMN" || "EMPTY_COLUMN_HEADER" || "COUNT_METRIC_COLUMN", * }, * }, * ], * }, * }, * }, * ], * }, * TableOptions: { // PivotTableOptions * MetricPlacement: "ROW" || "COLUMN", * SingleMetricVisibility: "HIDDEN" || "VISIBLE", * ColumnNamesVisibility: "HIDDEN" || "VISIBLE", * ToggleButtonsVisibility: "HIDDEN" || "VISIBLE", * ColumnHeaderStyle: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: "", * TextWrap: "NONE" || "WRAP", * HorizontalTextAlignment: "LEFT" || "CENTER" || "RIGHT" || "AUTO", * VerticalTextAlignment: "TOP" || "MIDDLE" || "BOTTOM" || "AUTO", * BackgroundColor: "STRING_VALUE", * Height: Number("int"), * Border: { * UniformBorder: "", * SideSpecificBorder: { * InnerVertical: "", * InnerHorizontal: "", * Left: "", * Right: "", * Top: "", * Bottom: "", * }, * }, * }, * RowHeaderStyle: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: "", * TextWrap: "NONE" || "WRAP", * HorizontalTextAlignment: "LEFT" || "CENTER" || "RIGHT" || "AUTO", * VerticalTextAlignment: "TOP" || "MIDDLE" || "BOTTOM" || "AUTO", * BackgroundColor: "STRING_VALUE", * Height: Number("int"), * Border: { * UniformBorder: "", * SideSpecificBorder: { * InnerVertical: "", * InnerHorizontal: "", * Left: "", * Right: "", * Top: "", * Bottom: "", * }, * }, * }, * CellStyle: "", * RowFieldNamesStyle: "", * RowAlternateColorOptions: { * Status: "ENABLED" || "DISABLED", * RowAlternateColors: [ * "STRING_VALUE", * ], * UsePrimaryBackgroundColor: "ENABLED" || "DISABLED", * }, * CollapsedRowDimensionsVisibility: "HIDDEN" || "VISIBLE", * RowsLayout: "TABULAR" || "HIERARCHY", * RowsLabelOptions: { // PivotTableRowsLabelOptions * Visibility: "HIDDEN" || "VISIBLE", * CustomLabel: "STRING_VALUE", * }, * DefaultCellWidth: "STRING_VALUE", * }, * TotalOptions: { // PivotTableTotalOptions * RowSubtotalOptions: { // SubtotalOptions * TotalsVisibility: "HIDDEN" || "VISIBLE", * CustomLabel: "STRING_VALUE", * FieldLevel: "ALL" || "CUSTOM" || "LAST", * FieldLevelOptions: [ // PivotTableFieldSubtotalOptionsList * { // PivotTableFieldSubtotalOptions * FieldId: "STRING_VALUE", * }, * ], * TotalCellStyle: "", * ValueCellStyle: "", * MetricHeaderCellStyle: "", * StyleTargets: [ // TableStyleTargetList * { // TableStyleTarget * CellType: "TOTAL" || "METRIC_HEADER" || "VALUE", // required * }, * ], * }, * ColumnSubtotalOptions: { * TotalsVisibility: "HIDDEN" || "VISIBLE", * CustomLabel: "STRING_VALUE", * FieldLevel: "ALL" || "CUSTOM" || "LAST", * FieldLevelOptions: [ * { * FieldId: "STRING_VALUE", * }, * ], * TotalCellStyle: "", * ValueCellStyle: "", * MetricHeaderCellStyle: "", * StyleTargets: [ * { * CellType: "TOTAL" || "METRIC_HEADER" || "VALUE", // required * }, * ], * }, * RowTotalOptions: { // PivotTotalOptions * TotalsVisibility: "HIDDEN" || "VISIBLE", * Placement: "START" || "END" || "AUTO", * ScrollStatus: "PINNED" || "SCROLLED", * CustomLabel: "STRING_VALUE", * TotalCellStyle: "", * ValueCellStyle: "", * MetricHeaderCellStyle: "", * TotalAggregationOptions: [ * { * FieldId: "STRING_VALUE", // required * TotalAggregationFunction: { * SimpleTotalAggregationFunction: "DEFAULT" || "SUM" || "AVERAGE" || "MIN" || "MAX" || "NONE", * }, * }, * ], * }, * ColumnTotalOptions: { * TotalsVisibility: "HIDDEN" || "VISIBLE", * Placement: "START" || "END" || "AUTO", * ScrollStatus: "PINNED" || "SCROLLED", * CustomLabel: "STRING_VALUE", * TotalCellStyle: "", * ValueCellStyle: "", * MetricHeaderCellStyle: "", * TotalAggregationOptions: [ * { * FieldId: "STRING_VALUE", // required * TotalAggregationFunction: { * SimpleTotalAggregationFunction: "DEFAULT" || "SUM" || "AVERAGE" || "MIN" || "MAX" || "NONE", * }, * }, * ], * }, * }, * FieldOptions: { // PivotTableFieldOptions * SelectedFieldOptions: [ // PivotTableFieldOptionList * { // PivotTableFieldOption * FieldId: "STRING_VALUE", // required * CustomLabel: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * ], * DataPathOptions: [ // PivotTableDataPathOptionList * { // PivotTableDataPathOption * DataPathList: [ // required * { * FieldId: "STRING_VALUE", * FieldValue: "STRING_VALUE", * DataPathType: { * PivotTableDataPathType: "HIERARCHY_ROWS_LAYOUT_COLUMN" || "MULTIPLE_ROW_METRICS_COLUMN" || "EMPTY_COLUMN_HEADER" || "COUNT_METRIC_COLUMN", * }, * }, * ], * Width: "STRING_VALUE", * }, * ], * CollapseStateOptions: [ // PivotTableFieldCollapseStateOptionList * { // PivotTableFieldCollapseStateOption * Target: { // PivotTableFieldCollapseStateTarget * FieldId: "STRING_VALUE", * FieldDataPathValues: "", * }, * State: "COLLAPSED" || "EXPANDED", * }, * ], * }, * PaginatedReportOptions: { // PivotTablePaginatedReportOptions * VerticalOverflowVisibility: "HIDDEN" || "VISIBLE", * OverflowColumnHeaderVisibility: "HIDDEN" || "VISIBLE", * }, * Tooltip: { * TooltipVisibility: "HIDDEN" || "VISIBLE", * SelectedTooltipType: "BASIC" || "DETAILED" || "SHEET", * FieldBasedTooltip: { * AggregationVisibility: "HIDDEN" || "VISIBLE", * TooltipTitleType: "NONE" || "PRIMARY_VALUE", * TooltipFields: [ * { * FieldTooltipItem: { * FieldId: "STRING_VALUE", // required * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * TooltipTarget: "BOTH" || "BAR" || "LINE", * }, * ColumnTooltipItem: { * Column: "", // required * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * Aggregation: { * NumericalAggregationFunction: "", * CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT", * DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX", * AttributeAggregationFunction: { * SimpleAttributeAggregation: "UNIQUE_VALUE", * ValueForMultipleValues: "STRING_VALUE", * }, * }, * TooltipTarget: "BOTH" || "BAR" || "LINE", * }, * }, * ], * }, * SheetTooltip: { * SheetId: "STRING_VALUE", * }, * }, * DashboardCustomizationVisualOptions: { * FieldsConfiguration: { * Status: "ENABLED" || "DISABLED", * AdditionalFields: [ * "", * ], * }, * }, * Interactions: { * VisualMenuOption: { * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * ContextMenuOption: { * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * }, * ConditionalFormatting: { // PivotTableConditionalFormatting * ConditionalFormattingOptions: [ // PivotTableConditionalFormattingOptionList * { // PivotTableConditionalFormattingOption * Cell: { // PivotTableCellConditionalFormatting * FieldId: "STRING_VALUE", // required * TextFormat: { * BackgroundColor: { * Solid: { * Expression: "STRING_VALUE", // required * Color: "STRING_VALUE", * }, * Gradient: { * Expression: "STRING_VALUE", // required * Color: { * Stops: [ * { * GradientOffset: Number("double"), // required * DataValue: Number("double"), * Color: "STRING_VALUE", * }, * ], * }, * }, * }, * TextColor: "", * Icon: { * IconSet: { * Expression: "STRING_VALUE", // required * IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW", * }, * CustomCondition: { * Expression: "STRING_VALUE", // required * IconOptions: { * Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X", * UnicodeIcon: "STRING_VALUE", * }, * Color: "STRING_VALUE", * DisplayConfiguration: { * IconDisplayOption: "ICON_ONLY", * }, * }, * }, * }, * Scope: { // PivotTableConditionalFormattingScope * Role: "FIELD" || "FIELD_TOTAL" || "GRAND_TOTAL", * }, * Scopes: [ // PivotTableConditionalFormattingScopeList * { * Role: "FIELD" || "FIELD_TOTAL" || "GRAND_TOTAL", * }, * ], * }, * }, * ], * }, * Actions: [ * { * CustomActionId: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * Status: "ENABLED" || "DISABLED", * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required * ActionOperations: [ // required * { * FilterOperation: { * SelectedFieldsConfiguration: { * SelectedFields: [ * "STRING_VALUE", * ], * SelectedFieldOptions: "ALL_FIELDS", * SelectedColumns: [ * "", * ], * }, * TargetVisualsConfiguration: { * SameSheetTargetVisualConfiguration: { * TargetVisuals: [ * "STRING_VALUE", * ], * TargetVisualOptions: "ALL_VISUALS", * }, * }, * }, * NavigationOperation: { * LocalNavigationConfiguration: { * TargetSheetId: "STRING_VALUE", // required * }, * }, * URLOperation: { * URLTemplate: "STRING_VALUE", // required * URLTarget: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required * }, * SetParametersOperation: { * ParameterValueConfigurations: [ // required * { * DestinationParameterName: "STRING_VALUE", // required * Value: { * CustomValuesConfiguration: { * IncludeNullValue: true || false, * CustomValues: { * StringValues: [ * "STRING_VALUE", * ], * IntegerValues: [ * Number("long"), * ], * DecimalValues: [ * Number("double"), * ], * DateTimeValues: [ * new Date("TIMESTAMP"), * ], * }, * }, * SelectAllValueOptions: "ALL_VALUES", * SourceParameterName: "STRING_VALUE", * SourceField: "STRING_VALUE", * SourceColumn: "", * }, * }, * ], * }, * }, * ], * }, * ], * VisualContentAltText: "STRING_VALUE", * }, * BarChartVisual: { // BarChartVisual * VisualId: "STRING_VALUE", // required * Title: { * Visibility: "HIDDEN" || "VISIBLE", * FormatText: { * PlainText: "STRING_VALUE", * RichText: "STRING_VALUE", * }, * }, * Subtitle: { * Visibility: "HIDDEN" || "VISIBLE", * FormatText: { * PlainText: "STRING_VALUE", * RichText: "STRING_VALUE", * }, * }, * ChartConfiguration: { // BarChartConfiguration * FieldWells: { // BarChartFieldWells * BarChartAggregatedFieldWells: { // BarChartAggregatedFieldWells * Category: [ * { * NumericalDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * HierarchyId: "STRING_VALUE", * FormatConfiguration: "", * }, * CategoricalDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * HierarchyId: "STRING_VALUE", * FormatConfiguration: "", * }, * DateDimensionField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * DateGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * HierarchyId: "STRING_VALUE", * FormatConfiguration: "", * }, * }, * ], * Values: [ * { * NumericalMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "", * FormatConfiguration: "", * }, * CategoricalMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "COUNT" || "DISTINCT_COUNT", * FormatConfiguration: "", * }, * DateMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX", * FormatConfiguration: "", * }, * CalculatedMeasureField: { * FieldId: "STRING_VALUE", // required * Expression: "STRING_VALUE", // required * }, * }, * ], * Colors: [ * "", * ], * SmallMultiples: [ // SmallMultiplesDimensionFieldList * "", * ], * }, * }, * SortConfiguration: { // BarChartSortConfiguration * CategorySort: [ // FieldSortOptionsList * { * FieldSort: { * FieldId: "STRING_VALUE", // required * Direction: "ASC" || "DESC", // required * }, * ColumnSort: { * SortBy: "", // required * Direction: "ASC" || "DESC", // required * AggregationFunction: { * NumericalAggregationFunction: "", * CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT", * DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX", * AttributeAggregationFunction: { * SimpleAttributeAggregation: "UNIQUE_VALUE", * ValueForMultipleValues: "STRING_VALUE", * }, * }, * }, * }, * ], * CategoryItemsLimit: { // ItemsLimitConfiguration * ItemsLimit: Number("long"), * OtherCategories: "INCLUDE" || "EXCLUDE", * }, * ColorSort: [ * { * FieldSort: { * FieldId: "STRING_VALUE", // required * Direction: "ASC" || "DESC", // required * }, * ColumnSort: { * SortBy: "", // required * Direction: "ASC" || "DESC", // required * AggregationFunction: "", * }, * }, * ], * ColorItemsLimit: { * ItemsLimit: Number("long"), * OtherCategories: "INCLUDE" || "EXCLUDE", * }, * SmallMultiplesSort: [ * { * FieldSort: { * FieldId: "STRING_VALUE", // required * Direction: "ASC" || "DESC", // required * }, * ColumnSort: { * SortBy: "", // required * Direction: "ASC" || "DESC", // required * AggregationFunction: "", * }, * }, * ], * SmallMultiplesLimitConfiguration: { * ItemsLimit: Number("long"), * OtherCategories: "INCLUDE" || "EXCLUDE", * }, * }, * Orientation: "HORIZONTAL" || "VERTICAL", * BarsArrangement: "CLUSTERED" || "STACKED" || "STACKED_PERCENT", * VisualPalette: { // VisualPalette * ChartColor: "STRING_VALUE", * ColorMap: [ // DataPathColorList * { // DataPathColor * Element: "", // required * Color: "STRING_VALUE", // required * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * }, * ], * }, * SmallMultiplesOptions: { // SmallMultiplesOptions * MaxVisibleRows: Number("long"), * MaxVisibleColumns: Number("long"), * PanelConfiguration: { // PanelConfiguration * Title: { // PanelTitleOptions * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: "", * HorizontalTextAlignment: "LEFT" || "CENTER" || "RIGHT" || "AUTO", * }, * BorderVisibility: "HIDDEN" || "VISIBLE", * BorderThickness: "STRING_VALUE", * BorderStyle: "SOLID" || "DASHED" || "DOTTED", * BorderColor: "STRING_VALUE", * GutterVisibility: "HIDDEN" || "VISIBLE", * GutterSpacing: "STRING_VALUE", * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, * XAxis: { // SmallMultiplesAxisProperties * Scale: "SHARED" || "INDEPENDENT", * Placement: "OUTSIDE" || "INSIDE", * }, * YAxis: { * Scale: "SHARED" || "INDEPENDENT", * Placement: "OUTSIDE" || "INSIDE", * }, * }, * CategoryAxis: { // AxisDisplayOptions * TickLabelOptions: { // AxisTickLabelOptions * LabelOptions: "", * RotationAngle: Number("double"), * }, * AxisLineVisibility: "HIDDEN" || "VISIBLE", * GridLineVisibility: "HIDDEN" || "VISIBLE", * DataOptions: { // AxisDataOptions * NumericAxisOptions: { // NumericAxisOptions * Scale: { // AxisScale * Linear: { // AxisLinearScale * StepCount: Number("int"), * StepSize: Number("double"), * }, * Logarithmic: { // AxisLogarithmicScale * Base: Number("double"), * }, * }, * Range: { // AxisDisplayRange * MinMax: { // AxisDisplayMinMaxRange * Minimum: Number("double"), * Maximum: Number("double"), * }, * DataDriven: {}, * }, * }, * DateAxisOptions: { // DateAxisOptions * MissingDateVisibility: "HIDDEN" || "VISIBLE", * }, * }, * ScrollbarOptions: { // ScrollBarOptions * Visibility: "HIDDEN" || "VISIBLE", * VisibleRange: { // VisibleRangeOptions * PercentRange: { // PercentVisibleRange * From: Number("double"), * To: Number("double"), * }, * }, * }, * AxisOffset: "STRING_VALUE", * }, * CategoryLabelOptions: { // ChartAxisLabelOptions * Visibility: "HIDDEN" || "VISIBLE", * SortIconVisibility: "HIDDEN" || "VISIBLE", * AxisLabelOptions: [ // AxisLabelOptionsList * { // AxisLabelOptions * FontConfiguration: "", * CustomLabel: "STRING_VALUE", * ApplyTo: { // AxisLabelReferenceOptions * FieldId: "STRING_VALUE", // required * Column: "", // required * }, * }, * ], * }, * ValueAxis: { * TickLabelOptions: { * LabelOptions: "", * RotationAngle: Number("double"), * }, * AxisLineVisibility: "HIDDEN" || "VISIBLE", * GridLineVisibility: "HIDDEN" || "VISIBLE", * DataOptions: { * NumericAxisOptions: { * Scale: { * Linear: { * StepCount: Number("int"), * StepSize: Number("double"), * }, * Logarithmic: { * Base: Number("double"), * }, * }, * Range: { * MinMax: { * Minimum: Number("double"), * Maximum: Number("double"), * }, * DataDriven: {}, * }, * }, * DateAxisOptions: { * MissingDateVisibility: "HIDDEN" || "VISIBLE", * }, * }, * ScrollbarOptions: { * Visibility: "HIDDEN" || "VISIBLE", * VisibleRange: { * PercentRange: { * From: Number("double"), * To: Number("double"), * }, * }, * }, * AxisOffset: "STRING_VALUE", * }, * ValueLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", * SortIconVisibility: "HIDDEN" || "VISIBLE", * AxisLabelOptions: [ * { * FontConfiguration: "", * CustomLabel: "STRING_VALUE", * ApplyTo: { * FieldId: "STRING_VALUE", // required * Column: "", // required * }, * }, * ], * }, * ColorLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", * SortIconVisibility: "HIDDEN" || "VISIBLE", * AxisLabelOptions: [ * { * FontConfiguration: "", * CustomLabel: "STRING_VALUE", * ApplyTo: { * FieldId: "STRING_VALUE", // required * Column: "", // required * }, * }, * ], * }, * DefaultSeriesSettings: { // BarChartDefaultSeriesSettings * DecalSettings: { // DecalSettings * ElementValue: "STRING_VALUE", * DecalVisibility: "HIDDEN" || "VISIBLE", * DecalColor: "STRING_VALUE", * DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL", * DecalStyleType: "Manual" || "Auto", * }, * BorderSettings: { // BorderSettings * BorderVisibility: "HIDDEN" || "VISIBLE", * BorderWidth: "STRING_VALUE", * BorderColor: "STRING_VALUE", * }, * }, * Series: [ // BarSeriesItemList * { // BarSeriesItem * FieldBarSeriesItem: { // FieldBarSeriesItem * FieldId: "STRING_VALUE", // required * Settings: { // BarChartSeriesSettings * DecalSettings: { * ElementValue: "STRING_VALUE", * DecalVisibility: "HIDDEN" || "VISIBLE", * DecalColor: "STRING_VALUE", * DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL", * DecalStyleType: "Manual" || "Auto", * }, * BorderSettings: { * BorderVisibility: "HIDDEN" || "VISIBLE", * BorderWidth: "STRING_VALUE", * BorderColor: "STRING_VALUE", * }, * }, * }, * DataFieldBarSeriesItem: { // DataFieldBarSeriesItem * FieldId: "STRING_VALUE", // required * FieldValue: "STRING_VALUE", * Settings: { * DecalSettings: { * ElementValue: "STRING_VALUE", * DecalVisibility: "HIDDEN" || "VISIBLE", * DecalColor: "STRING_VALUE", * DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL", * DecalStyleType: "Manual" || "Auto", * }, * BorderSettings: { * BorderVisibility: "HIDDEN" || "VISIBLE", * BorderWidth: "STRING_VALUE", * BorderColor: "STRING_VALUE", * }, * }, * }, * }, * ], * Legend: { // LegendOptions * Visibility: "HIDDEN" || "VISIBLE", * Title: "", * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", * ValueFontConfiguration: "", * }, * DataLabels: { // DataLabelOptions * Visibility: "HIDDEN" || "VISIBLE", * CategoryLabelVisibility: "HIDDEN" || "VISIBLE", * MeasureLabelVisibility: "HIDDEN" || "VISIBLE", * DataLabelTypes: [ // DataLabelTypes * { // DataLabelType * FieldLabelType: { // FieldLabelType * FieldId: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * DataPathLabelType: { // DataPathLabelType * FieldId: "STRING_VALUE", * FieldValue: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * RangeEndsLabelType: { // RangeEndsLabelType * Visibility: "HIDDEN" || "VISIBLE", * }, * MinimumLabelType: { // MinimumLabelType * Visibility: "HIDDEN" || "VISIBLE", * }, * MaximumLabelType: { // MaximumLabelType * Visibility: "HIDDEN" || "VISIBLE", * }, * }, * ], * Position: "INSIDE" || "OUTSIDE" || "LEFT" || "TOP" || "BOTTOM" || "RIGHT", * LabelContent: "VALUE" || "PERCENT" || "VALUE_AND_PERCENT", * LabelFontConfiguration: "", * LabelColor: "STRING_VALUE", * Overlap: "DISABLE_OVERLAP" || "ENABLE_OVERLAP", * TotalsVisibility: "HIDDEN" || "VISIBLE", * }, * Tooltip: { * TooltipVisibility: "HIDDEN" || "VISIBLE", * SelectedTooltipType: "BASIC" || "DETAILED" || "SHEET", * FieldBasedTooltip: { * AggregationVisibility: "HIDDEN" || "VISIBLE", * TooltipTitleType: "NONE" || "PRIMARY_VALUE", * TooltipFields: [ * { * FieldTooltipItem: { * FieldId: "STRING_VALUE", // required * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * TooltipTarget: "BOTH" || "BAR" || "LINE", * }, * ColumnTooltipItem: { * Column: "", // required * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * Aggregation: "", * TooltipTarget: "BOTH" || "BAR" || "LINE", * }, * }, * ], * }, * SheetTooltip: { * SheetId: "STRING_VALUE", * }, * }, * ReferenceLines: [ // ReferenceLineList * { // ReferenceLine * Status: "ENABLED" || "DISABLED", * DataConfiguration: { // ReferenceLineDataConfiguration * StaticConfiguration: { // ReferenceLineStaticDataConfiguration * Value: Number("double"), // required * }, * DynamicConfiguration: { // ReferenceLineDynamicDataConfiguration * Column: "", // required * MeasureAggregationFunction: "", * Calculation: "", // required * }, * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", * SeriesType: "BAR" || "LINE", * }, * StyleConfiguration: { // ReferenceLineStyleConfiguration * Pattern: "SOLID" || "DASHED" || "DOTTED", * Color: "STRING_VALUE", * }, * LabelConfiguration: { // ReferenceLineLabelConfiguration * ValueLabelConfiguration: { // ReferenceLineValueLabelConfiguration * RelativePosition: "BEFORE_CUSTOM_LABEL" || "AFTER_CUSTOM_LABEL", * FormatConfiguration: "", * }, * CustomLabelConfiguration: { // ReferenceLineCustomLabelConfiguration * CustomLabel: "STRING_VALUE", // required * }, * FontConfiguration: "", * FontColor: "STRING_VALUE", * HorizontalPosition: "LEFT" || "CENTER" || "RIGHT", * VerticalPosition: "ABOVE" || "BELOW", * }, * }, * ], * ContributionAnalysisDefaults: [ // ContributionAnalysisDefaultList * { // ContributionAnalysisDefault * MeasureFieldId: "STRING_VALUE", // required * ContributorDimensions: [ // ContributorDimensionList // required * "", * ], * }, * ], * Interactions: { * VisualMenuOption: { * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * ContextMenuOption: { * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * }, * Actions: [ * { * CustomActionId: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * Status: "ENABLED" || "DISABLED", * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required * ActionOperations: [ // required * { * FilterOperation: { * SelectedFieldsConfiguration: { * SelectedFields: [ * "STRING_VALUE", * ], * SelectedFieldOptions: "ALL_FIELDS", * SelectedColumns: [ * "", * ], * }, * TargetVisualsConfiguration: { * SameSheetTargetVisualConfiguration: { * TargetVisuals: [ * "STRING_VALUE", * ], * TargetVisualOptions: "ALL_VISUALS", * }, * }, * }, * NavigationOperation: { * LocalNavigationConfiguration: { * TargetSheetId: "STRING_VALUE", // required * }, * }, * URLOperation: { * URLTemplate: "STRING_VALUE", // required * URLTarget: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required * }, * SetParametersOperation: { * ParameterValueConfigurations: [ // required * { * DestinationParameterName: "STRING_VALUE", // required * Value: { * CustomValuesConfiguration: { * IncludeNullValue: true || false, * CustomValues: { * StringValues: [ * "STRING_VALUE", * ], * IntegerValues: [ * Number("long"), * ], * DecimalValues: [ * Number("double"), * ], * DateTimeValues: [ * new Date("TIMESTAMP"), * ], * }, * }, * SelectAllValueOptions: "ALL_VALUES", * SourceParameterName: "STRING_VALUE", * SourceField: "STRING_VALUE", * SourceColumn: "", * }, * }, * ], * }, * }, * ], * }, * ], * ColumnHierarchies: [ // ColumnHierarchyList * { // ColumnHierarchy * ExplicitHierarchy: { // ExplicitHierarchy * HierarchyId: "STRING_VALUE", // required * Columns: [ // ExplicitHierarchyColumnList // required * "", * ], * DrillDownFilters: [ // DrillDownFilterList * { // DrillDownFilter * NumericEqualityFilter: { // NumericEqualityDrillDownFilter * Column: "", // required * Value: Number("double"), // required * }, * CategoryFilter: { // CategoryDrillDownFilter * Column: "", // required * CategoryValues: [ // CategoryValueList // required * "STRING_VALUE", * ], * }, * TimeRangeFilter: { // TimeRangeDrillDownFilter * Column: "", // required * RangeMinimum: new Date("TIMESTAMP"), // required * RangeMaximum: new Date("TIMESTAMP"), // required * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", // required * }, * }, * ], * }, * DateTimeHierarchy: { // DateTimeHierarchy * HierarchyId: "STRING_VALUE", // required * DrillDownFilters: [ * { * NumericEqualityFilter: { * Column: "", // required * Value: Number("double"), // required * }, * CategoryFilter: { * Column: "", // required * CategoryValues: [ // required * "STRING_VALUE", * ], * }, * TimeRangeFilter: { * Column: "", // required * RangeMinimum: new Date("TIMESTAMP"), // required * RangeMaximum: new Date("TIMESTAMP"), // required * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", // required * }, * }, * ], * }, * PredefinedHierarchy: { // PredefinedHierarchy * HierarchyId: "STRING_VALUE", // required * Columns: [ // PredefinedHierarchyColumnList // required * "", * ], * DrillDownFilters: [ * { * NumericEqualityFilter: { * Column: "", // required * Value: Number("double"), // required * }, * CategoryFilter: { * Column: "", // required * CategoryValues: [ // required * "STRING_VALUE", * ], * }, * TimeRangeFilter: { * Column: "", // required * RangeMinimum: new Date("TIMESTAMP"), // required * RangeMaximum: new Date("TIMESTAMP"), // required * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", // required * }, * }, * ], * }, * }, * ], * VisualContentAltText: "STRING_VALUE", * }, * KPIVisual: { // KPIVisual * VisualId: "STRING_VALUE", // required * Title: { * Visibility: "HIDDEN" || "VISIBLE", * FormatText: { * PlainText: "STRING_VALUE", * RichText: "STRING_VALUE", * }, * }, * Subtitle: { * Visibility: "HIDDEN" || "VISIBLE", * FormatText: { * PlainText: "STRING_VALUE", * RichText: "STRING_VALUE", * }, * }, * ChartConfiguration: { // KPIConfiguration * FieldWells: { // KPIFieldWells * Values: [ * { * NumericalMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "", * FormatConfiguration: "", * }, * CategoricalMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "COUNT" || "DISTINCT_COUNT", * FormatConfiguration: "", * }, * DateMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX", * FormatConfiguration: "", * }, * CalculatedMeasureField: { * FieldId: "STRING_VALUE", // required * Expression: "STRING_VALUE", // required * }, * }, * ], * TargetValues: [ * { * NumericalMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "", * FormatConfiguration: "", * }, * CategoricalMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "COUNT" || "DISTINCT_COUNT", * FormatConfiguration: "", * }, * DateMeasureField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * AggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX", * FormatConfiguration: "", * }, * CalculatedMeasureField: { * FieldId: "STRING_VALUE", // required * Expression: "STRING_VALUE", // required * }, * }, * ], * TrendGroups: [ * "", * ], * }, * SortConfiguration: { // KPISortConfiguration * TrendGroupSort: [ * { * FieldSort: "", * ColumnSort: "", * }, * ], * }, * KPIOptions: { // KPIOptions * ProgressBar: { // ProgressBarOptions * Visibility: "HIDDEN" || "VISIBLE", * }, * TrendArrows: { // TrendArrowOptions * Visibility: "HIDDEN" || "VISIBLE", * }, * SecondaryValue: { // SecondaryValueOptions * Visibility: "HIDDEN" || "VISIBLE", * }, * Comparison: { // ComparisonConfiguration * ComparisonMethod: "DIFFERENCE" || "PERCENT_DIFFERENCE" || "PERCENT", * ComparisonFormat: { // ComparisonFormatConfiguration * NumberDisplayFormatConfiguration: "", * PercentageDisplayFormatConfiguration: "", * }, * }, * PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL", * PrimaryValueFontConfiguration: "", * SecondaryValueFontConfiguration: "", * Sparkline: { // KPISparklineOptions * Visibility: "HIDDEN" || "VISIBLE", * Type: "LINE" || "AREA", // required * Color: "STRING_VALUE", * TooltipVisibility: "HIDDEN" || "VISIBLE", * }, * VisualLayoutOptions: { // KPIVisualLayoutOptions * StandardLayout: { // KPIVisualStandardLayout * Type: "CLASSIC" || "VERTICAL", // required * }, * }, * }, * Interactions: { * VisualMenuOption: { * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * ContextMenuOption: { * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * }, * ConditionalFormatting: { // KPIConditionalFormatting * ConditionalFormattingOptions: [ // KPIConditionalFormattingOptionList * { // KPIConditionalFormattingOption * PrimaryValue: { // KPIPrimaryValueConditionalFormatting * TextColor: "", * Icon: { * IconSet: { * Expression: "STRING_VALUE", // required * IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW", * }, * CustomCondition: { * Expression: "STRING_VALUE", // required * IconOptions: { * Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X", * UnicodeIcon: "STRING_VALUE", * }, * Color: "STRING_VALUE", * DisplayConfiguration: { * IconDisplayOption: "ICON_ONLY", * }, * }, * }, * }, * ProgressBar: { // KPIProgressBarConditionalFormatting * ForegroundColor: "", * }, * ActualValue: { // KPIActualValueConditionalFormatting * TextColor: "", * Icon: { * IconSet: { * Expression: "STRING_VALUE", // required * IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW", * }, * CustomCondition: { * Expression: "STRING_VALUE", // required * IconOptions: { * Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X", * UnicodeIcon: "STRING_VALUE", * }, * Color: "STRING_VALUE", * DisplayConfiguration: { * IconDisplayOption: "ICON_ONLY", * }, * }, * }, * }, * ComparisonValue: { // KPIComparisonValueConditionalFormatting * TextColor: "", * Icon: { * IconSet: { * Expression: "STRING_VALUE", // required * IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW", * }, * CustomCondition: { * Expression: "STRING_VALUE", // required * IconOptions: { * Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X", * UnicodeIcon: "STRING_VALUE", * }, * Color: "STRING_VALUE", * DisplayConfiguration: { * IconDisplayOption: "ICON_ONLY", * }, * }, * }, * }, * }, * ], * }, * Actions: [ * { * CustomActionId: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * Status: "ENABLED" || "DISABLED", * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required * ActionOperations: [ // required * { * FilterOperation: { * SelectedFieldsConfiguration: { * SelectedFields: [ * "STRING_VALUE", * ], * SelectedFieldOptions: "ALL_FIELDS", * SelectedColumns: [ * "", * ], * }, * TargetVisualsConfiguration: { * SameSheetTargetVisualConfiguration: { * TargetVisuals: [ * "STRING_VALUE", * ], * TargetVisualOptions: "ALL_VISUALS", * }, * }, * }, * NavigationOperation: { * LocalNavigationConfiguration: { * TargetSheetId: "STRING_VALUE", // required * }, * }, * URLOperation: { * URLTemplate: "STRING_VALUE", // required * URLTarget: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required * }, * SetParametersOperation: { * ParameterValueConfigurations: [ // required * { * DestinationParameterName: "STRING_VALUE", // required * Value: { * CustomValuesConfiguration: { * IncludeNullValue: true || false, * CustomValues: { * StringValues: [ * "STRING_VALUE", * ], * IntegerValues: [ * Number("long"), * ], * DecimalValues: [ * Number("double"), * ], * DateTimeValues: [ * new Date("TIMESTAMP"), * ], * }, * }, * SelectAllValueOptions: "ALL_VALUES", * SourceParameterName: "STRING_VALUE", * SourceField: "STRING_VALUE", * SourceColumn: "", * }, * }, * ], * }, * }, * ], * }, * ], * ColumnHierarchies: [ * { * ExplicitHierarchy: { * HierarchyId: "STRING_VALUE", // required * Columns: [ // required * "", * ], * DrillDownFilters: [ * { * NumericEqualityFilter: { * Column: "", // required * Value: Number("double"), // required * }, * CategoryFilter: { * Column: "", // required * CategoryValues: [ // required * "STRING_VALUE", * ], * }, * TimeRangeFilter: { * Column: "", // required * RangeMinimum: new Date("TIMESTAMP"), // required * RangeMaximum: new Date("TIMESTAMP"), // required * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", // required * }, * }, * ], * }, * DateTimeHierarchy: { * HierarchyId: "STRING_VALUE", // required * DrillDownFilters: [ * { * NumericEqualityFilter: { * Column: "", // required * Value: Number("double"), // required * }, * CategoryFilter: { * Column: "", // required * CategoryValues: [ // required * "STRING_VALUE", * ], * }, * TimeRangeFilter: { * Column: "", // required * RangeMinimum: new Date("TIMESTAMP"), // required * RangeMaximum: new Date("TIMESTAMP"), // required * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", // required * }, * }, * ], * }, * PredefinedHierarchy: { * HierarchyId: "STRING_VALUE", // required * Columns: [ // required * "", * ], * DrillDownFilters: "", * }, * }, * ], * VisualContentAltText: "STRING_VALUE", * }, * PieChartVisual: { // PieChartVisual * VisualId: "STRING_VALUE", // required * Title: { * Visibility: "HIDDEN" || "VISIBLE", * FormatText: { * PlainText: "STRING_VALUE", * RichText: "STRING_VALUE", * }, * }, * Subtitle: { * Visibility: "HIDDEN" || "VISIBLE", * FormatText: { * PlainText: "STRING_VALUE", * RichText: "STRING_VALUE", * }, * }, * ChartConfiguration: { // PieChartConfiguration * FieldWells: { // PieChartFieldWells * PieChartAggregatedFieldWells: { // PieChartAggregatedFieldWells * Category: [ * "", * ], * Values: [ * "", * ], * SmallMultiples: [ * "", * ], * }, * }, * SortConfiguration: { // PieChartSortConfiguration * CategorySort: [ * "", * ], * CategoryItemsLimit: { * ItemsLimit: Number("long"), * OtherCategories: "INCLUDE" || "EXCLUDE", * }, * SmallMultiplesSort: "", * SmallMultiplesLimitConfiguration: { * ItemsLimit: Number("long"), * OtherCategories: "INCLUDE" || "EXCLUDE", * }, * }, * DonutOptions: { // DonutOptions * ArcOptions: { // ArcOptions * ArcThickness: "SMALL" || "MEDIUM" || "LARGE" || "WHOLE", * }, * DonutCenterOptions: { // DonutCenterOptions * LabelVisibility: "HIDDEN" || "VISIBLE", * }, * }, * SmallMultiplesOptions: { * MaxVisibleRows: Number("long"), * MaxVisibleColumns: Number("long"), * PanelConfiguration: { * Title: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: "", * HorizontalTextAlignment: "LEFT" || "CENTER" || "RIGHT" || "AUTO", * }, * BorderVisibility: "HIDDEN" || "VISIBLE", * BorderThickness: "STRING_VALUE", * BorderStyle: "SOLID" || "DASHED" || "DOTTED", * BorderColor: "STRING_VALUE", * GutterVisibility: "HIDDEN" || "VISIBLE", * GutterSpacing: "STRING_VALUE", * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, * XAxis: { * Scale: "SHARED" || "INDEPENDENT", * Placement: "OUTSIDE" || "INSIDE", * }, * YAxis: { * Scale: "SHARED" || "INDEPENDENT", * Placement: "OUTSIDE" || "INSIDE", * }, * }, * CategoryLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", * SortIconVisibility: "HIDDEN" || "VISIBLE", * AxisLabelOptions: [ * { * FontConfiguration: "", * CustomLabel: "STRING_VALUE", * ApplyTo: { * FieldId: "STRING_VALUE", // required * Column: "", // required * }, * }, * ], * }, * ValueLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", * SortIconVisibility: "HIDDEN" || "VISIBLE", * AxisLabelOptions: [ * { * FontConfiguration: "", * CustomLabel: "STRING_VALUE", * ApplyTo: { * FieldId: "STRING_VALUE", // required * Column: "", // required * }, * }, * ], * }, * Legend: { * Visibility: "HIDDEN" || "VISIBLE", * Title: "", * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", * CategoryLabelVisibility: "HIDDEN" || "VISIBLE", * MeasureLabelVisibility: "HIDDEN" || "VISIBLE", * DataLabelTypes: [ * { * FieldLabelType: { * FieldId: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * DataPathLabelType: { * FieldId: "STRING_VALUE", * FieldValue: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * RangeEndsLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * MinimumLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * MaximumLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * }, * ], * Position: "INSIDE" || "OUTSIDE" || "LEFT" || "TOP" || "BOTTOM" || "RIGHT", * LabelContent: "VALUE" || "PERCENT" || "VALUE_AND_PERCENT", * LabelFontConfiguration: "", * LabelColor: "STRING_VALUE", * Overlap: "DISABLE_OVERLAP" || "ENABLE_OVERLAP", * TotalsVisibility: "HIDDEN" || "VISIBLE", * }, * Tooltip: { * TooltipVisibility: "HIDDEN" || "VISIBLE", * SelectedTooltipType: "BASIC" || "DETAILED" || "SHEET", * FieldBasedTooltip: { * AggregationVisibility: "HIDDEN" || "VISIBLE", * TooltipTitleType: "NONE" || "PRIMARY_VALUE", * TooltipFields: [ * { * FieldTooltipItem: { * FieldId: "STRING_VALUE", // required * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * TooltipTarget: "BOTH" || "BAR" || "LINE", * }, * ColumnTooltipItem: { * Column: "", // required * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * Aggregation: "", * TooltipTarget: "BOTH" || "BAR" || "LINE", * }, * }, * ], * }, * SheetTooltip: { * SheetId: "STRING_VALUE", * }, * }, * VisualPalette: { * ChartColor: "STRING_VALUE", * ColorMap: [ * { * Element: "", // required * Color: "STRING_VALUE", // required * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * }, * ], * }, * ContributionAnalysisDefaults: [ * { * MeasureFieldId: "STRING_VALUE", // required * ContributorDimensions: [ // required * "", * ], * }, * ], * Interactions: { * VisualMenuOption: "", * ContextMenuOption: { * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * }, * Actions: [ * { * CustomActionId: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * Status: "ENABLED" || "DISABLED", * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required * ActionOperations: [ // required * { * FilterOperation: { * SelectedFieldsConfiguration: { * SelectedFields: [ * "STRING_VALUE", * ], * SelectedFieldOptions: "ALL_FIELDS", * SelectedColumns: [ * "", * ], * }, * TargetVisualsConfiguration: { * SameSheetTargetVisualConfiguration: { * TargetVisuals: [ * "STRING_VALUE", * ], * TargetVisualOptions: "ALL_VISUALS", * }, * }, * }, * NavigationOperation: { * LocalNavigationConfiguration: { * TargetSheetId: "STRING_VALUE", // required * }, * }, * URLOperation: { * URLTemplate: "STRING_VALUE", // required * URLTarget: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required * }, * SetParametersOperation: { * ParameterValueConfigurations: [ // required * { * DestinationParameterName: "STRING_VALUE", // required * Value: { * CustomValuesConfiguration: { * IncludeNullValue: true || false, * CustomValues: { * StringValues: [ * "STRING_VALUE", * ], * IntegerValues: [ * Number("long"), * ], * DecimalValues: [ * Number("double"), * ], * DateTimeValues: [ * new Date("TIMESTAMP"), * ], * }, * }, * SelectAllValueOptions: "ALL_VALUES", * SourceParameterName: "STRING_VALUE", * SourceField: "STRING_VALUE", * SourceColumn: "", * }, * }, * ], * }, * }, * ], * }, * ], * ColumnHierarchies: [ * { * ExplicitHierarchy: { * HierarchyId: "STRING_VALUE", // required * Columns: [ // required * "", * ], * DrillDownFilters: "", * }, * DateTimeHierarchy: { * HierarchyId: "STRING_VALUE", // required * DrillDownFilters: "", * }, * PredefinedHierarchy: { * HierarchyId: "STRING_VALUE", // required * Columns: [ // required * "", * ], * DrillDownFilters: "", * }, * }, * ], * VisualContentAltText: "STRING_VALUE", * }, * GaugeChartVisual: { // GaugeChartVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // GaugeChartConfiguration * FieldWells: { // GaugeChartFieldWells * Values: "", * TargetValues: "", * }, * GaugeChartOptions: { // GaugeChartOptions * PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL", * Comparison: { * ComparisonMethod: "DIFFERENCE" || "PERCENT_DIFFERENCE" || "PERCENT", * ComparisonFormat: { * NumberDisplayFormatConfiguration: "", * PercentageDisplayFormatConfiguration: "", * }, * }, * ArcAxis: { // ArcAxisConfiguration * Range: { // ArcAxisDisplayRange * Min: Number("double"), * Max: Number("double"), * }, * ReserveRange: Number("int"), * }, * Arc: { // ArcConfiguration * ArcAngle: Number("double"), * ArcThickness: "SMALL" || "MEDIUM" || "LARGE", * }, * PrimaryValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", * CategoryLabelVisibility: "HIDDEN" || "VISIBLE", * MeasureLabelVisibility: "HIDDEN" || "VISIBLE", * DataLabelTypes: [ * { * FieldLabelType: { * FieldId: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * DataPathLabelType: { * FieldId: "STRING_VALUE", * FieldValue: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * RangeEndsLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * MinimumLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * MaximumLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * }, * ], * Position: "INSIDE" || "OUTSIDE" || "LEFT" || "TOP" || "BOTTOM" || "RIGHT", * LabelContent: "VALUE" || "PERCENT" || "VALUE_AND_PERCENT", * LabelFontConfiguration: "", * LabelColor: "STRING_VALUE", * Overlap: "DISABLE_OVERLAP" || "ENABLE_OVERLAP", * TotalsVisibility: "HIDDEN" || "VISIBLE", * }, * TooltipOptions: { * TooltipVisibility: "HIDDEN" || "VISIBLE", * SelectedTooltipType: "BASIC" || "DETAILED" || "SHEET", * FieldBasedTooltip: { * AggregationVisibility: "HIDDEN" || "VISIBLE", * TooltipTitleType: "NONE" || "PRIMARY_VALUE", * TooltipFields: [ * { * FieldTooltipItem: { * FieldId: "STRING_VALUE", // required * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * TooltipTarget: "BOTH" || "BAR" || "LINE", * }, * ColumnTooltipItem: { * Column: "", // required * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * Aggregation: "", * TooltipTarget: "BOTH" || "BAR" || "LINE", * }, * }, * ], * }, * SheetTooltip: { * SheetId: "STRING_VALUE", * }, * }, * VisualPalette: { * ChartColor: "STRING_VALUE", * ColorMap: [ * { * Element: "", // required * Color: "STRING_VALUE", // required * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * }, * ], * }, * ColorConfiguration: { // GaugeChartColorConfiguration * ForegroundColor: "STRING_VALUE", * BackgroundColor: "STRING_VALUE", * }, * Interactions: "", * }, * ConditionalFormatting: { // GaugeChartConditionalFormatting * ConditionalFormattingOptions: [ // GaugeChartConditionalFormattingOptionList * { // GaugeChartConditionalFormattingOption * PrimaryValue: { // GaugeChartPrimaryValueConditionalFormatting * TextColor: "", * Icon: "", * }, * Arc: { // GaugeChartArcConditionalFormatting * ForegroundColor: "", * }, * }, * ], * }, * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * LineChartVisual: { // LineChartVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // LineChartConfiguration * FieldWells: { // LineChartFieldWells * LineChartAggregatedFieldWells: { // LineChartAggregatedFieldWells * Category: "", * Values: "", * Colors: "", * SmallMultiples: [ * "", * ], * }, * }, * SortConfiguration: { // LineChartSortConfiguration * CategorySort: "", * CategoryItemsLimitConfiguration: "", * ColorItemsLimitConfiguration: "", * SmallMultiplesSort: "", * SmallMultiplesLimitConfiguration: "", * }, * ForecastConfigurations: [ // ForecastConfigurationList * { // ForecastConfiguration * ForecastProperties: { // TimeBasedForecastProperties * PeriodsForward: Number("int"), * PeriodsBackward: Number("int"), * UpperBoundary: Number("double"), * LowerBoundary: Number("double"), * PredictionInterval: Number("int"), * Seasonality: Number("int"), * }, * Scenario: { // ForecastScenario * WhatIfPointScenario: { // WhatIfPointScenario * Date: new Date("TIMESTAMP"), // required * Value: Number("double"), // required * }, * WhatIfRangeScenario: { // WhatIfRangeScenario * StartDate: new Date("TIMESTAMP"), // required * EndDate: new Date("TIMESTAMP"), // required * Value: Number("double"), // required * }, * }, * }, * ], * Type: "LINE" || "AREA" || "STACKED_AREA", * SmallMultiplesOptions: { * MaxVisibleRows: Number("long"), * MaxVisibleColumns: Number("long"), * PanelConfiguration: { * Title: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: "", * HorizontalTextAlignment: "LEFT" || "CENTER" || "RIGHT" || "AUTO", * }, * BorderVisibility: "HIDDEN" || "VISIBLE", * BorderThickness: "STRING_VALUE", * BorderStyle: "SOLID" || "DASHED" || "DOTTED", * BorderColor: "STRING_VALUE", * GutterVisibility: "HIDDEN" || "VISIBLE", * GutterSpacing: "STRING_VALUE", * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, * XAxis: { * Scale: "SHARED" || "INDEPENDENT", * Placement: "OUTSIDE" || "INSIDE", * }, * YAxis: "", * }, * XAxisDisplayOptions: { * TickLabelOptions: { * LabelOptions: "", * RotationAngle: Number("double"), * }, * AxisLineVisibility: "HIDDEN" || "VISIBLE", * GridLineVisibility: "HIDDEN" || "VISIBLE", * DataOptions: { * NumericAxisOptions: { * Scale: { * Linear: { * StepCount: Number("int"), * StepSize: Number("double"), * }, * Logarithmic: { * Base: Number("double"), * }, * }, * Range: { * MinMax: { * Minimum: Number("double"), * Maximum: Number("double"), * }, * DataDriven: {}, * }, * }, * DateAxisOptions: { * MissingDateVisibility: "HIDDEN" || "VISIBLE", * }, * }, * ScrollbarOptions: { * Visibility: "HIDDEN" || "VISIBLE", * VisibleRange: { * PercentRange: { * From: Number("double"), * To: Number("double"), * }, * }, * }, * AxisOffset: "STRING_VALUE", * }, * XAxisLabelOptions: "", * PrimaryYAxisDisplayOptions: { // LineSeriesAxisDisplayOptions * AxisOptions: { * TickLabelOptions: { * LabelOptions: "", * RotationAngle: Number("double"), * }, * AxisLineVisibility: "HIDDEN" || "VISIBLE", * GridLineVisibility: "HIDDEN" || "VISIBLE", * DataOptions: { * NumericAxisOptions: { * Scale: { * Linear: { * StepCount: Number("int"), * StepSize: Number("double"), * }, * Logarithmic: { * Base: Number("double"), * }, * }, * Range: { * MinMax: { * Minimum: Number("double"), * Maximum: Number("double"), * }, * DataDriven: {}, * }, * }, * DateAxisOptions: { * MissingDateVisibility: "HIDDEN" || "VISIBLE", * }, * }, * ScrollbarOptions: { * Visibility: "HIDDEN" || "VISIBLE", * VisibleRange: { * PercentRange: { * From: Number("double"), * To: Number("double"), * }, * }, * }, * AxisOffset: "STRING_VALUE", * }, * MissingDataConfigurations: [ // MissingDataConfigurationList * { // MissingDataConfiguration * TreatmentOption: "INTERPOLATE" || "SHOW_AS_ZERO" || "SHOW_AS_BLANK", * }, * ], * }, * PrimaryYAxisLabelOptions: "", * SecondaryYAxisDisplayOptions: { * AxisOptions: { * TickLabelOptions: { * LabelOptions: "", * RotationAngle: Number("double"), * }, * AxisLineVisibility: "HIDDEN" || "VISIBLE", * GridLineVisibility: "HIDDEN" || "VISIBLE", * DataOptions: { * NumericAxisOptions: { * Scale: { * Linear: { * StepCount: Number("int"), * StepSize: Number("double"), * }, * Logarithmic: { * Base: Number("double"), * }, * }, * Range: { * MinMax: { * Minimum: Number("double"), * Maximum: Number("double"), * }, * DataDriven: {}, * }, * }, * DateAxisOptions: { * MissingDateVisibility: "HIDDEN" || "VISIBLE", * }, * }, * ScrollbarOptions: { * Visibility: "HIDDEN" || "VISIBLE", * VisibleRange: { * PercentRange: { * From: Number("double"), * To: Number("double"), * }, * }, * }, * AxisOffset: "STRING_VALUE", * }, * MissingDataConfigurations: [ * { * TreatmentOption: "INTERPOLATE" || "SHOW_AS_ZERO" || "SHOW_AS_BLANK", * }, * ], * }, * SecondaryYAxisLabelOptions: "", * SingleAxisOptions: { // SingleAxisOptions * YAxisOptions: { // YAxisOptions * YAxis: "PRIMARY_Y_AXIS", // required * }, * }, * DefaultSeriesSettings: { // LineChartDefaultSeriesSettings * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", * LineStyleSettings: { // LineChartLineStyleSettings * LineVisibility: "HIDDEN" || "VISIBLE", * LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED", * LineStyle: "SOLID" || "DOTTED" || "DASHED", * LineWidth: "STRING_VALUE", * }, * MarkerStyleSettings: { * MarkerVisibility: "HIDDEN" || "VISIBLE", * MarkerShape: "CIRCLE" || "TRIANGLE" || "SQUARE" || "DIAMOND" || "ROUNDED_SQUARE", * MarkerSize: "STRING_VALUE", * MarkerColor: "STRING_VALUE", * }, * DecalSettings: { * ElementValue: "STRING_VALUE", * DecalVisibility: "HIDDEN" || "VISIBLE", * DecalColor: "STRING_VALUE", * DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL", * DecalStyleType: "Manual" || "Auto", * }, * }, * Series: [ // SeriesItemList * { // SeriesItem * FieldSeriesItem: { // FieldSeriesItem * FieldId: "STRING_VALUE", // required * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", // required * Settings: { // LineChartSeriesSettings * LineStyleSettings: { * LineVisibility: "HIDDEN" || "VISIBLE", * LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED", * LineStyle: "SOLID" || "DOTTED" || "DASHED", * LineWidth: "STRING_VALUE", * }, * MarkerStyleSettings: "", * DecalSettings: { * ElementValue: "STRING_VALUE", * DecalVisibility: "HIDDEN" || "VISIBLE", * DecalColor: "STRING_VALUE", * DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL", * DecalStyleType: "Manual" || "Auto", * }, * }, * }, * DataFieldSeriesItem: { // DataFieldSeriesItem * FieldId: "STRING_VALUE", // required * FieldValue: "STRING_VALUE", * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", // required * Settings: { * LineStyleSettings: { * LineVisibility: "HIDDEN" || "VISIBLE", * LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED", * LineStyle: "SOLID" || "DOTTED" || "DASHED", * LineWidth: "STRING_VALUE", * }, * MarkerStyleSettings: "", * DecalSettings: "", * }, * }, * }, * ], * Legend: { * Visibility: "HIDDEN" || "VISIBLE", * Title: "", * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", * CategoryLabelVisibility: "HIDDEN" || "VISIBLE", * MeasureLabelVisibility: "HIDDEN" || "VISIBLE", * DataLabelTypes: [ * { * FieldLabelType: { * FieldId: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * DataPathLabelType: { * FieldId: "STRING_VALUE", * FieldValue: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * RangeEndsLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * MinimumLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * MaximumLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * }, * ], * Position: "INSIDE" || "OUTSIDE" || "LEFT" || "TOP" || "BOTTOM" || "RIGHT", * LabelContent: "VALUE" || "PERCENT" || "VALUE_AND_PERCENT", * LabelFontConfiguration: "", * LabelColor: "STRING_VALUE", * Overlap: "DISABLE_OVERLAP" || "ENABLE_OVERLAP", * TotalsVisibility: "HIDDEN" || "VISIBLE", * }, * ReferenceLines: [ * { * Status: "ENABLED" || "DISABLED", * DataConfiguration: { * StaticConfiguration: { * Value: Number("double"), // required * }, * DynamicConfiguration: { * Column: "", // required * MeasureAggregationFunction: "", * Calculation: "", // required * }, * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", * SeriesType: "BAR" || "LINE", * }, * StyleConfiguration: { * Pattern: "SOLID" || "DASHED" || "DOTTED", * Color: "STRING_VALUE", * }, * LabelConfiguration: { * ValueLabelConfiguration: { * RelativePosition: "BEFORE_CUSTOM_LABEL" || "AFTER_CUSTOM_LABEL", * FormatConfiguration: "", * }, * CustomLabelConfiguration: { * CustomLabel: "STRING_VALUE", // required * }, * FontConfiguration: "", * FontColor: "STRING_VALUE", * HorizontalPosition: "LEFT" || "CENTER" || "RIGHT", * VerticalPosition: "ABOVE" || "BELOW", * }, * }, * ], * Tooltip: "", * ContributionAnalysisDefaults: [ * { * MeasureFieldId: "STRING_VALUE", // required * ContributorDimensions: [ // required * "", * ], * }, * ], * VisualPalette: { * ChartColor: "STRING_VALUE", * ColorMap: [ * { * Element: "", // required * Color: "STRING_VALUE", // required * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * }, * ], * }, * Interactions: "", * }, * Actions: "", * ColumnHierarchies: [ * { * ExplicitHierarchy: { * HierarchyId: "STRING_VALUE", // required * Columns: [ // required * "", * ], * DrillDownFilters: "", * }, * DateTimeHierarchy: { * HierarchyId: "STRING_VALUE", // required * DrillDownFilters: "", * }, * PredefinedHierarchy: { * HierarchyId: "STRING_VALUE", // required * Columns: [ // required * "", * ], * DrillDownFilters: "", * }, * }, * ], * VisualContentAltText: "STRING_VALUE", * }, * HeatMapVisual: { // HeatMapVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // HeatMapConfiguration * FieldWells: { // HeatMapFieldWells * HeatMapAggregatedFieldWells: { // HeatMapAggregatedFieldWells * Rows: [ // HeatMapDimensionFieldList * "", * ], * Columns: [ * "", * ], * Values: [ // HeatMapMeasureFieldList * "", * ], * }, * }, * SortConfiguration: { // HeatMapSortConfiguration * HeatMapRowSort: "", * HeatMapColumnSort: "", * HeatMapRowItemsLimitConfiguration: "", * HeatMapColumnItemsLimitConfiguration: "", * }, * RowAxisDisplayOptions: "", * RowLabelOptions: "", * ColumnAxisDisplayOptions: "", * ColumnLabelOptions: "", * ColorScale: { // ColorScale * Colors: [ // ColorScaleColorList // required * { // DataColor * Color: "STRING_VALUE", * DataValue: Number("double"), * }, * ], * ColorFillType: "DISCRETE" || "GRADIENT", // required * NullValueColor: { * Color: "STRING_VALUE", * DataValue: Number("double"), * }, * }, * Legend: { * Visibility: "HIDDEN" || "VISIBLE", * Title: "", * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", * ValueFontConfiguration: "", * }, * DataLabels: { * Visibility: "HIDDEN" || "VISIBLE", * CategoryLabelVisibility: "HIDDEN" || "VISIBLE", * MeasureLabelVisibility: "HIDDEN" || "VISIBLE", * DataLabelTypes: [ * { * FieldLabelType: { * FieldId: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * DataPathLabelType: { * FieldId: "STRING_VALUE", * FieldValue: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * RangeEndsLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * MinimumLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * MaximumLabelType: { * Visibility: "HIDDEN" || "VISIBLE", * }, * }, * ], * Position: "INSIDE" || "OUTSIDE" || "LEFT" || "TOP" || "BOTTOM" || "RIGHT", * LabelContent: "VALUE" || "PERCENT" || "VALUE_AND_PERCENT", * LabelFontConfiguration: "", * LabelColor: "STRING_VALUE", * Overlap: "DISABLE_OVERLAP" || "ENABLE_OVERLAP", * TotalsVisibility: "HIDDEN" || "VISIBLE", * }, * Tooltip: "", * Interactions: "", * }, * ColumnHierarchies: [ * { * ExplicitHierarchy: { * HierarchyId: "STRING_VALUE", // required * Columns: [ // required * "", * ], * DrillDownFilters: "", * }, * DateTimeHierarchy: { * HierarchyId: "STRING_VALUE", // required * DrillDownFilters: "", * }, * PredefinedHierarchy: { * HierarchyId: "STRING_VALUE", // required * Columns: [ // required * "", * ], * DrillDownFilters: "", * }, * }, * ], * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * TreeMapVisual: { // TreeMapVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // TreeMapConfiguration * FieldWells: { // TreeMapFieldWells * TreeMapAggregatedFieldWells: { // TreeMapAggregatedFieldWells * Groups: [ // TreeMapDimensionFieldList * "", * ], * Sizes: [ // TreeMapMeasureFieldList * "", * ], * Colors: [ * "", * ], * }, * }, * SortConfiguration: { // TreeMapSortConfiguration * TreeMapSort: "", * TreeMapGroupItemsLimitConfiguration: "", * }, * GroupLabelOptions: "", * SizeLabelOptions: "", * ColorLabelOptions: "", * ColorScale: { * Colors: [ // required * { * Color: "STRING_VALUE", * DataValue: Number("double"), * }, * ], * ColorFillType: "DISCRETE" || "GRADIENT", // required * NullValueColor: { * Color: "STRING_VALUE", * DataValue: Number("double"), * }, * }, * Legend: { * Visibility: "HIDDEN" || "VISIBLE", * Title: "", * Position: "AUTO" || "RIGHT" || "BOTTOM" || "TOP", * Width: "STRING_VALUE", * Height: "STRING_VALUE", * ValueFontConfiguration: "", * }, * DataLabels: "", * Tooltip: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * GeospatialMapVisual: { // GeospatialMapVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // GeospatialMapConfiguration * FieldWells: { // GeospatialMapFieldWells * GeospatialMapAggregatedFieldWells: { // GeospatialMapAggregatedFieldWells * Geospatial: "", * Values: "", * Colors: "", * }, * }, * Legend: "", * Tooltip: "", * WindowOptions: { // GeospatialWindowOptions * Bounds: { // GeospatialCoordinateBounds * North: Number("double"), // required * South: Number("double"), // required * West: Number("double"), // required * East: Number("double"), // required * }, * MapZoomMode: "AUTO" || "MANUAL", * }, * MapStyleOptions: { // GeospatialMapStyleOptions * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", * }, * PointStyleOptions: { // GeospatialPointStyleOptions * SelectedPointStyle: "POINT" || "CLUSTER" || "HEATMAP", * ClusterMarkerConfiguration: { // ClusterMarkerConfiguration * ClusterMarker: { // ClusterMarker * SimpleClusterMarker: { // SimpleClusterMarker * Color: "STRING_VALUE", * }, * }, * }, * HeatmapConfiguration: { // GeospatialHeatmapConfiguration * HeatmapColor: { // GeospatialHeatmapColorScale * Colors: [ // GeospatialHeatmapDataColorList * { // GeospatialHeatmapDataColor * Color: "STRING_VALUE", // required * }, * ], * }, * }, * }, * VisualPalette: { * ChartColor: "STRING_VALUE", * ColorMap: [ * { * Element: "", // required * Color: "STRING_VALUE", // required * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * }, * ], * }, * Interactions: "", * }, * ColumnHierarchies: "", * Actions: "", * VisualContentAltText: "STRING_VALUE", * GeocodingPreferences: [ // GeocodePreferenceList * { // GeocodePreference * RequestKey: { // GeocoderHierarchy * Country: "STRING_VALUE", * State: "STRING_VALUE", * County: "STRING_VALUE", * City: "STRING_VALUE", * PostCode: "STRING_VALUE", * }, * Preference: { // GeocodePreferenceValue Union: only one key present * GeocoderHierarchy: { * Country: "STRING_VALUE", * State: "STRING_VALUE", * County: "STRING_VALUE", * City: "STRING_VALUE", * PostCode: "STRING_VALUE", * }, * Coordinate: { // Coordinate * Latitude: Number("double"), // required * Longitude: Number("double"), // required * }, * }, * }, * ], * }, * FilledMapVisual: { // FilledMapVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // FilledMapConfiguration * FieldWells: { // FilledMapFieldWells * FilledMapAggregatedFieldWells: { // FilledMapAggregatedFieldWells * Geospatial: [ // FilledMapDimensionFieldList * "", * ], * Values: [ // FilledMapMeasureFieldList * "", * ], * }, * }, * SortConfiguration: { // FilledMapSortConfiguration * CategorySort: "", * }, * Legend: "", * Tooltip: "", * WindowOptions: { * Bounds: { * North: Number("double"), // required * South: Number("double"), // required * West: Number("double"), // required * East: Number("double"), // required * }, * MapZoomMode: "AUTO" || "MANUAL", * }, * MapStyleOptions: { * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", * }, * Interactions: "", * }, * ConditionalFormatting: { // FilledMapConditionalFormatting * ConditionalFormattingOptions: [ // FilledMapConditionalFormattingOptionList // required * { // FilledMapConditionalFormattingOption * Shape: { // FilledMapShapeConditionalFormatting * FieldId: "STRING_VALUE", // required * Format: { // ShapeConditionalFormat * BackgroundColor: "", // required * }, * }, * }, * ], * }, * ColumnHierarchies: "", * Actions: "", * VisualContentAltText: "STRING_VALUE", * GeocodingPreferences: [ * { * RequestKey: { * Country: "STRING_VALUE", * State: "STRING_VALUE", * County: "STRING_VALUE", * City: "STRING_VALUE", * PostCode: "STRING_VALUE", * }, * Preference: {// Union: only one key present * GeocoderHierarchy: { * Country: "STRING_VALUE", * State: "STRING_VALUE", * County: "STRING_VALUE", * City: "STRING_VALUE", * PostCode: "STRING_VALUE", * }, * Coordinate: { * Latitude: Number("double"), // required * Longitude: Number("double"), // required * }, * }, * }, * ], * }, * LayerMapVisual: { // LayerMapVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // GeospatialLayerMapConfiguration * Legend: "", * MapLayers: [ // GeospatialMapLayerList * { // GeospatialLayerItem * LayerId: "STRING_VALUE", // required * LayerType: "POINT" || "LINE" || "POLYGON", * DataSource: { // GeospatialDataSourceItem * StaticFileDataSource: { // GeospatialStaticFileSource * StaticFileId: "STRING_VALUE", // required * }, * }, * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * LayerDefinition: { // GeospatialLayerDefinition * PointLayer: { // GeospatialPointLayer * Style: { // GeospatialPointStyle * CircleSymbolStyle: { // GeospatialCircleSymbolStyle * FillColor: { // GeospatialColor * Solid: { // GeospatialSolidColor * Color: "STRING_VALUE", // required * State: "ENABLED" || "DISABLED", * }, * Gradient: { // GeospatialGradientColor * StepColors: [ // GeospatialGradientStepColorList // required * { // GeospatialGradientStepColor * Color: "STRING_VALUE", // required * DataValue: Number("double"), // required * }, * ], * NullDataVisibility: "HIDDEN" || "VISIBLE", * NullDataSettings: { // GeospatialNullDataSettings * SymbolStyle: { // GeospatialNullSymbolStyle * FillColor: "STRING_VALUE", * StrokeColor: "STRING_VALUE", * StrokeWidth: Number("double"), * }, * }, * DefaultOpacity: Number("double"), * }, * Categorical: { // GeospatialCategoricalColor * CategoryDataColors: [ // GeospatialCategoricalDataColorList // required * { // GeospatialCategoricalDataColor * Color: "STRING_VALUE", // required * DataValue: "STRING_VALUE", // required * }, * ], * NullDataVisibility: "HIDDEN" || "VISIBLE", * NullDataSettings: { * SymbolStyle: { * FillColor: "STRING_VALUE", * StrokeColor: "STRING_VALUE", * StrokeWidth: Number("double"), * }, * }, * DefaultOpacity: Number("double"), * }, * }, * StrokeColor: { * Solid: { * Color: "STRING_VALUE", // required * State: "ENABLED" || "DISABLED", * }, * Gradient: { * StepColors: [ // required * { * Color: "STRING_VALUE", // required * DataValue: Number("double"), // required * }, * ], * NullDataVisibility: "HIDDEN" || "VISIBLE", * NullDataSettings: { * SymbolStyle: { * FillColor: "STRING_VALUE", * StrokeColor: "STRING_VALUE", * StrokeWidth: Number("double"), * }, * }, * DefaultOpacity: Number("double"), * }, * Categorical: { * CategoryDataColors: [ // required * { * Color: "STRING_VALUE", // required * DataValue: "STRING_VALUE", // required * }, * ], * NullDataVisibility: "HIDDEN" || "VISIBLE", * NullDataSettings: { * SymbolStyle: { * FillColor: "STRING_VALUE", * StrokeColor: "STRING_VALUE", * StrokeWidth: Number("double"), * }, * }, * DefaultOpacity: Number("double"), * }, * }, * StrokeWidth: { // GeospatialLineWidth * LineWidth: Number("double"), * }, * CircleRadius: { // GeospatialCircleRadius * Radius: Number("double"), * }, * }, * }, * }, * LineLayer: { // GeospatialLineLayer * Style: { // GeospatialLineStyle * LineSymbolStyle: { // GeospatialLineSymbolStyle * FillColor: { * Solid: { * Color: "STRING_VALUE", // required * State: "ENABLED" || "DISABLED", * }, * Gradient: { * StepColors: [ // required * { * Color: "STRING_VALUE", // required * DataValue: Number("double"), // required * }, * ], * NullDataVisibility: "HIDDEN" || "VISIBLE", * NullDataSettings: { * SymbolStyle: { * FillColor: "STRING_VALUE", * StrokeColor: "STRING_VALUE", * StrokeWidth: Number("double"), * }, * }, * DefaultOpacity: Number("double"), * }, * Categorical: { * CategoryDataColors: [ // required * { * Color: "STRING_VALUE", // required * DataValue: "STRING_VALUE", // required * }, * ], * NullDataVisibility: "HIDDEN" || "VISIBLE", * NullDataSettings: "", * DefaultOpacity: Number("double"), * }, * }, * LineWidth: { * LineWidth: Number("double"), * }, * }, * }, * }, * PolygonLayer: { // GeospatialPolygonLayer * Style: { // GeospatialPolygonStyle * PolygonSymbolStyle: { // GeospatialPolygonSymbolStyle * FillColor: { * Solid: { * Color: "STRING_VALUE", // required * State: "ENABLED" || "DISABLED", * }, * Gradient: { * StepColors: [ // required * { * Color: "STRING_VALUE", // required * DataValue: Number("double"), // required * }, * ], * NullDataVisibility: "HIDDEN" || "VISIBLE", * NullDataSettings: "", * DefaultOpacity: Number("double"), * }, * Categorical: { * CategoryDataColors: [ // required * { * Color: "STRING_VALUE", // required * DataValue: "STRING_VALUE", // required * }, * ], * NullDataVisibility: "HIDDEN" || "VISIBLE", * NullDataSettings: "", * DefaultOpacity: Number("double"), * }, * }, * StrokeColor: { * Solid: { * Color: "STRING_VALUE", // required * State: "ENABLED" || "DISABLED", * }, * Gradient: { * StepColors: [ // required * { * Color: "STRING_VALUE", // required * DataValue: Number("double"), // required * }, * ], * NullDataVisibility: "HIDDEN" || "VISIBLE", * NullDataSettings: "", * DefaultOpacity: Number("double"), * }, * Categorical: { * CategoryDataColors: [ // required * { * Color: "STRING_VALUE", // required * DataValue: "STRING_VALUE", // required * }, * ], * NullDataVisibility: "HIDDEN" || "VISIBLE", * NullDataSettings: "", * DefaultOpacity: Number("double"), * }, * }, * StrokeWidth: { * LineWidth: Number("double"), * }, * }, * }, * }, * }, * Tooltip: "", * JoinDefinition: { // GeospatialLayerJoinDefinition * ShapeKeyField: "STRING_VALUE", * DatasetKeyField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * FormatConfiguration: { * StringFormatConfiguration: "", * NumberFormatConfiguration: "", * DateTimeFormatConfiguration: "", * }, * }, * ColorField: { // GeospatialLayerColorField * ColorDimensionsFields: [ // GeospatialLayerDimensionFieldList * "", * ], * ColorValuesFields: [ // GeospatialLayerMeasureFieldList * "", * ], * }, * }, * Actions: [ // LayerCustomActionList * { // LayerCustomAction * CustomActionId: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * Status: "ENABLED" || "DISABLED", * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required * ActionOperations: [ // LayerCustomActionOperationList // required * { // LayerCustomActionOperation * FilterOperation: "", * NavigationOperation: "", * URLOperation: "", * SetParametersOperation: "", * }, * ], * }, * ], * }, * ], * MapState: { // GeospatialMapState * Bounds: { * North: Number("double"), // required * South: Number("double"), // required * West: Number("double"), // required * East: Number("double"), // required * }, * MapNavigation: "ENABLED" || "DISABLED", * }, * MapStyle: { // GeospatialMapStyle * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", * BackgroundColor: "STRING_VALUE", * BaseMapVisibility: "HIDDEN" || "VISIBLE", * }, * Interactions: "", * }, * DataSetIdentifier: "STRING_VALUE", // required * VisualContentAltText: "STRING_VALUE", * }, * FunnelChartVisual: { // FunnelChartVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // FunnelChartConfiguration * FieldWells: { // FunnelChartFieldWells * FunnelChartAggregatedFieldWells: { // FunnelChartAggregatedFieldWells * Category: [ // FunnelChartDimensionFieldList * "", * ], * Values: [ // FunnelChartMeasureFieldList * "", * ], * }, * }, * SortConfiguration: { // FunnelChartSortConfiguration * CategorySort: "", * CategoryItemsLimit: "", * }, * CategoryLabelOptions: "", * ValueLabelOptions: "", * Tooltip: "", * DataLabelOptions: { // FunnelChartDataLabelOptions * Visibility: "HIDDEN" || "VISIBLE", * CategoryLabelVisibility: "HIDDEN" || "VISIBLE", * MeasureLabelVisibility: "HIDDEN" || "VISIBLE", * Position: "INSIDE" || "OUTSIDE" || "LEFT" || "TOP" || "BOTTOM" || "RIGHT", * LabelFontConfiguration: "", * LabelColor: "STRING_VALUE", * MeasureDataLabelStyle: "VALUE_ONLY" || "PERCENTAGE_BY_FIRST_STAGE" || "PERCENTAGE_BY_PREVIOUS_STAGE" || "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE" || "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE", * }, * VisualPalette: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * ScatterPlotVisual: { // ScatterPlotVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // ScatterPlotConfiguration * FieldWells: { // ScatterPlotFieldWells * ScatterPlotCategoricallyAggregatedFieldWells: { // ScatterPlotCategoricallyAggregatedFieldWells * XAxis: "", * YAxis: "", * Category: "", * Size: "", * Label: "", * }, * ScatterPlotUnaggregatedFieldWells: { // ScatterPlotUnaggregatedFieldWells * XAxis: "", * YAxis: "", * Size: "", * Category: "", * Label: "", * }, * }, * SortConfiguration: { // ScatterPlotSortConfiguration * ScatterPlotLimitConfiguration: "", * }, * XAxisLabelOptions: "", * XAxisDisplayOptions: "", * YAxisLabelOptions: "", * YAxisDisplayOptions: "", * Legend: "", * DataLabels: "", * Tooltip: "", * VisualPalette: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * ComboChartVisual: { // ComboChartVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // ComboChartConfiguration * FieldWells: { // ComboChartFieldWells * ComboChartAggregatedFieldWells: { // ComboChartAggregatedFieldWells * Category: "", * BarValues: "", * Colors: "", * LineValues: "", * }, * }, * SortConfiguration: { // ComboChartSortConfiguration * CategorySort: "", * CategoryItemsLimit: "", * ColorSort: "", * ColorItemsLimit: "", * }, * BarsArrangement: "CLUSTERED" || "STACKED" || "STACKED_PERCENT", * CategoryAxis: "", * CategoryLabelOptions: "", * PrimaryYAxisDisplayOptions: "", * PrimaryYAxisLabelOptions: "", * SecondaryYAxisDisplayOptions: "", * SecondaryYAxisLabelOptions: "", * SingleAxisOptions: { * YAxisOptions: { * YAxis: "PRIMARY_Y_AXIS", // required * }, * }, * ColorLabelOptions: "", * DefaultSeriesSettings: { // ComboChartDefaultSeriesSettings * LineStyleSettings: { * LineVisibility: "HIDDEN" || "VISIBLE", * LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED", * LineStyle: "SOLID" || "DOTTED" || "DASHED", * LineWidth: "STRING_VALUE", * }, * MarkerStyleSettings: "", * DecalSettings: "", * BorderSettings: { * BorderVisibility: "HIDDEN" || "VISIBLE", * BorderWidth: "STRING_VALUE", * BorderColor: "STRING_VALUE", * }, * }, * Series: [ // ComboSeriesItemList * { // ComboSeriesItem * FieldComboSeriesItem: { // FieldComboSeriesItem * FieldId: "STRING_VALUE", // required * Settings: { // ComboChartSeriesSettings * LineStyleSettings: { * LineVisibility: "HIDDEN" || "VISIBLE", * LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED", * LineStyle: "SOLID" || "DOTTED" || "DASHED", * LineWidth: "STRING_VALUE", * }, * MarkerStyleSettings: "", * DecalSettings: "", * BorderSettings: { * BorderVisibility: "HIDDEN" || "VISIBLE", * BorderWidth: "STRING_VALUE", * BorderColor: "STRING_VALUE", * }, * }, * }, * DataFieldComboSeriesItem: { // DataFieldComboSeriesItem * FieldId: "STRING_VALUE", // required * FieldValue: "STRING_VALUE", * Settings: { * LineStyleSettings: "", * MarkerStyleSettings: "", * DecalSettings: "", * BorderSettings: "", * }, * }, * }, * ], * Legend: "", * BarDataLabels: "", * LineDataLabels: "", * Tooltip: "", * ReferenceLines: [ * { * Status: "ENABLED" || "DISABLED", * DataConfiguration: { * StaticConfiguration: { * Value: Number("double"), // required * }, * DynamicConfiguration: { * Column: "", // required * MeasureAggregationFunction: "", * Calculation: "", // required * }, * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", * SeriesType: "BAR" || "LINE", * }, * StyleConfiguration: { * Pattern: "SOLID" || "DASHED" || "DOTTED", * Color: "STRING_VALUE", * }, * LabelConfiguration: { * ValueLabelConfiguration: { * RelativePosition: "BEFORE_CUSTOM_LABEL" || "AFTER_CUSTOM_LABEL", * FormatConfiguration: "", * }, * CustomLabelConfiguration: { * CustomLabel: "STRING_VALUE", // required * }, * FontConfiguration: "", * FontColor: "STRING_VALUE", * HorizontalPosition: "LEFT" || "CENTER" || "RIGHT", * VerticalPosition: "ABOVE" || "BELOW", * }, * }, * ], * VisualPalette: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * BoxPlotVisual: { // BoxPlotVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // BoxPlotChartConfiguration * FieldWells: { // BoxPlotFieldWells * BoxPlotAggregatedFieldWells: { // BoxPlotAggregatedFieldWells * GroupBy: [ // BoxPlotDimensionFieldList * "", * ], * Values: [ // BoxPlotMeasureFieldList * "", * ], * }, * }, * SortConfiguration: { // BoxPlotSortConfiguration * CategorySort: "", * PaginationConfiguration: { * PageSize: Number("long"), // required * PageNumber: Number("long"), // required * }, * }, * BoxPlotOptions: { // BoxPlotOptions * StyleOptions: { // BoxPlotStyleOptions * FillStyle: "SOLID" || "TRANSPARENT", * }, * OutlierVisibility: "HIDDEN" || "VISIBLE", * AllDataPointsVisibility: "HIDDEN" || "VISIBLE", * }, * CategoryAxis: "", * CategoryLabelOptions: "", * PrimaryYAxisDisplayOptions: "", * PrimaryYAxisLabelOptions: "", * Legend: "", * Tooltip: "", * ReferenceLines: [ * { * Status: "ENABLED" || "DISABLED", * DataConfiguration: { * StaticConfiguration: { * Value: Number("double"), // required * }, * DynamicConfiguration: { * Column: "", // required * MeasureAggregationFunction: "", * Calculation: "", // required * }, * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", * SeriesType: "BAR" || "LINE", * }, * StyleConfiguration: { * Pattern: "SOLID" || "DASHED" || "DOTTED", * Color: "STRING_VALUE", * }, * LabelConfiguration: { * ValueLabelConfiguration: { * RelativePosition: "BEFORE_CUSTOM_LABEL" || "AFTER_CUSTOM_LABEL", * FormatConfiguration: "", * }, * CustomLabelConfiguration: { * CustomLabel: "STRING_VALUE", // required * }, * FontConfiguration: "", * FontColor: "STRING_VALUE", * HorizontalPosition: "LEFT" || "CENTER" || "RIGHT", * VerticalPosition: "ABOVE" || "BELOW", * }, * }, * ], * VisualPalette: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * WaterfallVisual: { // WaterfallVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // WaterfallChartConfiguration * FieldWells: { // WaterfallChartFieldWells * WaterfallChartAggregatedFieldWells: { // WaterfallChartAggregatedFieldWells * Categories: "", * Values: "", * Breakdowns: "", * }, * }, * SortConfiguration: { // WaterfallChartSortConfiguration * CategorySort: "", * BreakdownItemsLimit: "", * }, * WaterfallChartOptions: { // WaterfallChartOptions * TotalBarLabel: "STRING_VALUE", * }, * CategoryAxisLabelOptions: "", * CategoryAxisDisplayOptions: "", * PrimaryYAxisLabelOptions: "", * PrimaryYAxisDisplayOptions: "", * Legend: "", * DataLabels: "", * VisualPalette: "", * ColorConfiguration: { // WaterfallChartColorConfiguration * GroupColorConfiguration: { // WaterfallChartGroupColorConfiguration * PositiveBarColor: "STRING_VALUE", * NegativeBarColor: "STRING_VALUE", * TotalBarColor: "STRING_VALUE", * }, * }, * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * HistogramVisual: { // HistogramVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // HistogramConfiguration * FieldWells: { // HistogramFieldWells * HistogramAggregatedFieldWells: { // HistogramAggregatedFieldWells * Values: [ // HistogramMeasureFieldList * "", * ], * }, * }, * XAxisDisplayOptions: "", * XAxisLabelOptions: "", * YAxisDisplayOptions: "", * BinOptions: { // HistogramBinOptions * SelectedBinType: "BIN_COUNT" || "BIN_WIDTH", * BinCount: { // BinCountOptions * Value: Number("int"), * }, * BinWidth: { // BinWidthOptions * Value: Number("double"), * BinCountLimit: Number("long"), * }, * StartValue: Number("double"), * }, * DataLabels: "", * Tooltip: "", * VisualPalette: "", * Interactions: "", * }, * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * WordCloudVisual: { // WordCloudVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // WordCloudChartConfiguration * FieldWells: { // WordCloudFieldWells * WordCloudAggregatedFieldWells: { // WordCloudAggregatedFieldWells * GroupBy: [ // WordCloudDimensionFieldList * "", * ], * Size: [ // WordCloudMeasureFieldList * "", * ], * }, * }, * SortConfiguration: { // WordCloudSortConfiguration * CategoryItemsLimit: "", * CategorySort: "", * }, * CategoryLabelOptions: "", * WordCloudOptions: { // WordCloudOptions * WordOrientation: "HORIZONTAL" || "HORIZONTAL_AND_VERTICAL", * WordScaling: "EMPHASIZE" || "NORMAL", * CloudLayout: "FLUID" || "NORMAL", * WordCasing: "LOWER_CASE" || "EXISTING_CASE", * WordPadding: "NONE" || "SMALL" || "MEDIUM" || "LARGE", * MaximumStringLength: Number("int"), * }, * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * InsightVisual: { // InsightVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * InsightConfiguration: { // InsightConfiguration * Computations: [ // ComputationList * { // Computation * TopBottomRanked: { // TopBottomRankedComputation * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Category: "", * Value: "", * ResultSize: Number("int"), * Type: "TOP" || "BOTTOM", // required * }, * TopBottomMovers: { // TopBottomMoversComputation * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Category: "", * Value: "", * MoverSize: Number("int"), * SortOrder: "PERCENT_DIFFERENCE" || "ABSOLUTE_DIFFERENCE", * Type: "TOP" || "BOTTOM", // required * }, * TotalAggregation: { // TotalAggregationComputation * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Value: "", * }, * MaximumMinimum: { // MaximumMinimumComputation * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Value: "", * Type: "MAXIMUM" || "MINIMUM", // required * }, * MetricComparison: { // MetricComparisonComputation * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * FromValue: "", * TargetValue: "", * }, * PeriodOverPeriod: { // PeriodOverPeriodComputation * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Value: "", * }, * PeriodToDate: { // PeriodToDateComputation * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Value: "", * PeriodTimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * }, * GrowthRate: { // GrowthRateComputation * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Value: "", * PeriodSize: Number("int"), * }, * UniqueValues: { // UniqueValuesComputation * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Category: "", * }, * Forecast: { // ForecastComputation * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Value: "", * PeriodsForward: Number("int"), * PeriodsBackward: Number("int"), * UpperBoundary: Number("double"), * LowerBoundary: Number("double"), * PredictionInterval: Number("int"), * Seasonality: "AUTOMATIC" || "CUSTOM", * CustomSeasonalityValue: Number("int"), * }, * }, * ], * CustomNarrative: { // CustomNarrativeOptions * Narrative: "STRING_VALUE", // required * }, * Interactions: "", * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required * VisualContentAltText: "STRING_VALUE", * }, * SankeyDiagramVisual: { // SankeyDiagramVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // SankeyDiagramChartConfiguration * FieldWells: { // SankeyDiagramFieldWells * SankeyDiagramAggregatedFieldWells: { // SankeyDiagramAggregatedFieldWells * Source: "", * Destination: "", * Weight: "", * }, * }, * SortConfiguration: { // SankeyDiagramSortConfiguration * WeightSort: "", * SourceItemsLimit: "", * DestinationItemsLimit: "", * }, * DataLabels: "", * Interactions: "", * }, * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * CustomContentVisual: { // CustomContentVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // CustomContentConfiguration * ContentUrl: "STRING_VALUE", * ContentType: "IMAGE" || "OTHER_EMBEDDED_CONTENT", * ImageScaling: "FIT_TO_HEIGHT" || "FIT_TO_WIDTH" || "DO_NOT_SCALE" || "SCALE_TO_VISUAL", * Interactions: "", * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required * VisualContentAltText: "STRING_VALUE", * }, * EmptyVisual: { // EmptyVisual * VisualId: "STRING_VALUE", // required * DataSetIdentifier: "STRING_VALUE", // required * Actions: "", * }, * RadarChartVisual: { // RadarChartVisual * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // RadarChartConfiguration * FieldWells: { // RadarChartFieldWells * RadarChartAggregatedFieldWells: { // RadarChartAggregatedFieldWells * Category: [ // RadarChartCategoryFieldList * "", * ], * Color: [ // RadarChartColorFieldList * "", * ], * Values: [ // RadarChartValuesFieldList * "", * ], * }, * }, * SortConfiguration: { // RadarChartSortConfiguration * CategorySort: "", * CategoryItemsLimit: "", * ColorSort: "", * ColorItemsLimit: "", * }, * Shape: "CIRCLE" || "POLYGON", * BaseSeriesSettings: { // RadarChartSeriesSettings * AreaStyleSettings: { // RadarChartAreaStyleSettings * Visibility: "HIDDEN" || "VISIBLE", * }, * }, * StartAngle: Number("double"), * VisualPalette: "", * AlternateBandColorsVisibility: "HIDDEN" || "VISIBLE", * AlternateBandEvenColor: "STRING_VALUE", * AlternateBandOddColor: "STRING_VALUE", * CategoryAxis: "", * CategoryLabelOptions: "", * ColorAxis: "", * ColorLabelOptions: "", * Legend: "", * AxesRangeScale: "AUTO" || "INDEPENDENT" || "SHARED", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * PluginVisual: { // PluginVisual * VisualId: "STRING_VALUE", // required * PluginArn: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { // PluginVisualConfiguration * FieldWells: [ // PluginVisualFieldWells * { // PluginVisualFieldWell * AxisName: "GROUP_BY" || "VALUE", * Dimensions: "", * Measures: "", * Unaggregated: [ // UnaggregatedFieldList * { * FieldId: "STRING_VALUE", // required * Column: "", // required * FormatConfiguration: { * StringFormatConfiguration: "", * NumberFormatConfiguration: "", * DateTimeFormatConfiguration: "", * }, * }, * ], * }, * ], * VisualOptions: { // PluginVisualOptions * VisualProperties: [ // PluginVisualPropertiesList * { // PluginVisualProperty * Name: "STRING_VALUE", * Value: "STRING_VALUE", * }, * ], * }, * SortConfiguration: { // PluginVisualSortConfiguration * PluginVisualTableQuerySort: { // PluginVisualTableQuerySort * RowSort: [ * "", * ], * ItemsLimitConfiguration: { // PluginVisualItemsLimitConfiguration * ItemsLimit: Number("long"), * }, * }, * }, * }, * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * }, * ], * TextBoxes: [ // SheetTextBoxList * { // SheetTextBox * SheetTextBoxId: "STRING_VALUE", // required * Content: "STRING_VALUE", * Interactions: { // TextBoxInteractionOptions * TextBoxMenuOption: { // TextBoxMenuOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * }, * ], * Images: [ // SheetImageList * { // SheetImage * SheetImageId: "STRING_VALUE", // required * Source: { // SheetImageSource * SheetImageStaticFileSource: { // SheetImageStaticFileSource * StaticFileId: "STRING_VALUE", // required * }, * }, * Scaling: { // SheetImageScalingConfiguration * ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", * }, * Tooltip: { // SheetImageTooltipConfiguration * TooltipText: { // SheetImageTooltipText * PlainText: "STRING_VALUE", * }, * Visibility: "HIDDEN" || "VISIBLE", * }, * ImageContentAltText: "STRING_VALUE", * Interactions: { // ImageInteractionOptions * ImageMenuOption: { // ImageMenuOption * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * Actions: [ // ImageCustomActionList * { // ImageCustomAction * CustomActionId: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * Status: "ENABLED" || "DISABLED", * Trigger: "CLICK" || "MENU", // required * ActionOperations: [ // ImageCustomActionOperationList // required * { // ImageCustomActionOperation * NavigationOperation: "", * URLOperation: "", * SetParametersOperation: "", * }, * ], * }, * ], * }, * ], * Layouts: [ // LayoutList * { // Layout * Configuration: { // LayoutConfiguration * GridLayout: { // GridLayoutConfiguration * Elements: [ // GridLayoutElementList // required * { // GridLayoutElement * ElementId: "STRING_VALUE", // required * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), * RowSpan: Number("int"), // required * BorderStyle: { // GridLayoutElementBorderStyle * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * Width: "STRING_VALUE", * }, * SelectedBorderStyle: { * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * Width: "STRING_VALUE", * }, * BackgroundStyle: { // GridLayoutElementBackgroundStyle * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * }, * LoadingAnimation: { // LoadingAnimation * Visibility: "HIDDEN" || "VISIBLE", * }, * BorderRadius: "STRING_VALUE", * Padding: "STRING_VALUE", * }, * ], * CanvasSizeOptions: { // GridLayoutCanvasSizeOptions * ScreenCanvasSizeOptions: { // GridLayoutScreenCanvasSizeOptions * ResizeOption: "FIXED" || "RESPONSIVE", // required * OptimizedViewPortWidth: "STRING_VALUE", * }, * }, * }, * FreeFormLayout: { // FreeFormLayoutConfiguration * Elements: [ // FreeFromLayoutElementList // required * { // FreeFormLayoutElement * ElementId: "STRING_VALUE", // required * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required * Height: "STRING_VALUE", // required * Visibility: "HIDDEN" || "VISIBLE", * RenderingRules: [ // SheetElementRenderingRuleList * { // SheetElementRenderingRule * Expression: "STRING_VALUE", // required * ConfigurationOverrides: { // SheetElementConfigurationOverrides * Visibility: "HIDDEN" || "VISIBLE", * }, * }, * ], * BorderStyle: { // FreeFormLayoutElementBorderStyle * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * Width: "STRING_VALUE", * }, * SelectedBorderStyle: { * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * Width: "STRING_VALUE", * }, * BackgroundStyle: { // FreeFormLayoutElementBackgroundStyle * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * }, * LoadingAnimation: { * Visibility: "HIDDEN" || "VISIBLE", * }, * BorderRadius: "STRING_VALUE", * Padding: "STRING_VALUE", * }, * ], * CanvasSizeOptions: { // FreeFormLayoutCanvasSizeOptions * ScreenCanvasSizeOptions: { // FreeFormLayoutScreenCanvasSizeOptions * OptimizedViewPortWidth: "STRING_VALUE", // required * }, * }, * Groups: [ // SheetLayoutGroupList * { // SheetLayoutGroup * Id: "STRING_VALUE", // required * Members: [ // SheetLayoutGroupMemberList // required * { // SheetLayoutGroupMember * Id: "STRING_VALUE", // required * Type: "ELEMENT" || "GROUP", // required * }, * ], * }, * ], * }, * SectionBasedLayout: { // SectionBasedLayoutConfiguration * HeaderSections: [ // HeaderFooterSectionConfigurationList // required * { // HeaderFooterSectionConfiguration * SectionId: "STRING_VALUE", // required * Layout: { // SectionLayoutConfiguration * FreeFormLayout: { // FreeFormSectionLayoutConfiguration * Elements: [ // required * { * ElementId: "STRING_VALUE", // required * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * XAxisLocation: "STRING_VALUE", // required * YAxisLocation: "STRING_VALUE", // required * Width: "STRING_VALUE", // required * Height: "STRING_VALUE", // required * Visibility: "HIDDEN" || "VISIBLE", * RenderingRules: [ * { * Expression: "STRING_VALUE", // required * ConfigurationOverrides: { * Visibility: "HIDDEN" || "VISIBLE", * }, * }, * ], * BorderStyle: { * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * Width: "STRING_VALUE", * }, * SelectedBorderStyle: { * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * Width: "STRING_VALUE", * }, * BackgroundStyle: { * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * }, * LoadingAnimation: { * Visibility: "HIDDEN" || "VISIBLE", * }, * BorderRadius: "STRING_VALUE", * Padding: "STRING_VALUE", * }, * ], * }, * }, * Style: { // SectionStyle * Height: "STRING_VALUE", * Padding: { // Spacing * Top: "STRING_VALUE", * Bottom: "STRING_VALUE", * Left: "STRING_VALUE", * Right: "STRING_VALUE", * }, * }, * }, * ], * BodySections: [ // BodySectionConfigurationList // required * { // BodySectionConfiguration * SectionId: "STRING_VALUE", // required * Content: { // BodySectionContent * Layout: { * FreeFormLayout: { * Elements: "", // required * }, * }, * }, * Style: { * Height: "STRING_VALUE", * Padding: { * Top: "STRING_VALUE", * Bottom: "STRING_VALUE", * Left: "STRING_VALUE", * Right: "STRING_VALUE", * }, * }, * PageBreakConfiguration: { // SectionPageBreakConfiguration * After: { // SectionAfterPageBreak * Status: "ENABLED" || "DISABLED", * }, * }, * RepeatConfiguration: { // BodySectionRepeatConfiguration * DimensionConfigurations: [ // BodySectionRepeatDimensionConfigurationList * { // BodySectionRepeatDimensionConfiguration * DynamicCategoryDimensionConfiguration: { // BodySectionDynamicCategoryDimensionConfiguration * Column: "", // required * Limit: Number("int"), * SortByMetrics: [ // BodySectionDynamicDimensionSortConfigurationList * "", * ], * }, * DynamicNumericDimensionConfiguration: { // BodySectionDynamicNumericDimensionConfiguration * Column: "", // required * Limit: Number("int"), * SortByMetrics: [ * "", * ], * }, * }, * ], * PageBreakConfiguration: { // BodySectionRepeatPageBreakConfiguration * After: { * Status: "ENABLED" || "DISABLED", * }, * }, * NonRepeatingVisuals: [ // NonRepeatingVisualsList * "STRING_VALUE", * ], * }, * }, * ], * FooterSections: [ // required * { * SectionId: "STRING_VALUE", // required * Layout: { * FreeFormLayout: { * Elements: "", // required * }, * }, * Style: { * Height: "STRING_VALUE", * Padding: { * Top: "STRING_VALUE", * Bottom: "STRING_VALUE", * Left: "STRING_VALUE", * Right: "STRING_VALUE", * }, * }, * }, * ], * CanvasSizeOptions: { // SectionBasedLayoutCanvasSizeOptions * PaperCanvasSizeOptions: { // SectionBasedLayoutPaperCanvasSizeOptions * PaperSize: "US_LETTER" || "US_LEGAL" || "US_TABLOID_LEDGER" || "A0" || "A1" || "A2" || "A3" || "A4" || "A5" || "JIS_B4" || "JIS_B5", * PaperOrientation: "PORTRAIT" || "LANDSCAPE", * PaperMargin: { * Top: "STRING_VALUE", * Bottom: "STRING_VALUE", * Left: "STRING_VALUE", * Right: "STRING_VALUE", * }, * }, * }, * }, * }, * }, * ], * SheetControlLayouts: [ // SheetControlLayoutList * { // SheetControlLayout * Configuration: { // SheetControlLayoutConfiguration * GridLayout: { * Elements: [ // required * { * ElementId: "STRING_VALUE", // required * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), * RowSpan: Number("int"), // required * BorderStyle: { * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * Width: "STRING_VALUE", * }, * SelectedBorderStyle: { * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * Width: "STRING_VALUE", * }, * BackgroundStyle: { * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * }, * LoadingAnimation: { * Visibility: "HIDDEN" || "VISIBLE", * }, * BorderRadius: "STRING_VALUE", * Padding: "STRING_VALUE", * }, * ], * CanvasSizeOptions: { * ScreenCanvasSizeOptions: { * ResizeOption: "FIXED" || "RESPONSIVE", // required * OptimizedViewPortWidth: "STRING_VALUE", * }, * }, * }, * }, * }, * ], * ContentType: "PAGINATED" || "INTERACTIVE", * CustomActionDefaults: { // VisualCustomActionDefaults * highlightOperation: { // VisualHighlightOperation * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required * }, * }, * }, * ], * TooltipSheets: [ // TooltipSheetDefinitionList * { // TooltipSheetDefinition * SheetId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Visuals: [ // TooltipSheetVisualList * { * TableVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * TableAggregatedFieldWells: { * GroupBy: "", * Values: "", * }, * TableUnaggregatedFieldWells: { * Values: [ * { * FieldId: "STRING_VALUE", // required * Column: "", // required * FormatConfiguration: { * StringFormatConfiguration: "", * NumberFormatConfiguration: "", * DateTimeFormatConfiguration: "", * }, * }, * ], * }, * }, * SortConfiguration: { * RowSort: [ * "", * ], * PaginationConfiguration: { * PageSize: Number("long"), // required * PageNumber: Number("long"), // required * }, * }, * TableOptions: { * Orientation: "VERTICAL" || "HORIZONTAL", * HeaderStyle: "", * CellStyle: "", * RowAlternateColorOptions: { * Status: "ENABLED" || "DISABLED", * RowAlternateColors: [ * "STRING_VALUE", * ], * UsePrimaryBackgroundColor: "ENABLED" || "DISABLED", * }, * }, * TotalOptions: { * TotalsVisibility: "HIDDEN" || "VISIBLE", * Placement: "START" || "END" || "AUTO", * ScrollStatus: "PINNED" || "SCROLLED", * CustomLabel: "STRING_VALUE", * TotalCellStyle: "", * TotalAggregationOptions: [ * { * FieldId: "STRING_VALUE", // required * TotalAggregationFunction: { * SimpleTotalAggregationFunction: "DEFAULT" || "SUM" || "AVERAGE" || "MIN" || "MAX" || "NONE", * }, * }, * ], * }, * FieldOptions: { * SelectedFieldOptions: [ * { * FieldId: "STRING_VALUE", // required * Width: "STRING_VALUE", * CustomLabel: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * URLStyling: { * LinkConfiguration: { * Target: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required * Content: { * CustomTextContent: { * Value: "STRING_VALUE", * FontConfiguration: "", // required * }, * CustomIconContent: { * Icon: "LINK", * }, * }, * }, * ImageConfiguration: { * SizingOptions: { * TableCellImageScalingConfiguration: "FIT_TO_CELL_HEIGHT" || "FIT_TO_CELL_WIDTH" || "DO_NOT_SCALE", * }, * }, * }, * }, * ], * Order: [ * "STRING_VALUE", * ], * PinnedFieldOptions: { * PinnedLeftFields: [ * "STRING_VALUE", * ], * }, * TransposedTableOptions: [ * { * ColumnIndex: Number("int"), * ColumnWidth: "STRING_VALUE", * ColumnType: "ROW_HEADER_COLUMN" || "VALUE_COLUMN", // required * }, * ], * }, * PaginatedReportOptions: { * VerticalOverflowVisibility: "HIDDEN" || "VISIBLE", * OverflowColumnHeaderVisibility: "HIDDEN" || "VISIBLE", * }, * TableInlineVisualizations: [ * { * DataBars: { * FieldId: "STRING_VALUE", // required * PositiveColor: "STRING_VALUE", * NegativeColor: "STRING_VALUE", * }, * Sparklines: { * FieldId: "STRING_VALUE", // required * XAxisField: "", // required * YAxisBehavior: "SHARED" || "INDEPENDENT", * VisualType: "LINE" || "AREA_LINE", * LineColor: "STRING_VALUE", * LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED", * AllPointsMarker: "", * MaxValueMarker: "", * MinValueMarker: "", * }, * }, * ], * Tooltip: "", * DashboardCustomizationVisualOptions: { * FieldsConfiguration: { * Status: "ENABLED" || "DISABLED", * AdditionalFields: [ * "", * ], * }, * }, * Interactions: "", * }, * ConditionalFormatting: { * ConditionalFormattingOptions: [ * { * Cell: { * FieldId: "STRING_VALUE", // required * TextFormat: { * BackgroundColor: "", * TextColor: "", * Icon: "", * }, * }, * Row: { * BackgroundColor: "", * TextColor: "", * }, * }, * ], * }, * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * PivotTableVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * PivotTableAggregatedFieldWells: { * Rows: [ * "", * ], * Columns: [ * "", * ], * Values: [ * "", * ], * }, * }, * SortConfiguration: { * FieldSortOptions: [ * { * FieldId: "STRING_VALUE", // required * SortBy: { * Field: "", * Column: "", * DataPath: { * Direction: "ASC" || "DESC", // required * SortPaths: "", // required * }, * }, * }, * ], * }, * TableOptions: { * MetricPlacement: "ROW" || "COLUMN", * SingleMetricVisibility: "HIDDEN" || "VISIBLE", * ColumnNamesVisibility: "HIDDEN" || "VISIBLE", * ToggleButtonsVisibility: "HIDDEN" || "VISIBLE", * ColumnHeaderStyle: "", * RowHeaderStyle: "", * CellStyle: "", * RowFieldNamesStyle: "", * RowAlternateColorOptions: { * Status: "ENABLED" || "DISABLED", * RowAlternateColors: [ * "STRING_VALUE", * ], * UsePrimaryBackgroundColor: "ENABLED" || "DISABLED", * }, * CollapsedRowDimensionsVisibility: "HIDDEN" || "VISIBLE", * RowsLayout: "TABULAR" || "HIERARCHY", * RowsLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", * CustomLabel: "STRING_VALUE", * }, * DefaultCellWidth: "STRING_VALUE", * }, * TotalOptions: { * RowSubtotalOptions: { * TotalsVisibility: "HIDDEN" || "VISIBLE", * CustomLabel: "STRING_VALUE", * FieldLevel: "ALL" || "CUSTOM" || "LAST", * FieldLevelOptions: [ * { * FieldId: "STRING_VALUE", * }, * ], * TotalCellStyle: "", * ValueCellStyle: "", * MetricHeaderCellStyle: "", * StyleTargets: [ * { * CellType: "TOTAL" || "METRIC_HEADER" || "VALUE", // required * }, * ], * }, * ColumnSubtotalOptions: { * TotalsVisibility: "HIDDEN" || "VISIBLE", * CustomLabel: "STRING_VALUE", * FieldLevel: "ALL" || "CUSTOM" || "LAST", * FieldLevelOptions: [ * { * FieldId: "STRING_VALUE", * }, * ], * TotalCellStyle: "", * ValueCellStyle: "", * MetricHeaderCellStyle: "", * StyleTargets: [ * { * CellType: "TOTAL" || "METRIC_HEADER" || "VALUE", // required * }, * ], * }, * RowTotalOptions: { * TotalsVisibility: "HIDDEN" || "VISIBLE", * Placement: "START" || "END" || "AUTO", * ScrollStatus: "PINNED" || "SCROLLED", * CustomLabel: "STRING_VALUE", * TotalCellStyle: "", * ValueCellStyle: "", * MetricHeaderCellStyle: "", * TotalAggregationOptions: [ * { * FieldId: "STRING_VALUE", // required * TotalAggregationFunction: { * SimpleTotalAggregationFunction: "DEFAULT" || "SUM" || "AVERAGE" || "MIN" || "MAX" || "NONE", * }, * }, * ], * }, * ColumnTotalOptions: { * TotalsVisibility: "HIDDEN" || "VISIBLE", * Placement: "START" || "END" || "AUTO", * ScrollStatus: "PINNED" || "SCROLLED", * CustomLabel: "STRING_VALUE", * TotalCellStyle: "", * ValueCellStyle: "", * MetricHeaderCellStyle: "", * TotalAggregationOptions: "", * }, * }, * FieldOptions: { * SelectedFieldOptions: [ * { * FieldId: "STRING_VALUE", // required * CustomLabel: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * }, * ], * DataPathOptions: [ * { * DataPathList: "", // required * Width: "STRING_VALUE", * }, * ], * CollapseStateOptions: [ * { * Target: { * FieldId: "STRING_VALUE", * FieldDataPathValues: "", * }, * State: "COLLAPSED" || "EXPANDED", * }, * ], * }, * PaginatedReportOptions: { * VerticalOverflowVisibility: "HIDDEN" || "VISIBLE", * OverflowColumnHeaderVisibility: "HIDDEN" || "VISIBLE", * }, * Tooltip: "", * DashboardCustomizationVisualOptions: { * FieldsConfiguration: { * Status: "ENABLED" || "DISABLED", * AdditionalFields: [ * "", * ], * }, * }, * Interactions: "", * }, * ConditionalFormatting: { * ConditionalFormattingOptions: [ * { * Cell: { * FieldId: "STRING_VALUE", // required * TextFormat: { * BackgroundColor: "", * TextColor: "", * Icon: "", * }, * Scope: { * Role: "FIELD" || "FIELD_TOTAL" || "GRAND_TOTAL", * }, * Scopes: [ * { * Role: "FIELD" || "FIELD_TOTAL" || "GRAND_TOTAL", * }, * ], * }, * }, * ], * }, * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * BarChartVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * BarChartAggregatedFieldWells: { * Category: "", * Values: "", * Colors: "", * SmallMultiples: [ * "", * ], * }, * }, * SortConfiguration: { * CategorySort: "", * CategoryItemsLimit: "", * ColorSort: "", * ColorItemsLimit: "", * SmallMultiplesSort: "", * SmallMultiplesLimitConfiguration: "", * }, * Orientation: "HORIZONTAL" || "VERTICAL", * BarsArrangement: "CLUSTERED" || "STACKED" || "STACKED_PERCENT", * VisualPalette: "", * SmallMultiplesOptions: { * MaxVisibleRows: Number("long"), * MaxVisibleColumns: Number("long"), * PanelConfiguration: { * Title: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: "", * HorizontalTextAlignment: "LEFT" || "CENTER" || "RIGHT" || "AUTO", * }, * BorderVisibility: "HIDDEN" || "VISIBLE", * BorderThickness: "STRING_VALUE", * BorderStyle: "SOLID" || "DASHED" || "DOTTED", * BorderColor: "STRING_VALUE", * GutterVisibility: "HIDDEN" || "VISIBLE", * GutterSpacing: "STRING_VALUE", * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, * XAxis: "", * YAxis: "", * }, * CategoryAxis: "", * CategoryLabelOptions: "", * ValueAxis: "", * ValueLabelOptions: "", * ColorLabelOptions: "", * DefaultSeriesSettings: { * DecalSettings: "", * BorderSettings: "", * }, * Series: [ * { * FieldBarSeriesItem: { * FieldId: "STRING_VALUE", // required * Settings: { * DecalSettings: "", * BorderSettings: "", * }, * }, * DataFieldBarSeriesItem: { * FieldId: "STRING_VALUE", // required * FieldValue: "STRING_VALUE", * Settings: { * DecalSettings: "", * BorderSettings: "", * }, * }, * }, * ], * Legend: "", * DataLabels: "", * Tooltip: "", * ReferenceLines: [ * { * Status: "ENABLED" || "DISABLED", * DataConfiguration: { * StaticConfiguration: { * Value: Number("double"), // required * }, * DynamicConfiguration: { * Column: "", // required * MeasureAggregationFunction: "", * Calculation: "", // required * }, * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", * SeriesType: "BAR" || "LINE", * }, * StyleConfiguration: { * Pattern: "SOLID" || "DASHED" || "DOTTED", * Color: "STRING_VALUE", * }, * LabelConfiguration: { * ValueLabelConfiguration: { * RelativePosition: "BEFORE_CUSTOM_LABEL" || "AFTER_CUSTOM_LABEL", * FormatConfiguration: "", * }, * CustomLabelConfiguration: { * CustomLabel: "STRING_VALUE", // required * }, * FontConfiguration: "", * FontColor: "STRING_VALUE", * HorizontalPosition: "LEFT" || "CENTER" || "RIGHT", * VerticalPosition: "ABOVE" || "BELOW", * }, * }, * ], * ContributionAnalysisDefaults: [ * { * MeasureFieldId: "STRING_VALUE", // required * ContributorDimensions: [ // required * "", * ], * }, * ], * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * KPIVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * Values: "", * TargetValues: "", * TrendGroups: "", * }, * SortConfiguration: { * TrendGroupSort: "", * }, * KPIOptions: { * ProgressBar: { * Visibility: "HIDDEN" || "VISIBLE", * }, * TrendArrows: { * Visibility: "HIDDEN" || "VISIBLE", * }, * SecondaryValue: { * Visibility: "HIDDEN" || "VISIBLE", * }, * Comparison: { * ComparisonMethod: "DIFFERENCE" || "PERCENT_DIFFERENCE" || "PERCENT", * ComparisonFormat: { * NumberDisplayFormatConfiguration: "", * PercentageDisplayFormatConfiguration: "", * }, * }, * PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL", * PrimaryValueFontConfiguration: "", * SecondaryValueFontConfiguration: "", * Sparkline: { * Visibility: "HIDDEN" || "VISIBLE", * Type: "LINE" || "AREA", // required * Color: "STRING_VALUE", * TooltipVisibility: "HIDDEN" || "VISIBLE", * }, * VisualLayoutOptions: { * StandardLayout: { * Type: "CLASSIC" || "VERTICAL", // required * }, * }, * }, * Interactions: "", * }, * ConditionalFormatting: { * ConditionalFormattingOptions: [ * { * PrimaryValue: { * TextColor: "", * Icon: "", * }, * ProgressBar: { * ForegroundColor: "", * }, * ActualValue: { * TextColor: "", * Icon: "", * }, * ComparisonValue: { * TextColor: "", * Icon: "", * }, * }, * ], * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * PieChartVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * PieChartAggregatedFieldWells: { * Category: "", * Values: "", * SmallMultiples: [ * "", * ], * }, * }, * SortConfiguration: { * CategorySort: "", * CategoryItemsLimit: "", * SmallMultiplesSort: "", * SmallMultiplesLimitConfiguration: "", * }, * DonutOptions: { * ArcOptions: { * ArcThickness: "SMALL" || "MEDIUM" || "LARGE" || "WHOLE", * }, * DonutCenterOptions: { * LabelVisibility: "HIDDEN" || "VISIBLE", * }, * }, * SmallMultiplesOptions: { * MaxVisibleRows: Number("long"), * MaxVisibleColumns: Number("long"), * PanelConfiguration: { * Title: { * Visibility: "HIDDEN" || "VISIBLE", * FontConfiguration: "", * HorizontalTextAlignment: "LEFT" || "CENTER" || "RIGHT" || "AUTO", * }, * BorderVisibility: "HIDDEN" || "VISIBLE", * BorderThickness: "STRING_VALUE", * BorderStyle: "SOLID" || "DASHED" || "DOTTED", * BorderColor: "STRING_VALUE", * GutterVisibility: "HIDDEN" || "VISIBLE", * GutterSpacing: "STRING_VALUE", * BackgroundVisibility: "HIDDEN" || "VISIBLE", * BackgroundColor: "STRING_VALUE", * }, * XAxis: "", * YAxis: "", * }, * CategoryLabelOptions: "", * ValueLabelOptions: "", * Legend: "", * DataLabels: "", * Tooltip: "", * VisualPalette: "", * ContributionAnalysisDefaults: [ * { * MeasureFieldId: "STRING_VALUE", // required * ContributorDimensions: [ // required * "", * ], * }, * ], * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * GaugeChartVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * Values: "", * TargetValues: "", * }, * GaugeChartOptions: { * PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL", * Comparison: { * ComparisonMethod: "DIFFERENCE" || "PERCENT_DIFFERENCE" || "PERCENT", * ComparisonFormat: { * NumberDisplayFormatConfiguration: "", * PercentageDisplayFormatConfiguration: "", * }, * }, * ArcAxis: { * Range: { * Min: Number("double"), * Max: Number("double"), * }, * ReserveRange: Number("int"), * }, * Arc: { * ArcAngle: Number("double"), * ArcThickness: "SMALL" || "MEDIUM" || "LARGE", * }, * PrimaryValueFontConfiguration: "", * }, * DataLabels: "", * TooltipOptions: "", * VisualPalette: "", * ColorConfiguration: { * ForegroundColor: "STRING_VALUE", * BackgroundColor: "STRING_VALUE", * }, * Interactions: "", * }, * ConditionalFormatting: { * ConditionalFormattingOptions: [ * { * PrimaryValue: { * TextColor: "", * Icon: "", * }, * Arc: { * ForegroundColor: "", * }, * }, * ], * }, * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * LineChartVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * LineChartAggregatedFieldWells: { * Category: "", * Values: "", * Colors: "", * SmallMultiples: "", * }, * }, * SortConfiguration: { * CategorySort: "", * CategoryItemsLimitConfiguration: "", * ColorItemsLimitConfiguration: "", * SmallMultiplesSort: "", * SmallMultiplesLimitConfiguration: "", * }, * ForecastConfigurations: [ * { * ForecastProperties: { * PeriodsForward: Number("int"), * PeriodsBackward: Number("int"), * UpperBoundary: Number("double"), * LowerBoundary: Number("double"), * PredictionInterval: Number("int"), * Seasonality: Number("int"), * }, * Scenario: { * WhatIfPointScenario: { * Date: new Date("TIMESTAMP"), // required * Value: Number("double"), // required * }, * WhatIfRangeScenario: { * StartDate: new Date("TIMESTAMP"), // required * EndDate: new Date("TIMESTAMP"), // required * Value: Number("double"), // required * }, * }, * }, * ], * Type: "LINE" || "AREA" || "STACKED_AREA", * SmallMultiplesOptions: "", * XAxisDisplayOptions: "", * XAxisLabelOptions: "", * PrimaryYAxisDisplayOptions: { * AxisOptions: "", * MissingDataConfigurations: [ * { * TreatmentOption: "INTERPOLATE" || "SHOW_AS_ZERO" || "SHOW_AS_BLANK", * }, * ], * }, * PrimaryYAxisLabelOptions: "", * SecondaryYAxisDisplayOptions: { * AxisOptions: "", * MissingDataConfigurations: [ * { * TreatmentOption: "INTERPOLATE" || "SHOW_AS_ZERO" || "SHOW_AS_BLANK", * }, * ], * }, * SecondaryYAxisLabelOptions: "", * SingleAxisOptions: { * YAxisOptions: { * YAxis: "PRIMARY_Y_AXIS", // required * }, * }, * DefaultSeriesSettings: { * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", * LineStyleSettings: "", * MarkerStyleSettings: "", * DecalSettings: "", * }, * Series: [ * { * FieldSeriesItem: { * FieldId: "STRING_VALUE", // required * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", // required * Settings: { * LineStyleSettings: "", * MarkerStyleSettings: "", * DecalSettings: "", * }, * }, * DataFieldSeriesItem: { * FieldId: "STRING_VALUE", // required * FieldValue: "STRING_VALUE", * AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS", // required * Settings: { * LineStyleSettings: "", * MarkerStyleSettings: "", * DecalSettings: "", * }, * }, * }, * ], * Legend: "", * DataLabels: "", * ReferenceLines: "", * Tooltip: "", * ContributionAnalysisDefaults: "", * VisualPalette: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * HeatMapVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * HeatMapAggregatedFieldWells: { * Rows: [ * "", * ], * Columns: [ * "", * ], * Values: [ * "", * ], * }, * }, * SortConfiguration: { * HeatMapRowSort: "", * HeatMapColumnSort: "", * HeatMapRowItemsLimitConfiguration: "", * HeatMapColumnItemsLimitConfiguration: "", * }, * RowAxisDisplayOptions: "", * RowLabelOptions: "", * ColumnAxisDisplayOptions: "", * ColumnLabelOptions: "", * ColorScale: { * Colors: [ // required * { * Color: "STRING_VALUE", * DataValue: Number("double"), * }, * ], * ColorFillType: "DISCRETE" || "GRADIENT", // required * NullValueColor: "", * }, * Legend: "", * DataLabels: "", * Tooltip: "", * Interactions: "", * }, * ColumnHierarchies: "", * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * TreeMapVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * TreeMapAggregatedFieldWells: { * Groups: [ * "", * ], * Sizes: [ * "", * ], * Colors: [ * "", * ], * }, * }, * SortConfiguration: { * TreeMapSort: "", * TreeMapGroupItemsLimitConfiguration: "", * }, * GroupLabelOptions: "", * SizeLabelOptions: "", * ColorLabelOptions: "", * ColorScale: { * Colors: [ // required * "", * ], * ColorFillType: "DISCRETE" || "GRADIENT", // required * NullValueColor: "", * }, * Legend: "", * DataLabels: "", * Tooltip: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * GeospatialMapVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * GeospatialMapAggregatedFieldWells: { * Geospatial: "", * Values: "", * Colors: "", * }, * }, * Legend: "", * Tooltip: "", * WindowOptions: { * Bounds: { * North: Number("double"), // required * South: Number("double"), // required * West: Number("double"), // required * East: Number("double"), // required * }, * MapZoomMode: "AUTO" || "MANUAL", * }, * MapStyleOptions: { * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", * }, * PointStyleOptions: { * SelectedPointStyle: "POINT" || "CLUSTER" || "HEATMAP", * ClusterMarkerConfiguration: { * ClusterMarker: { * SimpleClusterMarker: { * Color: "STRING_VALUE", * }, * }, * }, * HeatmapConfiguration: { * HeatmapColor: { * Colors: [ * { * Color: "STRING_VALUE", // required * }, * ], * }, * }, * }, * VisualPalette: "", * Interactions: "", * }, * ColumnHierarchies: "", * Actions: "", * VisualContentAltText: "STRING_VALUE", * GeocodingPreferences: [ * { * RequestKey: { * Country: "STRING_VALUE", * State: "STRING_VALUE", * County: "STRING_VALUE", * City: "STRING_VALUE", * PostCode: "STRING_VALUE", * }, * Preference: {// Union: only one key present * GeocoderHierarchy: "", * Coordinate: { * Latitude: Number("double"), // required * Longitude: Number("double"), // required * }, * }, * }, * ], * }, * FilledMapVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * FilledMapAggregatedFieldWells: { * Geospatial: [ * "", * ], * Values: [ * "", * ], * }, * }, * SortConfiguration: { * CategorySort: "", * }, * Legend: "", * Tooltip: "", * WindowOptions: { * Bounds: { * North: Number("double"), // required * South: Number("double"), // required * West: Number("double"), // required * East: Number("double"), // required * }, * MapZoomMode: "AUTO" || "MANUAL", * }, * MapStyleOptions: { * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", * }, * Interactions: "", * }, * ConditionalFormatting: { * ConditionalFormattingOptions: [ // required * { * Shape: { * FieldId: "STRING_VALUE", // required * Format: { * BackgroundColor: "", // required * }, * }, * }, * ], * }, * ColumnHierarchies: "", * Actions: "", * VisualContentAltText: "STRING_VALUE", * GeocodingPreferences: [ * { * RequestKey: "", // required * Preference: {// Union: only one key present * GeocoderHierarchy: "", * Coordinate: { * Latitude: Number("double"), // required * Longitude: Number("double"), // required * }, * }, * }, * ], * }, * LayerMapVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * Legend: "", * MapLayers: [ * { * LayerId: "STRING_VALUE", // required * LayerType: "POINT" || "LINE" || "POLYGON", * DataSource: { * StaticFileDataSource: { * StaticFileId: "STRING_VALUE", // required * }, * }, * Label: "STRING_VALUE", * Visibility: "HIDDEN" || "VISIBLE", * LayerDefinition: { * PointLayer: { * Style: { * CircleSymbolStyle: { * FillColor: "", * StrokeColor: "", * StrokeWidth: { * LineWidth: Number("double"), * }, * CircleRadius: { * Radius: Number("double"), * }, * }, * }, * }, * LineLayer: { * Style: { * LineSymbolStyle: { * FillColor: "", * LineWidth: { * LineWidth: Number("double"), * }, * }, * }, * }, * PolygonLayer: { * Style: { * PolygonSymbolStyle: { * FillColor: "", * StrokeColor: "", * StrokeWidth: "", * }, * }, * }, * }, * Tooltip: "", * JoinDefinition: { * ShapeKeyField: "STRING_VALUE", * DatasetKeyField: { * FieldId: "STRING_VALUE", // required * Column: "", // required * FormatConfiguration: { * StringFormatConfiguration: "", * NumberFormatConfiguration: "", * DateTimeFormatConfiguration: "", * }, * }, * ColorField: { * ColorDimensionsFields: [ * "", * ], * ColorValuesFields: [ * "", * ], * }, * }, * Actions: [ * { * CustomActionId: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * Status: "ENABLED" || "DISABLED", * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_MENU", // required * ActionOperations: [ // required * { * FilterOperation: "", * NavigationOperation: "", * URLOperation: "", * SetParametersOperation: "", * }, * ], * }, * ], * }, * ], * MapState: { * Bounds: "", * MapNavigation: "ENABLED" || "DISABLED", * }, * MapStyle: { * BaseMapStyle: "LIGHT_GRAY" || "DARK_GRAY" || "STREET" || "IMAGERY", * BackgroundColor: "STRING_VALUE", * BaseMapVisibility: "HIDDEN" || "VISIBLE", * }, * Interactions: "", * }, * DataSetIdentifier: "STRING_VALUE", // required * VisualContentAltText: "STRING_VALUE", * }, * FunnelChartVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * FunnelChartAggregatedFieldWells: { * Category: [ * "", * ], * Values: [ * "", * ], * }, * }, * SortConfiguration: { * CategorySort: "", * CategoryItemsLimit: "", * }, * CategoryLabelOptions: "", * ValueLabelOptions: "", * Tooltip: "", * DataLabelOptions: { * Visibility: "HIDDEN" || "VISIBLE", * CategoryLabelVisibility: "HIDDEN" || "VISIBLE", * MeasureLabelVisibility: "HIDDEN" || "VISIBLE", * Position: "INSIDE" || "OUTSIDE" || "LEFT" || "TOP" || "BOTTOM" || "RIGHT", * LabelFontConfiguration: "", * LabelColor: "STRING_VALUE", * MeasureDataLabelStyle: "VALUE_ONLY" || "PERCENTAGE_BY_FIRST_STAGE" || "PERCENTAGE_BY_PREVIOUS_STAGE" || "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE" || "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE", * }, * VisualPalette: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * ScatterPlotVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * ScatterPlotCategoricallyAggregatedFieldWells: { * XAxis: "", * YAxis: "", * Category: "", * Size: "", * Label: "", * }, * ScatterPlotUnaggregatedFieldWells: { * XAxis: "", * YAxis: "", * Size: "", * Category: "", * Label: "", * }, * }, * SortConfiguration: { * ScatterPlotLimitConfiguration: "", * }, * XAxisLabelOptions: "", * XAxisDisplayOptions: "", * YAxisLabelOptions: "", * YAxisDisplayOptions: "", * Legend: "", * DataLabels: "", * Tooltip: "", * VisualPalette: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * ComboChartVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * ComboChartAggregatedFieldWells: { * Category: "", * BarValues: "", * Colors: "", * LineValues: "", * }, * }, * SortConfiguration: { * CategorySort: "", * CategoryItemsLimit: "", * ColorSort: "", * ColorItemsLimit: "", * }, * BarsArrangement: "CLUSTERED" || "STACKED" || "STACKED_PERCENT", * CategoryAxis: "", * CategoryLabelOptions: "", * PrimaryYAxisDisplayOptions: "", * PrimaryYAxisLabelOptions: "", * SecondaryYAxisDisplayOptions: "", * SecondaryYAxisLabelOptions: "", * SingleAxisOptions: { * YAxisOptions: { * YAxis: "PRIMARY_Y_AXIS", // required * }, * }, * ColorLabelOptions: "", * DefaultSeriesSettings: { * LineStyleSettings: "", * MarkerStyleSettings: "", * DecalSettings: "", * BorderSettings: "", * }, * Series: [ * { * FieldComboSeriesItem: { * FieldId: "STRING_VALUE", // required * Settings: { * LineStyleSettings: "", * MarkerStyleSettings: "", * DecalSettings: "", * BorderSettings: "", * }, * }, * DataFieldComboSeriesItem: { * FieldId: "STRING_VALUE", // required * FieldValue: "STRING_VALUE", * Settings: { * LineStyleSettings: "", * MarkerStyleSettings: "", * DecalSettings: "", * BorderSettings: "", * }, * }, * }, * ], * Legend: "", * BarDataLabels: "", * LineDataLabels: "", * Tooltip: "", * ReferenceLines: "", * VisualPalette: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * BoxPlotVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * BoxPlotAggregatedFieldWells: { * GroupBy: [ * "", * ], * Values: [ * "", * ], * }, * }, * SortConfiguration: { * CategorySort: "", * PaginationConfiguration: { * PageSize: Number("long"), // required * PageNumber: Number("long"), // required * }, * }, * BoxPlotOptions: { * StyleOptions: { * FillStyle: "SOLID" || "TRANSPARENT", * }, * OutlierVisibility: "HIDDEN" || "VISIBLE", * AllDataPointsVisibility: "HIDDEN" || "VISIBLE", * }, * CategoryAxis: "", * CategoryLabelOptions: "", * PrimaryYAxisDisplayOptions: "", * PrimaryYAxisLabelOptions: "", * Legend: "", * Tooltip: "", * ReferenceLines: "", * VisualPalette: "", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * WaterfallVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * WaterfallChartAggregatedFieldWells: { * Categories: "", * Values: "", * Breakdowns: "", * }, * }, * SortConfiguration: { * CategorySort: "", * BreakdownItemsLimit: "", * }, * WaterfallChartOptions: { * TotalBarLabel: "STRING_VALUE", * }, * CategoryAxisLabelOptions: "", * CategoryAxisDisplayOptions: "", * PrimaryYAxisLabelOptions: "", * PrimaryYAxisDisplayOptions: "", * Legend: "", * DataLabels: "", * VisualPalette: "", * ColorConfiguration: { * GroupColorConfiguration: { * PositiveBarColor: "STRING_VALUE", * NegativeBarColor: "STRING_VALUE", * TotalBarColor: "STRING_VALUE", * }, * }, * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * HistogramVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * HistogramAggregatedFieldWells: { * Values: [ * "", * ], * }, * }, * XAxisDisplayOptions: "", * XAxisLabelOptions: "", * YAxisDisplayOptions: "", * BinOptions: { * SelectedBinType: "BIN_COUNT" || "BIN_WIDTH", * BinCount: { * Value: Number("int"), * }, * BinWidth: { * Value: Number("double"), * BinCountLimit: Number("long"), * }, * StartValue: Number("double"), * }, * DataLabels: "", * Tooltip: "", * VisualPalette: "", * Interactions: "", * }, * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * WordCloudVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * WordCloudAggregatedFieldWells: { * GroupBy: [ * "", * ], * Size: [ * "", * ], * }, * }, * SortConfiguration: { * CategoryItemsLimit: "", * CategorySort: "", * }, * CategoryLabelOptions: "", * WordCloudOptions: { * WordOrientation: "HORIZONTAL" || "HORIZONTAL_AND_VERTICAL", * WordScaling: "EMPHASIZE" || "NORMAL", * CloudLayout: "FLUID" || "NORMAL", * WordCasing: "LOWER_CASE" || "EXISTING_CASE", * WordPadding: "NONE" || "SMALL" || "MEDIUM" || "LARGE", * MaximumStringLength: Number("int"), * }, * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * InsightVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * InsightConfiguration: { * Computations: [ * { * TopBottomRanked: { * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Category: "", * Value: "", * ResultSize: Number("int"), * Type: "TOP" || "BOTTOM", // required * }, * TopBottomMovers: { * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Category: "", * Value: "", * MoverSize: Number("int"), * SortOrder: "PERCENT_DIFFERENCE" || "ABSOLUTE_DIFFERENCE", * Type: "TOP" || "BOTTOM", // required * }, * TotalAggregation: { * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Value: "", * }, * MaximumMinimum: { * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Value: "", * Type: "MAXIMUM" || "MINIMUM", // required * }, * MetricComparison: { * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * FromValue: "", * TargetValue: "", * }, * PeriodOverPeriod: { * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Value: "", * }, * PeriodToDate: { * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Value: "", * PeriodTimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * }, * GrowthRate: { * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Value: "", * PeriodSize: Number("int"), * }, * UniqueValues: { * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Category: "", * }, * Forecast: { * ComputationId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Time: "", * Value: "", * PeriodsForward: Number("int"), * PeriodsBackward: Number("int"), * UpperBoundary: Number("double"), * LowerBoundary: Number("double"), * PredictionInterval: Number("int"), * Seasonality: "AUTOMATIC" || "CUSTOM", * CustomSeasonalityValue: Number("int"), * }, * }, * ], * CustomNarrative: { * Narrative: "STRING_VALUE", // required * }, * Interactions: "", * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required * VisualContentAltText: "STRING_VALUE", * }, * SankeyDiagramVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * SankeyDiagramAggregatedFieldWells: { * Source: "", * Destination: "", * Weight: "", * }, * }, * SortConfiguration: { * WeightSort: "", * SourceItemsLimit: "", * DestinationItemsLimit: "", * }, * DataLabels: "", * Interactions: "", * }, * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * CustomContentVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * ContentUrl: "STRING_VALUE", * ContentType: "IMAGE" || "OTHER_EMBEDDED_CONTENT", * ImageScaling: "FIT_TO_HEIGHT" || "FIT_TO_WIDTH" || "DO_NOT_SCALE" || "SCALE_TO_VISUAL", * Interactions: "", * }, * Actions: "", * DataSetIdentifier: "STRING_VALUE", // required * VisualContentAltText: "STRING_VALUE", * }, * EmptyVisual: { * VisualId: "STRING_VALUE", // required * DataSetIdentifier: "STRING_VALUE", // required * Actions: "", * }, * RadarChartVisual: { * VisualId: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: { * RadarChartAggregatedFieldWells: { * Category: [ * "", * ], * Color: [ * "", * ], * Values: [ * "", * ], * }, * }, * SortConfiguration: { * CategorySort: "", * CategoryItemsLimit: "", * ColorSort: "", * ColorItemsLimit: "", * }, * Shape: "CIRCLE" || "POLYGON", * BaseSeriesSettings: { * AreaStyleSettings: { * Visibility: "HIDDEN" || "VISIBLE", * }, * }, * StartAngle: Number("double"), * VisualPalette: "", * AlternateBandColorsVisibility: "HIDDEN" || "VISIBLE", * AlternateBandEvenColor: "STRING_VALUE", * AlternateBandOddColor: "STRING_VALUE", * CategoryAxis: "", * CategoryLabelOptions: "", * ColorAxis: "", * ColorLabelOptions: "", * Legend: "", * AxesRangeScale: "AUTO" || "INDEPENDENT" || "SHARED", * Interactions: "", * }, * Actions: "", * ColumnHierarchies: "", * VisualContentAltText: "STRING_VALUE", * }, * PluginVisual: { * VisualId: "STRING_VALUE", // required * PluginArn: "STRING_VALUE", // required * Title: "", * Subtitle: "", * ChartConfiguration: { * FieldWells: [ * { * AxisName: "GROUP_BY" || "VALUE", * Dimensions: "", * Measures: "", * Unaggregated: [ * "", * ], * }, * ], * VisualOptions: { * VisualProperties: [ * { * Name: "STRING_VALUE", * Value: "STRING_VALUE", * }, * ], * }, * SortConfiguration: { * PluginVisualTableQuerySort: { * RowSort: [ * "", * ], * ItemsLimitConfiguration: { * ItemsLimit: Number("long"), * }, * }, * }, * }, * Actions: "", * VisualContentAltText: "STRING_VALUE", * }, * }, * ], * TextBoxes: [ // TooltipSheetTextBoxList * { * SheetTextBoxId: "STRING_VALUE", // required * Content: "STRING_VALUE", * Interactions: { * TextBoxMenuOption: { * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * }, * ], * Images: [ // TooltipSheetImageList * { * SheetImageId: "STRING_VALUE", // required * Source: { * SheetImageStaticFileSource: { * StaticFileId: "STRING_VALUE", // required * }, * }, * Scaling: { * ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", * }, * Tooltip: { * TooltipText: { * PlainText: "STRING_VALUE", * }, * Visibility: "HIDDEN" || "VISIBLE", * }, * ImageContentAltText: "STRING_VALUE", * Interactions: { * ImageMenuOption: { * AvailabilityStatus: "ENABLED" || "DISABLED", * }, * }, * Actions: [ * { * CustomActionId: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * Status: "ENABLED" || "DISABLED", * Trigger: "CLICK" || "MENU", // required * ActionOperations: [ // required * { * NavigationOperation: "", * URLOperation: "", * SetParametersOperation: "", * }, * ], * }, * ], * }, * ], * Layouts: [ * { * Configuration: { * GridLayout: { * Elements: [ // required * { * ElementId: "STRING_VALUE", // required * ElementType: "VISUAL" || "FILTER_CONTROL" || "PARAMETER_CONTROL" || "TEXT_BOX" || "IMAGE", // required * ColumnIndex: Number("int"), * ColumnSpan: Number("int"), // required * RowIndex: Number("int"), * RowSpan: Number("int"), // required * BorderStyle: { * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * Width: "STRING_VALUE", * }, * SelectedBorderStyle: "", * BackgroundStyle: { * Visibility: "HIDDEN" || "VISIBLE", * Color: "STRING_VALUE", * }, * LoadingAnimation: { * Visibility: "HIDDEN" || "VISIBLE", * }, * BorderRadius: "STRING_VALUE", * Padding: "STRING_VALUE", * }, * ], * CanvasSizeOptions: { * ScreenCanvasSizeOptions: { * ResizeOption: "FIXED" || "RESPONSIVE", // required * OptimizedViewPortWidth: "STRING_VALUE", * }, * }, * }, * FreeFormLayout: { * Elements: "", // required * CanvasSizeOptions: { * ScreenCanvasSizeOptions: { * OptimizedViewPortWidth: "STRING_VALUE", // required * }, * }, * Groups: [ * { * Id: "STRING_VALUE", // required * Members: [ // required * { * Id: "STRING_VALUE", // required * Type: "ELEMENT" || "GROUP", // required * }, * ], * }, * ], * }, * SectionBasedLayout: { * HeaderSections: [ // required * { * SectionId: "STRING_VALUE", // required * Layout: { * FreeFormLayout: { * Elements: "", // required * }, * }, * Style: { * Height: "STRING_VALUE", * Padding: { * Top: "STRING_VALUE", * Bottom: "STRING_VALUE", * Left: "STRING_VALUE", * Right: "STRING_VALUE", * }, * }, * }, * ], * BodySections: [ // required * { * SectionId: "STRING_VALUE", // required * Content: { * Layout: { * FreeFormLayout: { * Elements: "", // required * }, * }, * }, * Style: { * Height: "STRING_VALUE", * Padding: "", * }, * PageBreakConfiguration: { * After: { * Status: "ENABLED" || "DISABLED", * }, * }, * RepeatConfiguration: { * DimensionConfigurations: [ * { * DynamicCategoryDimensionConfiguration: { * Column: "", // required * Limit: Number("int"), * SortByMetrics: [ * "", * ], * }, * DynamicNumericDimensionConfiguration: { * Column: "", // required * Limit: Number("int"), * SortByMetrics: [ * "", * ], * }, * }, * ], * PageBreakConfiguration: { * After: { * Status: "ENABLED" || "DISABLED", * }, * }, * NonRepeatingVisuals: [ * "STRING_VALUE", * ], * }, * }, * ], * FooterSections: [ // required * { * SectionId: "STRING_VALUE", // required * Layout: "", // required * Style: "", * }, * ], * CanvasSizeOptions: { * PaperCanvasSizeOptions: { * PaperSize: "US_LETTER" || "US_LEGAL" || "US_TABLOID_LEDGER" || "A0" || "A1" || "A2" || "A3" || "A4" || "A5" || "JIS_B4" || "JIS_B5", * PaperOrientation: "PORTRAIT" || "LANDSCAPE", * PaperMargin: "", * }, * }, * }, * }, * }, * ], * }, * ], * CalculatedFields: [ // CalculatedFields * { // CalculatedField * DataSetIdentifier: "STRING_VALUE", // required * Name: "STRING_VALUE", // required * Expression: "STRING_VALUE", // required * }, * ], * ParameterDeclarations: [ // ParameterDeclarationList * { // ParameterDeclaration * StringParameterDeclaration: { // StringParameterDeclaration * ParameterValueType: "MULTI_VALUED" || "SINGLE_VALUED", // required * Name: "STRING_VALUE", // required * DefaultValues: { // StringDefaultValues * DynamicValue: { // DynamicDefaultValue * UserNameColumn: "", * GroupNameColumn: "", * DefaultValueColumn: "", // required * }, * StaticValues: "", * }, * ValueWhenUnset: { // StringValueWhenUnsetConfiguration * ValueWhenUnsetOption: "RECOMMENDED_VALUE" || "NULL", * CustomValue: "STRING_VALUE", * }, * MappedDataSetParameters: [ // MappedDataSetParameters * { // MappedDataSetParameter * DataSetIdentifier: "STRING_VALUE", // required * DataSetParameterName: "STRING_VALUE", // required * }, * ], * }, * DecimalParameterDeclaration: { // DecimalParameterDeclaration * ParameterValueType: "MULTI_VALUED" || "SINGLE_VALUED", // required * Name: "STRING_VALUE", // required * DefaultValues: { // DecimalDefaultValues * DynamicValue: { * UserNameColumn: "", * GroupNameColumn: "", * DefaultValueColumn: "", // required * }, * StaticValues: "", * }, * ValueWhenUnset: { // DecimalValueWhenUnsetConfiguration * ValueWhenUnsetOption: "RECOMMENDED_VALUE" || "NULL", * CustomValue: Number("double"), * }, * MappedDataSetParameters: [ * { * DataSetIdentifier: "STRING_VALUE", // required * DataSetParameterName: "STRING_VALUE", // required * }, * ], * }, * IntegerParameterDeclaration: { // IntegerParameterDeclaration * ParameterValueType: "MULTI_VALUED" || "SINGLE_VALUED", // required * Name: "STRING_VALUE", // required * DefaultValues: { // IntegerDefaultValues * DynamicValue: { * UserNameColumn: "", * GroupNameColumn: "", * DefaultValueColumn: "", // required * }, * StaticValues: "", * }, * ValueWhenUnset: { // IntegerValueWhenUnsetConfiguration * ValueWhenUnsetOption: "RECOMMENDED_VALUE" || "NULL", * CustomValue: Number("long"), * }, * MappedDataSetParameters: [ * { * DataSetIdentifier: "STRING_VALUE", // required * DataSetParameterName: "STRING_VALUE", // required * }, * ], * }, * DateTimeParameterDeclaration: { // DateTimeParameterDeclaration * Name: "STRING_VALUE", // required * DefaultValues: { // DateTimeDefaultValues * DynamicValue: { * UserNameColumn: "", * GroupNameColumn: "", * DefaultValueColumn: "", // required * }, * StaticValues: "", * RollingDate: { // RollingDateConfiguration * DataSetIdentifier: "STRING_VALUE", * Expression: "STRING_VALUE", // required * }, * }, * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * ValueWhenUnset: { // DateTimeValueWhenUnsetConfiguration * ValueWhenUnsetOption: "RECOMMENDED_VALUE" || "NULL", * CustomValue: new Date("TIMESTAMP"), * }, * MappedDataSetParameters: [ * { * DataSetIdentifier: "STRING_VALUE", // required * DataSetParameterName: "STRING_VALUE", // required * }, * ], * }, * }, * ], * FilterGroups: [ // FilterGroupList * { // FilterGroup * FilterGroupId: "STRING_VALUE", // required * Filters: [ // FilterList // required * { // Filter * CategoryFilter: { // CategoryFilter * FilterId: "STRING_VALUE", // required * Column: "", // required * Configuration: { // CategoryFilterConfiguration * FilterListConfiguration: { // FilterListConfiguration * MatchOperator: "EQUALS" || "DOES_NOT_EQUAL" || "CONTAINS" || "DOES_NOT_CONTAIN" || "STARTS_WITH" || "ENDS_WITH", // required * CategoryValues: "", * SelectAllOptions: "FILTER_ALL_VALUES", * NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", * }, * CustomFilterListConfiguration: { // CustomFilterListConfiguration * MatchOperator: "EQUALS" || "DOES_NOT_EQUAL" || "CONTAINS" || "DOES_NOT_CONTAIN" || "STARTS_WITH" || "ENDS_WITH", // required * CategoryValues: "", * SelectAllOptions: "FILTER_ALL_VALUES", * NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required * }, * CustomFilterConfiguration: { // CustomFilterConfiguration * MatchOperator: "EQUALS" || "DOES_NOT_EQUAL" || "CONTAINS" || "DOES_NOT_CONTAIN" || "STARTS_WITH" || "ENDS_WITH", // required * CategoryValue: "STRING_VALUE", * SelectAllOptions: "FILTER_ALL_VALUES", * ParameterName: "STRING_VALUE", * NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required * }, * }, * DefaultFilterControlConfiguration: { // DefaultFilterControlConfiguration * Title: "STRING_VALUE", // required * ControlOptions: { // DefaultFilterControlOptions * DefaultDateTimePickerOptions: { // DefaultDateTimePickerControlOptions * Type: "SINGLE_VALUED" || "DATE_RANGE", * DisplayOptions: { * TitleOptions: "", * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: "", * HelperTextVisibility: "HIDDEN" || "VISIBLE", * DateIconVisibility: "HIDDEN" || "VISIBLE", * }, * CommitMode: "AUTO" || "MANUAL", * }, * DefaultListOptions: { // DefaultFilterListControlOptions * DisplayOptions: { * SearchOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * SelectAllOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: { * Values: [ * "STRING_VALUE", * ], * }, * }, * DefaultDropdownOptions: { // DefaultFilterDropDownControlOptions * DisplayOptions: { * SelectAllOptions: "", * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: { * Values: "", * }, * CommitMode: "AUTO" || "MANUAL", * }, * DefaultTextFieldOptions: { // DefaultTextFieldControlOptions * DisplayOptions: { * TitleOptions: "", * PlaceholderOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * InfoIconLabelOptions: "", * }, * }, * DefaultTextAreaOptions: { // DefaultTextAreaControlOptions * Delimiter: "STRING_VALUE", * DisplayOptions: { * TitleOptions: "", * PlaceholderOptions: "", * InfoIconLabelOptions: "", * }, * }, * DefaultSliderOptions: { // DefaultSliderControlOptions * DisplayOptions: { * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "SINGLE_POINT" || "RANGE", * MaximumValue: Number("double"), // required * MinimumValue: Number("double"), // required * StepSize: Number("double"), // required * }, * DefaultRelativeDateTimeOptions: { // DefaultRelativeDateTimeControlOptions * DisplayOptions: { * TitleOptions: "", * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: "", * }, * CommitMode: "AUTO" || "MANUAL", * }, * }, * }, * }, * NumericRangeFilter: { // NumericRangeFilter * FilterId: "STRING_VALUE", // required * Column: "", // required * IncludeMinimum: true || false, * IncludeMaximum: true || false, * RangeMinimum: { // NumericRangeFilterValue * StaticValue: Number("double"), * Parameter: "STRING_VALUE", * }, * RangeMaximum: { * StaticValue: Number("double"), * Parameter: "STRING_VALUE", * }, * SelectAllOptions: "FILTER_ALL_VALUES", * AggregationFunction: "", * NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required * DefaultFilterControlConfiguration: { * Title: "STRING_VALUE", // required * ControlOptions: { * DefaultDateTimePickerOptions: { * Type: "SINGLE_VALUED" || "DATE_RANGE", * DisplayOptions: { * TitleOptions: "", * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: "", * HelperTextVisibility: "HIDDEN" || "VISIBLE", * DateIconVisibility: "HIDDEN" || "VISIBLE", * }, * CommitMode: "AUTO" || "MANUAL", * }, * DefaultListOptions: { * DisplayOptions: { * SearchOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * SelectAllOptions: "", * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: { * Values: "", * }, * }, * DefaultDropdownOptions: { * DisplayOptions: { * SelectAllOptions: "", * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: "", * CommitMode: "AUTO" || "MANUAL", * }, * DefaultTextFieldOptions: { * DisplayOptions: { * TitleOptions: "", * PlaceholderOptions: "", * InfoIconLabelOptions: "", * }, * }, * DefaultTextAreaOptions: { * Delimiter: "STRING_VALUE", * DisplayOptions: { * TitleOptions: "", * PlaceholderOptions: "", * InfoIconLabelOptions: "", * }, * }, * DefaultSliderOptions: { * DisplayOptions: { * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "SINGLE_POINT" || "RANGE", * MaximumValue: Number("double"), // required * MinimumValue: Number("double"), // required * StepSize: Number("double"), // required * }, * DefaultRelativeDateTimeOptions: { * DisplayOptions: { * TitleOptions: "", * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: "", * }, * CommitMode: "AUTO" || "MANUAL", * }, * }, * }, * }, * NumericEqualityFilter: { // NumericEqualityFilter * FilterId: "STRING_VALUE", // required * Column: "", // required * Value: Number("double"), * SelectAllOptions: "FILTER_ALL_VALUES", * MatchOperator: "EQUALS" || "DOES_NOT_EQUAL", // required * AggregationFunction: "", * ParameterName: "STRING_VALUE", * NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required * DefaultFilterControlConfiguration: { * Title: "STRING_VALUE", // required * ControlOptions: { * DefaultDateTimePickerOptions: { * Type: "SINGLE_VALUED" || "DATE_RANGE", * DisplayOptions: { * TitleOptions: "", * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: "", * HelperTextVisibility: "HIDDEN" || "VISIBLE", * DateIconVisibility: "HIDDEN" || "VISIBLE", * }, * CommitMode: "AUTO" || "MANUAL", * }, * DefaultListOptions: { * DisplayOptions: { * SearchOptions: { * Visibility: "HIDDEN" || "VISIBLE", * }, * SelectAllOptions: "", * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: "", * }, * DefaultDropdownOptions: { * DisplayOptions: { * SelectAllOptions: "", * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: "", * CommitMode: "AUTO" || "MANUAL", * }, * DefaultTextFieldOptions: { * DisplayOptions: { * TitleOptions: "", * PlaceholderOptions: "", * InfoIconLabelOptions: "", * }, * }, * DefaultTextAreaOptions: { * Delimiter: "STRING_VALUE", * DisplayOptions: { * TitleOptions: "", * PlaceholderOptions: "", * InfoIconLabelOptions: "", * }, * }, * DefaultSliderOptions: { * DisplayOptions: { * TitleOptions: "", * InfoIconLabelOptions: "", * }, * Type: "SINGLE_POINT" || "RANGE", * MaximumValue: Number("double"), // required * MinimumValue: Number("double"), // required * StepSize: Number("double"), // required * }, * DefaultRelativeDateTimeOptions: { * DisplayOptions: { * TitleOptions: "", * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: "", * }, * CommitMode: "AUTO" || "MANUAL", * }, * }, * }, * }, * TimeEqualityFilter: { // TimeEqualityFilter * FilterId: "STRING_VALUE", // required * Column: "", // required * Value: new Date("TIMESTAMP"), * ParameterName: "STRING_VALUE", * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * RollingDate: { * DataSetIdentifier: "STRING_VALUE", * Expression: "STRING_VALUE", // required * }, * DefaultFilterControlConfiguration: { * Title: "STRING_VALUE", // required * ControlOptions: { * DefaultDateTimePickerOptions: { * Type: "SINGLE_VALUED" || "DATE_RANGE", * DisplayOptions: "", * CommitMode: "AUTO" || "MANUAL", * }, * DefaultListOptions: { * DisplayOptions: "", * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: "", * }, * DefaultDropdownOptions: { * DisplayOptions: "", * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: "", * CommitMode: "AUTO" || "MANUAL", * }, * DefaultTextFieldOptions: { * DisplayOptions: "", * }, * DefaultTextAreaOptions: { * Delimiter: "STRING_VALUE", * DisplayOptions: "", * }, * DefaultSliderOptions: { * DisplayOptions: "", * Type: "SINGLE_POINT" || "RANGE", * MaximumValue: Number("double"), // required * MinimumValue: Number("double"), // required * StepSize: Number("double"), // required * }, * DefaultRelativeDateTimeOptions: { * DisplayOptions: { * TitleOptions: "", * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: "", * }, * CommitMode: "AUTO" || "MANUAL", * }, * }, * }, * }, * TimeRangeFilter: { // TimeRangeFilter * FilterId: "STRING_VALUE", // required * Column: "", // required * IncludeMinimum: true || false, * IncludeMaximum: true || false, * RangeMinimumValue: { // TimeRangeFilterValue * StaticValue: new Date("TIMESTAMP"), * RollingDate: "", * Parameter: "STRING_VALUE", * }, * RangeMaximumValue: { * StaticValue: new Date("TIMESTAMP"), * RollingDate: "", * Parameter: "STRING_VALUE", * }, * NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required * ExcludePeriodConfiguration: { // ExcludePeriodConfiguration * Amount: Number("int"), // required * Granularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", // required * Status: "ENABLED" || "DISABLED", * }, * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * DefaultFilterControlConfiguration: { * Title: "STRING_VALUE", // required * ControlOptions: { * DefaultDateTimePickerOptions: { * Type: "SINGLE_VALUED" || "DATE_RANGE", * DisplayOptions: "", * CommitMode: "AUTO" || "MANUAL", * }, * DefaultListOptions: { * DisplayOptions: "", * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: "", * }, * DefaultDropdownOptions: { * DisplayOptions: "", * Type: "MULTI_SELECT" || "SINGLE_SELECT", * SelectableValues: "", * CommitMode: "AUTO" || "MANUAL", * }, * DefaultTextFieldOptions: { * DisplayOptions: "", * }, * DefaultTextAreaOptions: { * Delimiter: "STRING_VALUE", * DisplayOptions: "", * }, * DefaultSliderOptions: { * DisplayOptions: "", * Type: "SINGLE_POINT" || "RANGE", * MaximumValue: Number("double"), // required * MinimumValue: Number("double"), // required * StepSize: Number("double"), // required * }, * DefaultRelativeDateTimeOptions: { * DisplayOptions: "", * CommitMode: "AUTO" || "MANUAL", * }, * }, * }, * }, * RelativeDatesFilter: { // RelativeDatesFilter * FilterId: "STRING_VALUE", // required * Column: "", // required * AnchorDateConfiguration: { // AnchorDateConfiguration * AnchorOption: "NOW", * ParameterName: "STRING_VALUE", * }, * MinimumGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", // required * RelativeDateType: "PREVIOUS" || "THIS" || "LAST" || "NOW" || "NEXT", // required * RelativeDateValue: Number("int"), * ParameterName: "STRING_VALUE", * NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required * ExcludePeriodConfiguration: { * Amount: Number("int"), // required * Granularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", // required * Status: "ENABLED" || "DISABLED", * }, * DefaultFilterControlConfiguration: "", * }, * TopBottomFilter: { // TopBottomFilter * FilterId: "STRING_VALUE", // required * Column: "", // required * Limit: Number("int"), * AggregationSortConfigurations: [ // AggregationSortConfigurationList // required * { // AggregationSortConfiguration * Column: "", // required * SortDirection: "ASC" || "DESC", // required * AggregationFunction: "", * }, * ], * TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", * ParameterName: "STRING_VALUE", * DefaultFilterControlConfiguration: "", * }, * NestedFilter: { // NestedFilter * FilterId: "STRING_VALUE", // required * Column: "", // required * IncludeInnerSet: true || false, // required * InnerFilter: { // InnerFilter * CategoryInnerFilter: { // CategoryInnerFilter * Column: "", // required * Configuration: { * FilterListConfiguration: { * MatchOperator: "EQUALS" || "DOES_NOT_EQUAL" || "CONTAINS" || "DOES_NOT_CONTAIN" || "STARTS_WITH" || "ENDS_WITH", // required * CategoryValues: "", * SelectAllOptions: "FILTER_ALL_VALUES", * NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", * }, * CustomFilterListConfiguration: { * MatchOperator: "EQUALS" || "DOES_NOT_EQUAL" || "CONTAINS" || "DOES_NOT_CONTAIN" || "STARTS_WITH" || "ENDS_WITH", // required * CategoryValues: "", * SelectAllOptions: "FILTER_ALL_VALUES", * NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required * }, * CustomFilterConfiguration: { * MatchOperator: "EQUALS" || "DOES_NOT_EQUAL" || "CONTAINS" || "DOES_NOT_CONTAIN" || "STARTS_WITH" || "ENDS_WITH", // required * CategoryValue: "STRING_VALUE", * SelectAllOptions: "FILTER_ALL_VALUES", * ParameterName: "STRING_VALUE", * NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required * }, * }, * DefaultFilterControlConfiguration: "", * }, * }, * }, * }, * ], * ScopeConfiguration: { // FilterScopeConfiguration * SelectedSheets: { // SelectedSheetsFilterScopeConfiguration * SheetVisualScopingConfigurations: [ // SheetVisualScopingConfigurations * { // SheetVisualScopingConfiguration * SheetId: "STRING_VALUE", // required * Scope: "ALL_VISUALS" || "SELECTED_VISUALS", // required * VisualIds: [ // FilteredVisualsList * "STRING_VALUE", * ], * }, * ], * }, * AllSheets: {}, * }, * Status: "ENABLED" || "DISABLED", * CrossDataset: "ALL_DATASETS" || "SINGLE_DATASET", // required * }, * ], * ColumnConfigurations: [ // ColumnConfigurationList * { // ColumnConfiguration * Column: "", // required * FormatConfiguration: "", * Role: "DIMENSION" || "MEASURE", * ColorsConfiguration: { // ColorsConfiguration * CustomColors: [ // CustomColorsList * { // CustomColor * FieldValue: "STRING_VALUE", * Color: "STRING_VALUE", // required * SpecialValue: "EMPTY" || "NULL" || "OTHER", * }, * ], * }, * DecalSettingsConfiguration: { // DecalSettingsConfiguration * CustomDecalSettings: [ // DecalSettingsList * "", * ], * }, * }, * ], * AnalysisDefaults: { // AnalysisDefaults * DefaultNewSheetConfiguration: { // DefaultNewSheetConfiguration * InteractiveLayoutConfiguration: { // DefaultInteractiveLayoutConfiguration * Grid: { // DefaultGridLayoutConfiguration * CanvasSizeOptions: { * ScreenCanvasSizeOptions: { * ResizeOption: "FIXED" || "RESPONSIVE", // required * OptimizedViewPortWidth: "STRING_VALUE", * }, * }, * }, * FreeForm: { // DefaultFreeFormLayoutConfiguration * CanvasSizeOptions: { * ScreenCanvasSizeOptions: { * OptimizedViewPortWidth: "STRING_VALUE", // required * }, * }, * }, * }, * PaginatedLayoutConfiguration: { // DefaultPaginatedLayoutConfiguration * SectionBased: { // DefaultSectionBasedLayoutConfiguration * CanvasSizeOptions: { * PaperCanvasSizeOptions: { * PaperSize: "US_LETTER" || "US_LEGAL" || "US_TABLOID_LEDGER" || "A0" || "A1" || "A2" || "A3" || "A4" || "A5" || "JIS_B4" || "JIS_B5", * PaperOrientation: "PORTRAIT" || "LANDSCAPE", * PaperMargin: "", * }, * }, * }, * }, * SheetContentType: "PAGINATED" || "INTERACTIVE", * }, * }, * Options: { // AssetOptions * Timezone: "STRING_VALUE", * WeekStart: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", * QBusinessInsightsStatus: "ENABLED" || "DISABLED", * ExcludedDataSetArns: [ // DataSetArnsList * "STRING_VALUE", * ], * CustomActionDefaults: { * highlightOperation: { * Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required * }, * }, * }, * StaticFiles: [ // StaticFileList * { // StaticFile * ImageStaticFile: { // ImageStaticFile * StaticFileId: "STRING_VALUE", // required * Source: { // StaticFileSource * UrlOptions: { // StaticFileUrlSourceOptions * Url: "STRING_VALUE", // required * }, * S3Options: { // StaticFileS3SourceOptions * BucketName: "STRING_VALUE", // required * ObjectKey: "STRING_VALUE", // required * Region: "STRING_VALUE", // required * }, * }, * }, * SpatialStaticFile: { // SpatialStaticFile * StaticFileId: "STRING_VALUE", // required * Source: { * UrlOptions: { * Url: "STRING_VALUE", // required * }, * S3Options: { * BucketName: "STRING_VALUE", // required * ObjectKey: "STRING_VALUE", // required * Region: "STRING_VALUE", // required * }, * }, * }, * }, * ], * }, * ValidationStrategy: { // ValidationStrategy * Mode: "STRICT" || "LENIENT", // required * }, * }; * const command = new UpdateDashboardCommand(input); * const response = await client.send(command); * // { // UpdateDashboardResponse * // Arn: "STRING_VALUE", * // VersionArn: "STRING_VALUE", * // DashboardId: "STRING_VALUE", * // CreationStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED", * // Status: Number("int"), * // RequestId: "STRING_VALUE", * // }; * * ``` * * @param UpdateDashboardCommandInput - {@link UpdateDashboardCommandInput} * @returns {@link UpdateDashboardCommandOutput} * @see {@link UpdateDashboardCommandInput} for command's `input` shape. * @see {@link UpdateDashboardCommandOutput} for command's `response` shape. * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. * * @throws {@link ConflictException} (client fault) *

Updating or deleting a resource can cause an inconsistent state.

* * @throws {@link InternalFailureException} (server fault) *

An internal failure occurred.

* * @throws {@link InvalidParameterValueException} (client fault) *

One or more parameters has a value that isn't valid.

* * @throws {@link LimitExceededException} (client fault) *

A limit is exceeded.

* * @throws {@link ResourceNotFoundException} (client fault) *

One or more resources can't be found.

* * @throws {@link ThrottlingException} (client fault) *

Access is throttled.

* * @throws {@link UnsupportedUserEditionException} (client fault) *

This error indicates that you are calling an operation on an Amazon Quick Suite * subscription where the edition doesn't include support for that operation. Amazon * Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and * capability is available in every edition.

* * @throws {@link QuickSightServiceException} *

Base exception class for all service exceptions from QuickSight service.

* * * @public */ export declare class UpdateDashboardCommand extends UpdateDashboardCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateDashboardRequest; output: UpdateDashboardResponse; }; sdk: { input: UpdateDashboardCommandInput; output: UpdateDashboardCommandOutput; }; }; }