table operations
Reference for @astrato-io/visualizations@0.6.5.
Use each schema below for the request’s payload, not for the whole operation request. Names and payloads are specific to this visualization type. An operation can still require particular fields or chart state; see its description.
Available operations
Section titled “Available operations”addColumnaddColumnHtmlFieldaddColumnIndicatorSegmentaddColumnLinkFieldaddMeasureAdvancedAdditionalDimensionDataFieldaddMeasureAdvancedDimensionDataFieldaddMeasureFilteraddResultFilteraddSupportingMeasurechangeColumnFieldchangeSortOrderAndDirectionchangeSupportingMeasureAggregationclearMeasureFilterclearResultFilterduplicateColumnduplicateSupportingMeasureenableCustomNullValueenableQueryTimeoutenableTopNremoveColumnremoveColumnHtmlFieldremoveColumnIndicatorSegmentremoveColumnLinkLabelremoveMeasureAdvancedAdditionalDimensionDataFieldremoveMeasureAdvancedCompareMeasureremoveMeasureAdvancedDimensionDataFieldremoveSupportingMeasurereorderColumnsetColumnAlwaysShowLabelssetColumnBackgroundColorsetColumnBordersetColumnCurrencysetColumnCurrencyIsPrefixsetColumnCustomLabelEnabledsetColumnCustomLabelValuesetColumnDisableSelectionOnClicksetColumnDisableTooltipOnHoversetColumnDrillThroughIconBehaviorsetColumnEditablesetColumnEnableEmitEventssetColumnFilterIconBehaviorsetColumnFontColorsetColumnFontStylesetColumnFormatStringsetColumnFormatTypesetColumnFreezeIconBehaviorsetColumnHiddensetColumnHorizontalAlignsetColumnImageFallbackUrlsetColumnImageFitsetColumnImageMaxHeightsetColumnIndicatorColorTextsetColumnIndicatorPositionsetColumnIndicatorSegmentColorsetColumnIndicatorSegmentIconsetColumnIndicatorSegmentValuesetColumnIndicatorShowTextsetColumnLabelsetColumnLinkLabelsetColumnLinkLabelTypesetColumnMiniChartBarColorsetColumnMiniChartBarColorTypesetColumnMiniChartBarCustomGradientsetColumnMiniChartBarCustomPalettesetColumnMiniChartBarGradientAutosetColumnMiniChartBarGradientMaxsetColumnMiniChartBarGradientMinsetColumnMiniChartBarNegativeColorsetColumnMiniChartBarPaddingsetColumnMiniChartBarPalettesetColumnMiniChartBarRadiussetColumnMiniChartBarYAxisStartsetColumnMiniChartDataLimitsetColumnMiniChartDimensionsetColumnMiniChartIncludeNullValuessetColumnMiniChartLineColorsetColumnMiniChartLineStrokeWidthsetColumnMiniChartLineStylesetColumnMiniChartProgressBackgroundColorsetColumnMiniChartProgressBarColorsetColumnMiniChartProgressBorderRadiussetColumnMiniChartProgressShowCurrentValuesetColumnMiniChartProgressShowLabelssetColumnMiniChartProgressValuePlacementsetColumnMiniChartShowDataPointssetColumnMiniChartUseSameStartDatesetColumnNegativeTypesetColumnProgressDynamicScaleEnabledsetColumnProgressStartingValuesetColumnProgressTargetValuesetColumnRepresentationsetColumnResponsiveWidthsetColumnShowNullValuessetColumnSortIconBehaviorsetColumnTemporalGroupingsetColumnVerticalAlignsetColumnWidthsetColumnWritebackKeysetCustomNullValuesetExportLimitsetExportWithMetadataCreatedBysetExportWithMetadataCreatedDatesetExportWithMetadataCustomInputEnabledsetExportWithMetadataCustomInputNamesetExportWithMetadataCustomInputValuesetExportWithMetadataEnabledsetExportWithMetadataFootersetExportWithMetadataSemanticLayersetExportWithMetadataSqlQuerysetExportWithMetadataSubtitlesetExportWithMetadataTitlesetHideZeroValuessetMeasureAdvancedAdditionalAggregationsetMeasureAdvancedAggregationsetMeasureAdvancedCalculationTypesetMeasureAdvancedCompareMeasuresetMeasureAdvancedComparisonTypesetMeasureAdvancedDensesetMeasureAdvancedDimensionsIdssetMeasureAdvancedGroupTypesetMeasureAdvancedNonTimePeriodsetMeasureAdvancedNonTimePeriodGranularitysetMeasureAdvancedNullIfNotEnoughValuessetMeasureAdvancedOffsetsetMeasureAdvancedParametersetMeasureAdvancedPercentileApproxsetMeasureAdvancedPercentileContinuoussetMeasureAdvancedPercentileValuesetMeasureAdvancedPeriodsPerYearsetMeasureAdvancedRangesComparisonEnabledsetMeasureAdvancedRangesComparisonFirstRangeEndsetMeasureAdvancedRangesComparisonFirstRangeStartsetMeasureAdvancedRangesComparisonSecondRangeEndsetMeasureAdvancedRangesComparisonSecondRangeStartsetMeasureAdvancedRangesComparisonTypesetMeasureAdvancedRankSortDirectionsetMeasureAdvancedSortingOrdersetMeasureAdvancedStandardDeviationssetMeasureAdvancedWindowBeginsetMeasureAdvancedWindowEndsetMeasureDefinedParametersetMeasureFiltersetOthersPositionsetQueryLimitsetQueryTimeoutsetResultFiltersetSortingDirectionsetSortingEnabledsetStaticFilterGroupsetSupportingMeasureEnabledsetTableAllColumnsBackgroundColorsetTableAllColumnsBordersetTableAllColumnsDrillThroughIconBehaviorsetTableAllColumnsFilterIconBehaviorsetTableAllColumnsFontColorsetTableAllColumnsFontStylesetTableAllColumnsFreezeIconBehaviorsetTableAllColumnsHorizontalAlignsetTableAllColumnsResponsiveWidthsetTableAllColumnsSortIconBehaviorsetTableAllColumnsVerticalAlignsetTableAllColumnsWidthsetTableAlwaysFullyExpandedsetTableBackgroundColorsetTableBackgroundTypesetTableBodyFontFamilysetTableBodyFontSizesetTableBorderColorsetTableBorderEnabledsetTableBorderLineStylesetTableBorderRadiussetTableBorderStrokeWidthsetTableColumnBorderColorsetTableColumnBorderssetTableColumnWidthBehaviorsetTableDataStructuresetTableDimensionColumnsetTableDisableInteractiveSortingsetTableEvenBackgroundColorsetTableFixedRowHeightEnabledsetTableFixedRowHeightValuesetTableFreezeColumnsNumbersetTableHeaderAsChipsetTableHeaderBackgroundColorsetTableHeaderBorderColorsetTableHeaderFontColorsetTableHeaderFontFamilysetTableHeaderFontSizesetTableHeaderFontStylesetTableHeaderHiddensetTableHeaderResponsiveHeightsetTableHierarchicalMeasureSortItemsetTableHierarchicalMeasureSortItemByNamesetTableHighlightBackgroundColorsetTableHighlightModesetTableHighlightTextColorsetTableIndexColumnLabelsetTableIndexColumnWidthsetTableMaxLinessetTableMeasuresLabelsetTableMeasuresPositionsetTableMergedCellssetTableMinAutoColumnWidthsetTableOddBackgroundColorsetTableResponsiveRowHeightsetTableShowIndexColumnsetTableShowOnlyAvailableValuesInFiltersetTableSortByMeasuresetTableStickyColumnMinWidthsetTableStickyColumnResponsiveWidthsetTableTotalsApplyTosetTableTotalsBackgroundColorsetTableTotalsEnabledsetTableTotalsFontColorsetTableTotalsFontStylesetTableTotalsPositionsetTableTotalsResponsiveHeightsetTableTotalsShowRecordsCountsetTableWordWrapsetTableWordWrapHeadersetTableWritebackModesetTopNDimensionsetTopNNumberOfValuessetTopNOthersLabelsetTopNRankEachDimensionIndividuallysetTopNShowOtherssetTopNSortOrdertoggleColumntoggleColumnByNametoggleSortingItemtoggleSupportingMeasureupdateCalculatedColumnupdateColumnupdateSupportingMeasure
addColumn
Section titled “addColumn”Add column
Add a new dimension or measure column to the table
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "columnType": { "type": "string", "const": "dimension" }, "key": { "type": "string", "description": "Engine key of the field to be added as a column, eg. \"[Cars].[Horsepower]\"" }, "topDimension": { "description": "Whether the dimension is placed on the pivot table column axis.", "type": "boolean" } }, "required": ["columnType", "key"], "additionalProperties": false }, { "type": "object", "properties": { "columnType": { "type": "string", "const": "measure" }, "sourceKind": { "type": "string", "const": "field" }, "key": { "type": "string", "description": "Engine key of the field to be added as a column, eg. \"[Cars].[Horsepower]\"" }, "aggregation": { "type": "string", "description": "Required for raw database fields. Use one of the aggregation names returned for that field." } }, "required": ["columnType", "sourceKind", "key", "aggregation"], "additionalProperties": false }, { "type": "object", "properties": { "columnType": { "type": "string", "const": "measure" }, "sourceKind": { "type": "string", "const": "measure" }, "key": { "type": "string", "description": "Engine key of the predefined/user-defined measure to add as a column." } }, "required": ["columnType", "sourceKind", "key"], "additionalProperties": false }, { "type": "object", "properties": { "columnType": { "type": "string", "const": "measure" }, "sourceKind": { "type": "string", "const": "calculation" }, "key": { "type": "string", "description": "Engine key of the predefined calculation to add as a column." } }, "required": ["columnType", "sourceKind", "key"], "additionalProperties": false } ], "title": "Add column schema"}addColumnHtmlField
Section titled “addColumnHtmlField”Add HTML field
Set HTML field for a column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "key": { "type": "string", "description": "Engine key of the field to use as HTML source" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"], "additionalProperties": false, "title": "Add HTML field schema"}addColumnIndicatorSegment
Section titled “addColumnIndicatorSegment”Add indicator segment
Add a new indicator segment
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Add indicator segment schema"}addColumnLinkField
Section titled “addColumnLinkField”Add link label field
Set field used for link labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "key": { "type": "string", "description": "Engine key of the field to use as link label" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"], "additionalProperties": false, "title": "Add link label field schema"}addMeasureAdvancedAdditionalDimensionDataField
Section titled “addMeasureAdvancedAdditionalDimensionDataField”Add advanced bottom dimension
Add bottom dimension field for nested ratio advanced calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "key": { "type": "string", "description": "Engine key of the bottom dimension field to be added" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"], "additionalProperties": false, "title": "Add measure advanced additional dimension field schema"}addMeasureAdvancedDimensionDataField
Section titled “addMeasureAdvancedDimensionDataField”Add advanced additional dimension
Add additional dimension field for nested advanced calculations
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "key": { "type": "string", "description": "Engine key of the dimension field to be added" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"], "additionalProperties": false, "title": "Add measure advanced dimension field schema"}addMeasureFilter
Section titled “addMeasureFilter”Add measure filter
Add another measure filter before aggregation. Keeps existing filters.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "contains", "excludes", "like", "notLike", "startsWith", "endsWith" ], "description": "Filter operator that requires a value" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Filter value" } }, "required": ["measureName", "fieldKey", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["isBetween", "isNotBetween"], "description": "Filter operator that requires valueFrom and valueTo" }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Lower filter value" }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Upper filter value" } }, "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["inList", "excludedFromList"], "description": "Filter operator that requires a list of values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Filter values" } }, "required": ["measureName", "fieldKey", "operator", "values"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["isNull", "notNull"], "description": "Filter operator that does not require values" } }, "required": ["measureName", "fieldKey", "operator"], "additionalProperties": false } ], "description": "Add another measure filter before aggregation. Keeps existing filters.", "title": "Add measure filter schema"}addResultFilter
Section titled “addResultFilter”Add result filter
Add another result filter after aggregation. Keeps existing result filters.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "contains", "excludes", "like", "notLike", "startsWith", "endsWith" ], "description": "Filter operator that requires a value" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Filter value" } }, "required": ["measureName", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["isBetween", "isNotBetween"], "description": "Filter operator that requires valueFrom and valueTo" }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Lower filter value" }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Upper filter value" } }, "required": ["measureName", "operator", "valueFrom", "valueTo"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["inList", "excludedFromList"], "description": "Filter operator that requires a list of values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Filter values" } }, "required": ["measureName", "operator", "values"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["isNull", "notNull"], "description": "Filter operator that does not require values" } }, "required": ["measureName", "operator"], "additionalProperties": false } ], "description": "Add another result filter after aggregation. Keeps existing result filters.", "title": "Add result filter schema"}addSupportingMeasure
Section titled “addSupportingMeasure”Add supporting measure
Add a new supporting measure to the table
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "sourceKind": { "type": "string", "const": "field", "description": "Raw database field from available data `fields`." }, "key": { "type": "string", "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"" }, "aggregation": { "type": "string", "description": "Required for raw database fields. Use one of the aggregation names returned for that field." } }, "required": ["sourceKind", "key", "aggregation"], "additionalProperties": false }, { "type": "object", "properties": { "sourceKind": { "type": "string", "const": "measure", "description": "Predefined/user-defined measure from available data `measures`." }, "key": { "type": "string", "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"" } }, "required": ["sourceKind", "key"], "additionalProperties": false }, { "type": "object", "properties": { "sourceKind": { "type": "string", "const": "calculation", "description": "Predefined calculation from available data `measures`." }, "key": { "type": "string", "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"" } }, "required": ["sourceKind", "key"], "additionalProperties": false } ], "title": "Add supporting measure schema"}changeColumnField
Section titled “changeColumnField”Change column field
Change the field used by an existing column. The current column decides whether the replacement key is interpreted as a dimension or measure input.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "key": { "type": "string", "description": "Engine key of the replacement item. For dimension columns this may be a raw field or predefined dimension. For measure columns this may be a raw field, predefined measure, or calculation." }, "sourceKind": { "description": "Optional hint for measure columns only: field, measure, or calculation. Ignored for dimension columns.", "type": "string", "enum": ["field", "measure", "calculation"] }, "aggregation": { "description": "Required only when changing a measure column to use a raw field.", "type": "string" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"], "additionalProperties": false, "title": "Change column field schema"}changeSortOrderAndDirection
Section titled “changeSortOrderAndDirection”Sort order and direction
Change how table data is sorted
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "changeRequests": { "type": "array", "items": { "type": "object", "properties": { "dataItemInternalKey": { "type": "string" }, "dataItemUniqueSignature": { "type": "string" }, "sortDirection": { "type": "string", "enum": ["asc", "desc"] }, "newIndex": { "type": "number", "description": "Index of the item representing the new item position" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "sortDirection", "newIndex"], "additionalProperties": false, "description": "Sort order and direction change request - single request for each item, all items must be present" } } }, "required": ["changeRequests"], "additionalProperties": false, "title": "Change sort order and direction schema"}changeSupportingMeasureAggregation
Section titled “changeSupportingMeasureAggregation”Supporting measure aggregation
Change how a supporting measure is aggregated
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "aggregation": { "type": "string", "minLength": 1, "description": "Aggregation function to be used for the measure" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"], "additionalProperties": false, "title": "Change supporting measure aggregation schema"}clearMeasureFilter
Section titled “clearMeasureFilter”Clear measure filter
Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label. Omit to clear all filters on the measure." } }, "required": ["measureName"], "additionalProperties": false, "description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.", "title": "Clear measure filter schema"}clearResultFilter
Section titled “clearResultFilter”Clear result filter
Clear all result filters for one measure.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" } }, "required": ["measureName"], "additionalProperties": false, "description": "Clear all result filters for one measure.", "title": "Clear result filter schema"}duplicateColumn
Section titled “duplicateColumn”Duplicate column
Create a copy of an existing column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Duplicate column schema"}duplicateSupportingMeasure
Section titled “duplicateSupportingMeasure”Duplicate supporting measure
Create a copy of an existing supporting measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be duplicated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be duplicated" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Duplicate supporting measure schema"}enableCustomNullValue
Section titled “enableCustomNullValue”Custom null value enabled
Enable or disable custom null values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Enable custom null value schema", "type": "boolean"}enableQueryTimeout
Section titled “enableQueryTimeout”Query timeout enabled
Enable or disable query timeout
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Query timeout enabled schema"}enableTopN
Section titled “enableTopN”Top N enabled
Enable or disable Top N
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Top N enabled schema"}removeColumn
Section titled “removeColumn”Remove column
Remove a column using exact internal identifiers or an engine-key selector. Semantic selectors match exactly one column by default; use match “all” to remove every match.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false }, { "type": "object", "properties": { "columnType": { "type": "string", "const": "dimension" }, "key": { "type": "string", "description": "Engine key of the dimension field or item." }, "topDimension": { "description": "When provided, restrict the match to the corresponding pivot table axis.", "type": "boolean" }, "match": { "default": "only", "type": "string", "enum": ["only", "all"] } }, "required": ["columnType", "key", "match"], "additionalProperties": false }, { "type": "object", "properties": { "aggregation": { "type": "string", "description": "Aggregation used by the raw field measure." }, "columnType": { "type": "string", "const": "measure" }, "key": { "type": "string", "description": "Engine key of the raw field used by the measure." }, "sourceKind": { "type": "string", "const": "field" }, "match": { "default": "only", "type": "string", "enum": ["only", "all"] } }, "required": ["aggregation", "columnType", "key", "sourceKind", "match"], "additionalProperties": false }, { "type": "object", "properties": { "columnType": { "type": "string", "const": "measure" }, "key": { "type": "string", "description": "Engine key of the predefined measure or calculation." }, "sourceKind": { "type": "string", "enum": ["measure", "calculation"] }, "match": { "default": "only", "type": "string", "enum": ["only", "all"] } }, "required": ["columnType", "key", "sourceKind", "match"], "additionalProperties": false } ], "title": "Remove column schema"}removeColumnHtmlField
Section titled “removeColumnHtmlField”Remove HTML field
Remove HTML field from a column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Remove HTML field schema"}removeColumnIndicatorSegment
Section titled “removeColumnIndicatorSegment”Remove indicator segment
Remove an indicator segment
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "segmentIndex": { "type": "number" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "segmentIndex"], "additionalProperties": false, "title": "Remove indicator segment schema"}removeColumnLinkLabel
Section titled “removeColumnLinkLabel”Remove link label
Remove custom link label
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Remove link label schema"}removeMeasureAdvancedAdditionalDimensionDataField
Section titled “removeMeasureAdvancedAdditionalDimensionDataField”Remove advanced bottom dimension
Remove bottom dimension field from nested ratio advanced calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "internalKey": { "type": "string", "description": "Internal key of the bottom dimension field to be removed" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "internalKey"], "additionalProperties": false, "title": "Remove measure advanced additional dimension field schema"}removeMeasureAdvancedCompareMeasure
Section titled “removeMeasureAdvancedCompareMeasure”Remove advanced compare measure
Remove compare measure from advanced calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Remove measure advanced compare measure schema"}removeMeasureAdvancedDimensionDataField
Section titled “removeMeasureAdvancedDimensionDataField”Remove advanced additional dimension
Remove additional dimension field from nested advanced calculations
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "internalKey": { "type": "string", "description": "Internal key of the dimension field to be removed" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "internalKey"], "additionalProperties": false, "title": "Remove measure advanced dimension field schema"}removeSupportingMeasure
Section titled “removeSupportingMeasure”Remove supporting measure
Remove a supporting measure from the table
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be removed" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be removed" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Remove supporting measure schema"}reorderColumn
Section titled “reorderColumn”Reorder column
Move a column to the position of another column. Source and target may use exact internal identifiers or unambiguous engine-key selectors.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "source": { "anyOf": [ { "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false }, { "anyOf": [ { "type": "object", "properties": { "columnType": { "type": "string", "const": "dimension" }, "key": { "type": "string", "description": "Engine key of the dimension field or item." }, "topDimension": { "description": "When provided, restrict the match to the corresponding pivot table axis.", "type": "boolean" } }, "required": ["columnType", "key"], "additionalProperties": false }, { "type": "object", "properties": { "aggregation": { "type": "string", "description": "Aggregation used by the raw field measure." }, "columnType": { "type": "string", "const": "measure" }, "key": { "type": "string", "description": "Engine key of the raw field used by the measure." }, "sourceKind": { "type": "string", "const": "field" } }, "required": ["aggregation", "columnType", "key", "sourceKind"], "additionalProperties": false }, { "type": "object", "properties": { "columnType": { "type": "string", "const": "measure" }, "key": { "type": "string", "description": "Engine key of the predefined measure or calculation." }, "sourceKind": { "type": "string", "enum": ["measure", "calculation"] } }, "required": ["columnType", "key", "sourceKind"], "additionalProperties": false } ] } ] }, "target": { "anyOf": [ { "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false }, { "anyOf": [ { "type": "object", "properties": { "columnType": { "type": "string", "const": "dimension" }, "key": { "type": "string", "description": "Engine key of the dimension field or item." }, "topDimension": { "description": "When provided, restrict the match to the corresponding pivot table axis.", "type": "boolean" } }, "required": ["columnType", "key"], "additionalProperties": false }, { "type": "object", "properties": { "aggregation": { "type": "string", "description": "Aggregation used by the raw field measure." }, "columnType": { "type": "string", "const": "measure" }, "key": { "type": "string", "description": "Engine key of the raw field used by the measure." }, "sourceKind": { "type": "string", "const": "field" } }, "required": ["aggregation", "columnType", "key", "sourceKind"], "additionalProperties": false }, { "type": "object", "properties": { "columnType": { "type": "string", "const": "measure" }, "key": { "type": "string", "description": "Engine key of the predefined measure or calculation." }, "sourceKind": { "type": "string", "enum": ["measure", "calculation"] } }, "required": ["columnType", "key", "sourceKind"], "additionalProperties": false } ] } ] } }, "required": ["source", "target"], "additionalProperties": false, "title": "Reorder column schema"}setColumnAlwaysShowLabels
Section titled “setColumnAlwaysShowLabels”Always show labels
Always show labels for the column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "alwaysShowLabels": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "alwaysShowLabels"], "additionalProperties": false, "title": "Always show labels schema"}setColumnBackgroundColor
Section titled “setColumnBackgroundColor”Column background color
Set column background color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "backgroundColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column background color schema"}setColumnBorder
Section titled “setColumnBorder”Column border
Set column border style
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "border": { "type": "string", "enum": ["auto", "showHorizontal", "showVertical", "showAll", "noBorders"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column border schema"}setColumnCurrency
Section titled “setColumnCurrency”Column currency symbol
Set currency symbol for a measure, calculated, or conditional calculated column by exact name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Exact column name" }, "currency": { "type": "string" } }, "required": ["name", "currency"], "additionalProperties": false, "title": "Column currency schema"}setColumnCurrencyIsPrefix
Section titled “setColumnCurrencyIsPrefix”Column currency position
Set currency position for a measure, calculated, or conditional calculated column by exact name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Exact column name" }, "currencyIsPrefix": { "type": "boolean" } }, "required": ["name", "currencyIsPrefix"], "additionalProperties": false, "title": "Column currency position schema"}setColumnCustomLabelEnabled
Section titled “setColumnCustomLabelEnabled”Custom label enabled
Enable or disable custom column label
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "enabled": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"], "additionalProperties": false, "title": "Custom label enabled schema"}setColumnCustomLabelValue
Section titled “setColumnCustomLabelValue”Custom label value
Set custom column label value
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Custom label value schema"}setColumnDisableSelectionOnClick
Section titled “setColumnDisableSelectionOnClick”Disable selection on click
Disable selecting cells on click
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "disableSelectionOnClick": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Disable selection schema"}setColumnDisableTooltipOnHover
Section titled “setColumnDisableTooltipOnHover”Disable tooltip on hover
Disable tooltips on hover
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "disableTooltipOnHover": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Disable tooltip schema"}setColumnDrillThroughIconBehavior
Section titled “setColumnDrillThroughIconBehavior”Column drill-through icon
Set drill-through icon behavior for a column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "drillThroughIconBehaviour": { "type": "string", "enum": ["always", "onHover", "hide"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column drill-through icon schema"}setColumnEditable
Section titled “setColumnEditable”Column editable
Enable or disable column editing
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "editable": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "editable"], "additionalProperties": false, "title": "Column editable schema"}setColumnEnableEmitEvents
Section titled “setColumnEnableEmitEvents”Enable emit events
Enable or disable event emission for a column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "enableEmitEvents": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Enable emit events schema"}setColumnFilterIconBehavior
Section titled “setColumnFilterIconBehavior”Column filter icon
Set filter icon behavior for a column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "filterIconBehavior": { "type": "string", "enum": ["active", "always", "onHover", "hide"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column filter icon schema"}setColumnFontColor
Section titled “setColumnFontColor”Column font color
Set column font color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "fontColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column font color schema"}setColumnFontStyle
Section titled “setColumnFontStyle”Column font style
Update column font style
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "fontStyle": { "type": "object", "properties": { "weight": { "description": "Font weight", "type": ["number", "null"] }, "bold": { "description": "Bold font. Should take precedence over weight", "type": "boolean" }, "italic": { "type": "boolean" }, "underline": { "type": "boolean" }, "strikethrough": { "type": "boolean" } }, "additionalProperties": false } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column font style schema"}setColumnFormatString
Section titled “setColumnFormatString”Column format string
Set the custom column display format string by exact column name. This changes label formatting only and does not change temporal grouping. All columns with the matching name are updated.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Exact column name" }, "formatString": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["name", "formatString"], "additionalProperties": false, "title": "Column format string schema"}setColumnFormatType
Section titled “setColumnFormatType”Column format type
Set the column display format type by exact column name. This changes label formatting only and does not change temporal grouping. All columns with the matching name are updated.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Exact column name" }, "formatType": { "anyOf": [ { "type": "string", "enum": [ "custom", "inherit", "none", "defaultNumber", "defaultMoney", "numberNoDecimal", "number1Decimal", "number2Decimal", "abbreviationAuto", "abbreviationNoDecimal", "abbreviation1Decimal", "abbreviation2Decimal", "percentageNoDecimal", "percentage1Decimal", "percentage2Decimal", "money0Decimal", "money2Decimal", "durationDays", "durationHours", "durationMinutes", "durationSeconds" ] }, { "type": "string", "enum": [ "defaultDate", "defaultDatetime", "defaultTime", "ddmmyyyy", "ddmmyyyy2", "ddmmyyyy3", "yyyymmdd", "mmddyyyy", "mmddyyyy2", "ddmmmmyyyy", "ddmmmyyyy", "ddmmmyy", "mmmmddyyyy", "yyyy", "yy", "mmmyyyy", "yyyymmm", "yyyymmmm", "mmyyyy", "yyyymm", "mmmmyyyy", "yyyywn", "wnyyyy", "yywn", "yyyyq", "qyyyy", "yyyymmddhhmmss", "yyyymmddhmmss", "yyyymmddhhmm", "yyyymmddhh", "yyyymmddhmm", "yyyymmddh", "ddmmmyyyyhhmmss", "ddmmmyyyyhmmss", "ddmmmyyyyhhmm", "ddmmmyyyyhmm", "ddmmmyyyyh", "hhmmss", "hhmm", "hmm", "h", "hh", "hmmss", "month", "month2", "monthn", "month3", "quarter", "quarter2", "week1", "week2", "week3", "day", "dayOfWeek", "hhn", "hn" ] } ] } }, "required": ["name", "formatType"], "additionalProperties": false, "title": "Column format type schema"}setColumnFreezeIconBehavior
Section titled “setColumnFreezeIconBehavior”Column freeze icon
Set freeze icon behavior for a column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "freezeIconBehaviour": { "type": "string", "enum": ["always", "onHover", "hide"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column freeze icon schema"}setColumnHidden
Section titled “setColumnHidden”Hide column
Hide or show a column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "hidden": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Hide column schema"}setColumnHorizontalAlign
Section titled “setColumnHorizontalAlign”Column horizontal align
Set column horizontal alignment
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "horizontalAlign": { "type": "string", "enum": ["auto", "left", "center", "right"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column horizontal align schema"}setColumnImageFallbackUrl
Section titled “setColumnImageFallbackUrl”Image fallback URL
Set image fallback URL
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "fallbackUrl": { "type": "string" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Image fallback URL schema"}setColumnImageFit
Section titled “setColumnImageFit”Image fit
Set image fit behavior
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "fit": { "type": "string", "enum": ["contain", "cover", "fill", "none"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "fit"], "additionalProperties": false, "title": "Image fit schema"}setColumnImageMaxHeight
Section titled “setColumnImageMaxHeight”Image max height
Set image maximum height
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "maxHeight": { "type": "number" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Image max height schema"}setColumnIndicatorColorText
Section titled “setColumnIndicatorColorText”Indicator color text
Enable or disable colored indicator text
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "colorText": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Indicator color text schema"}setColumnIndicatorPosition
Section titled “setColumnIndicatorPosition”Indicator position
Set indicator position
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "position": { "type": "string", "enum": ["left", "right"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Indicator position schema"}setColumnIndicatorSegmentColor
Section titled “setColumnIndicatorSegmentColor”Indicator segment color
Set indicator segment color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "segmentIndex": { "type": "number" }, "color": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "segmentIndex"], "additionalProperties": false, "title": "Indicator segment color schema"}setColumnIndicatorSegmentIcon
Section titled “setColumnIndicatorSegmentIcon”Indicator segment icon
Set indicator segment icon
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "segmentIndex": { "type": "number" }, "icon": { "type": "string" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "segmentIndex"], "additionalProperties": false, "title": "Indicator segment icon schema"}setColumnIndicatorSegmentValue
Section titled “setColumnIndicatorSegmentValue”Indicator segment value
Set indicator segment value
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "segmentIndex": { "type": "number" }, "value": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "segmentIndex"], "additionalProperties": false, "title": "Indicator segment value schema"}setColumnIndicatorShowText
Section titled “setColumnIndicatorShowText”Indicator show text
Show or hide indicator text
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "showText": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Indicator show text schema"}setColumnLabel
Section titled “setColumnLabel”Column label
Set column label
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "label": { "type": "string" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column label schema"}setColumnLinkLabel
Section titled “setColumnLinkLabel”Link label
Set custom link label
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "label": { "type": "string" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Link label schema"}setColumnLinkLabelType
Section titled “setColumnLinkLabelType”Link label type
Set link label type
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "linkLabelType": { "type": "string", "enum": ["field", "custom"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Link label type schema"}setColumnMiniChartBarColor
Section titled “setColumnMiniChartBarColor”Mini chart bar color
Set bar color for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "barColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "description": "Color code (hex, with optional alpha)" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart bar color schema"}setColumnMiniChartBarColorType
Section titled “setColumnMiniChartBarColorType”Mini chart bar color type
Set bar color type for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "colorType": { "type": "string", "enum": ["single", "categorical", "gradient", "perEachMeasure", "perEachDimension"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "colorType"], "additionalProperties": false, "title": "Mini chart bar color type schema"}setColumnMiniChartBarCustomGradient
Section titled “setColumnMiniChartBarCustomGradient”Mini chart custom gradient
Set custom gradient for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "customGradient": { "description": "Custom gradient", "type": "object", "properties": { "id": { "type": "string", "description": "Palette identifier" }, "name": { "description": "Palette name", "type": "string" }, "colors": { "type": "array", "items": { "type": "string" }, "description": "Palette colors" } }, "required": ["id", "colors"], "additionalProperties": false } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart custom gradient schema"}setColumnMiniChartBarCustomPalette
Section titled “setColumnMiniChartBarCustomPalette”Mini chart custom palette
Set custom palette for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "customPalette": { "description": "Custom palette", "type": "object", "properties": { "id": { "type": "string", "description": "Palette identifier" }, "name": { "description": "Palette name", "type": "string" }, "colors": { "type": "array", "items": { "type": "string" }, "description": "Palette colors" } }, "required": ["id", "colors"], "additionalProperties": false } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart custom palette schema"}setColumnMiniChartBarGradientAuto
Section titled “setColumnMiniChartBarGradientAuto”Mini chart automatic gradient limits
Enable automatic gradient limits from the data, or disable Auto to use the stored limits for mini charts. Preserves stored minimum and maximum values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "gradientAuto": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "gradientAuto"], "additionalProperties": false, "title": "Mini chart gradient auto schema"}setColumnMiniChartBarGradientMax
Section titled “setColumnMiniChartBarGradientMax”Mini chart gradient max
Set gradient maximum for mini charts using a number or variable. Applies when setColumnMiniChartBarGradientAuto is false
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "gradientMax": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "gradientMax"], "additionalProperties": false, "title": "Mini chart gradient max schema"}setColumnMiniChartBarGradientMin
Section titled “setColumnMiniChartBarGradientMin”Mini chart gradient min
Set gradient minimum for mini charts using a number or variable. Applies when setColumnMiniChartBarGradientAuto is false
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "gradientMin": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "gradientMin"], "additionalProperties": false, "title": "Mini chart gradient min schema"}setColumnMiniChartBarNegativeColor
Section titled “setColumnMiniChartBarNegativeColor”Mini chart negative bar color
Set negative bar color for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "negativeBarColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart negative bar color schema"}setColumnMiniChartBarPadding
Section titled “setColumnMiniChartBarPadding”Mini chart bar padding
Set bar padding for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "barPadding": { "type": "number" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart bar padding schema"}setColumnMiniChartBarPalette
Section titled “setColumnMiniChartBarPalette”Mini chart bar palette
Set bar palette for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "palette": { "description": "Palette identifier", "type": ["string", "null"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart bar palette schema"}setColumnMiniChartBarRadius
Section titled “setColumnMiniChartBarRadius”Mini chart bar radius
Set bar radius for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "barRadius": { "type": "number" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart bar radius schema"}setColumnMiniChartBarYAxisStart
Section titled “setColumnMiniChartBarYAxisStart”Mini chart y-axis start
Set mini chart y-axis start
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "yAxisStart": { "type": "number" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart y-axis start schema"}setColumnMiniChartDataLimit
Section titled “setColumnMiniChartDataLimit”Mini chart data limit
Set mini chart data limit
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "dataLimit": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart data limit schema"}setColumnMiniChartDimension
Section titled “setColumnMiniChartDimension”Mini chart dimension
Set mini chart dimension field
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "key": { "type": "string", "description": "Engine key of the dimension field for mini chart" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"], "additionalProperties": false, "title": "Mini chart dimension schema"}setColumnMiniChartIncludeNullValues
Section titled “setColumnMiniChartIncludeNullValues”Mini chart include null values
Include null values in mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "includeNullValues": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart include null values schema"}setColumnMiniChartLineColor
Section titled “setColumnMiniChartLineColor”Mini chart line color
Set line color for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "lineColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "description": "Color code (hex, with optional alpha)" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart line color schema"}setColumnMiniChartLineStrokeWidth
Section titled “setColumnMiniChartLineStrokeWidth”Mini chart line stroke width
Set line stroke width for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "strokeWidth": { "type": "number" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart line stroke width schema"}setColumnMiniChartLineStyle
Section titled “setColumnMiniChartLineStyle”Mini chart line style
Set line style for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "lineStyle": { "type": "string", "enum": ["line", "dashed", "dotted"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart line style schema"}setColumnMiniChartProgressBackgroundColor
Section titled “setColumnMiniChartProgressBackgroundColor”Mini chart progress background
Set progress background color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "backgroundColor": { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart progress background color schema"}setColumnMiniChartProgressBarColor
Section titled “setColumnMiniChartProgressBarColor”Mini chart progress bar color
Set progress bar color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "progressBarColor": { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart progress bar color schema"}setColumnMiniChartProgressBorderRadius
Section titled “setColumnMiniChartProgressBorderRadius”Mini chart progress bar radius
Set progress bar radius
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "borderRadius": { "type": "number", "minimum": 0 } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart progress border radius schema"}setColumnMiniChartProgressShowCurrentValue
Section titled “setColumnMiniChartProgressShowCurrentValue”Mini chart progress show value
Show or hide progress current value
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "showCurrentValue": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart progress show current value schema"}setColumnMiniChartProgressShowLabels
Section titled “setColumnMiniChartProgressShowLabels”Mini chart progress show labels
Show or hide progress labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "showLabels": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart progress show labels schema"}setColumnMiniChartProgressValuePlacement
Section titled “setColumnMiniChartProgressValuePlacement”Mini chart progress value placement
Set progress value placement
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "valuePlacement": { "type": "string", "enum": ["inside", "outside", "left", "right"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart progress value placement schema"}setColumnMiniChartShowDataPoints
Section titled “setColumnMiniChartShowDataPoints”Mini chart show data points
Show or hide mini chart data points
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "showDataPoints": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart show data points schema"}setColumnMiniChartUseSameStartDate
Section titled “setColumnMiniChartUseSameStartDate”Mini chart use same start date
Use same start date for mini charts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "useSameStartDate": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Mini chart use same start date schema"}setColumnNegativeType
Section titled “setColumnNegativeType”Column negative type
Set negative number style for a measure, calculated, or conditional calculated column by exact name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Exact column name" }, "negativeType": { "type": "string", "enum": ["symbol", "parenthesis"] } }, "required": ["name", "negativeType"], "additionalProperties": false, "title": "Column negative type schema"}setColumnProgressDynamicScaleEnabled
Section titled “setColumnProgressDynamicScaleEnabled”Progress dynamic scale
Enable or disable progress dynamic scale
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "dynamicScaleEnabled": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Progress dynamic scale schema"}setColumnProgressStartingValue
Section titled “setColumnProgressStartingValue”Progress starting value
Set progress starting value
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "startingValue": { "type": "number" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Progress starting value schema"}setColumnProgressTargetValue
Section titled “setColumnProgressTargetValue”Progress target value
Set progress target value
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "targetValue": { "type": "number" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Progress target value schema"}setColumnRepresentation
Section titled “setColumnRepresentation”Column representation
Change column visual representation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "representation": { "anyOf": [ { "type": "string", "enum": ["text", "html", "markdown", "image", "url", "legacy-button"] }, { "type": "string", "enum": ["text", "image", "indicator", "bar-chart", "line-chart", "progress"] } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "representation"], "additionalProperties": false, "title": "Column representation schema"}setColumnResponsiveWidth
Section titled “setColumnResponsiveWidth”Column responsive width
Enable column responsive width
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "responsiveWidth": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column responsive width schema"}setColumnShowNullValues
Section titled “setColumnShowNullValues”Show null values
Show or hide null values for a column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "showNullValues": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Show null values schema"}setColumnSortIconBehavior
Section titled “setColumnSortIconBehavior”Column sort icon
Set sort icon behavior for a column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "sortIconBehavior": { "type": "string", "enum": ["active", "always", "onHover", "hide"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column sort icon schema"}setColumnTemporalGrouping
Section titled “setColumnTemporalGrouping”Column temporal grouping
Set the temporal grouping of a date dimension column. Use mode “level” with dateLevel for year-aware buckets such as month-over-time, mode “part” with datePart for date parts such as month-of-year, or mode “none” to clear temporal grouping.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "mode": { "type": "string", "const": "none" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode"], "additionalProperties": false }, { "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "mode": { "type": "string", "const": "level" }, "dateLevel": { "type": "string", "enum": [ "year", "year-end", "quarter", "quarter-end", "month", "month-end", "week", "week-end", "day", "hour", "minute", "second" ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "dateLevel"], "additionalProperties": false }, { "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "mode": { "type": "string", "const": "part" }, "datePart": { "type": "string", "enum": [ "year", "month", "day", "dayofweekiso", "dayofyear", "weekiso", "quarter", "yearofweekiso", "hour", "minute", "second" ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "datePart"], "additionalProperties": false } ], "title": "Column temporal grouping schema"}setColumnVerticalAlign
Section titled “setColumnVerticalAlign”Column vertical align
Set column vertical alignment
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "verticalAlign": { "type": "string", "enum": ["auto", "top", "middle", "bottom"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column vertical align schema"}setColumnWidth
Section titled “setColumnWidth”Column width
Set column width
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "width": { "description": "Width of the column in pixels. Must end with \"px\"", "type": "string", "pattern": "^\\d+(\\.\\d+)?px$" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Column width schema"}setColumnWritebackKey
Section titled “setColumnWritebackKey”Writeback key
Toggle writeback key column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "isWritebackKey": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Writeback key schema"}setCustomNullValue
Section titled “setCustomNullValue”Custom null value
Set custom null value text
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "type": "null" } ], "title": "Custom null value schema"}setExportLimit
Section titled “setExportLimit”Export limit
Set export result limit
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Export limit schema", "type": ["number", "null"]}setExportWithMetadataCreatedBy
Section titled “setExportWithMetadataCreatedBy”Include created by in metadata
Include or exclude created by field in metadata export
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Export with metadata created by schema", "type": "boolean"}setExportWithMetadataCreatedDate
Section titled “setExportWithMetadataCreatedDate”Include created date in metadata
Include or exclude created date field in metadata export
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Export with metadata created date schema", "type": "boolean"}setExportWithMetadataCustomInputEnabled
Section titled “setExportWithMetadataCustomInputEnabled”Custom metadata input enabled
Set custom metadata input enabled state
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Export with metadata custom input enabled schema"}setExportWithMetadataCustomInputName
Section titled “setExportWithMetadataCustomInputName”Custom metadata input name
Set custom metadata input name text
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "type": "null" } ], "title": "Export with metadata custom input name schema"}setExportWithMetadataCustomInputValue
Section titled “setExportWithMetadataCustomInputValue”Custom metadata input value
Set custom metadata input value text
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "type": "null" } ], "title": "Export with metadata custom input value schema"}setExportWithMetadataEnabled
Section titled “setExportWithMetadataEnabled”Enable metadata in export
Enable or disable metadata in export
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Export with metadata enabled schema"}setExportWithMetadataFooter
Section titled “setExportWithMetadataFooter”Include footer in metadata
Include or exclude footer field in metadata export
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Export with metadata footer schema", "type": "boolean"}setExportWithMetadataSemanticLayer
Section titled “setExportWithMetadataSemanticLayer”Include semantic layer in metadata
Include or exclude semantic layer field in metadata export
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Export with metadata semantic layer schema", "type": "boolean"}setExportWithMetadataSqlQuery
Section titled “setExportWithMetadataSqlQuery”Include SQL query in metadata
Include or exclude SQL query field in metadata export
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Export with metadata SQL query schema", "type": "boolean"}setExportWithMetadataSubtitle
Section titled “setExportWithMetadataSubtitle”Include subtitle in metadata
Include or exclude subtitle field in metadata export
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Export with metadata subtitle schema", "type": "boolean"}setExportWithMetadataTitle
Section titled “setExportWithMetadataTitle”Include title in metadata
Include or exclude title field in metadata export
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Export with metadata title schema", "type": "boolean"}setHideZeroValues
Section titled “setHideZeroValues”Hide zero values
Hide or show zero values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Hide zero values schema", "type": "boolean"}setMeasureAdvancedAdditionalAggregation
Section titled “setMeasureAdvancedAdditionalAggregation”Advanced additional aggregation
Set additional aggregation used by nested ratio advanced calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "additionalAggregation": { "type": "string", "enum": ["SUM", "AVG", "MIN", "MAX"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "additionalAggregation"], "additionalProperties": false, "title": "Measure advanced additional aggregation schema"}setMeasureAdvancedAggregation
Section titled “setMeasureAdvancedAggregation”Advanced aggregation
Set aggregation used by advanced calculation for a measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "aggregation": { "type": "string", "enum": ["SUM", "AVG", "MIN", "MAX", "PERCENTILE", "OUTLIERS", "CONTROL_VALUE"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"], "additionalProperties": false, "title": "Measure advanced aggregation schema"}setMeasureAdvancedCalculationType
Section titled “setMeasureAdvancedCalculationType”Advanced calculation type
Set advanced calculation type for a measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "advancedCalculationType": { "type": "string", "enum": [ "none", "movingCalculation", "runningTotal", "runningRate", "accumulatedGrowth", "rank", "total", "shareTotal", "nestedCalculation", "nestedRatio", "nestedCorrelation", "value", "diff", "ratio", "growth", "apg", "cagr", "periodOverCorrelation", "udf", "customUdf" ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "advancedCalculationType"], "additionalProperties": false, "title": "Measure advanced calculation type schema"}setMeasureAdvancedCompareMeasure
Section titled “setMeasureAdvancedCompareMeasure”Advanced compare measure
Set compare measure used by accumulated growth or nested correlation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "key": { "type": "string", "description": "Engine key of the compare measure field" }, "aggregation": { "type": "string", "enum": ["SUM", "AVG", "MIN", "MAX", "PERCENTILE", "OUTLIERS", "CONTROL_VALUE"] }, "parameters": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "value": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "anyOf": [ { "type": "boolean" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } ] }, "dataType": { "type": "string", "enum": [ "string", "int", "float", "boolean", "date", "millisec", "millisec_tz", "timestamp", "timestamp_tz" ] } }, "required": ["value"], "additionalProperties": false } }, { "type": "null" } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key", "aggregation"], "additionalProperties": false, "title": "Set measure advanced compare measure schema"}setMeasureAdvancedComparisonType
Section titled “setMeasureAdvancedComparisonType”Advanced comparison type
Set comparison type for period-over-correlation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "comparisonType": { "type": "string", "enum": ["absolute", "percentage", "naturalLog"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "comparisonType"], "additionalProperties": false, "title": "Measure advanced comparison type schema"}setMeasureAdvancedDense
Section titled “setMeasureAdvancedDense”Advanced dense rank
Enable or disable dense rank
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "dense": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "dense"], "additionalProperties": false, "title": "Measure advanced dense schema"}setMeasureAdvancedDimensionsIds
Section titled “setMeasureAdvancedDimensionsIds”Advanced dimensions
Set dimensions used by advanced calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "dimensionsIds": { "type": "array", "items": { "type": "string" } } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "dimensionsIds"], "additionalProperties": false, "title": "Measure advanced dimensions schema"}setMeasureAdvancedGroupType
Section titled “setMeasureAdvancedGroupType”Advanced group type
Set comparison group type for share total advanced calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "groupType": { "type": "string", "enum": ["value", "diff", "ratio", "growth"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "groupType"], "additionalProperties": false, "title": "Measure advanced group type schema"}setMeasureAdvancedNonTimePeriod
Section titled “setMeasureAdvancedNonTimePeriod”Advanced nested time dimension
Enable or disable nested time dimension
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "nonTimePeriod": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nonTimePeriod"], "additionalProperties": false, "title": "Measure advanced nested time dimension schema"}setMeasureAdvancedNonTimePeriodGranularity
Section titled “setMeasureAdvancedNonTimePeriodGranularity”Advanced non-time period granularity
Set non-time period granularity for inter-record calculations
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "nonTimePeriodGranularity": { "type": "string", "enum": ["day", "week", "month", "quarter", "year"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nonTimePeriodGranularity"], "additionalProperties": false, "title": "Measure advanced non-time period granularity schema"}setMeasureAdvancedNullIfNotEnoughValues
Section titled “setMeasureAdvancedNullIfNotEnoughValues”Advanced null if not enough values
Enable or disable null-if-not-enough-values for moving calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "nullIfNotEnoughValues": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nullIfNotEnoughValues"], "additionalProperties": false, "title": "Measure advanced null if not enough values schema"}setMeasureAdvancedOffset
Section titled “setMeasureAdvancedOffset”Advanced compare with period offset
Set compare-with-period offset for advanced calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "offset": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "offset"], "additionalProperties": false, "title": "Measure advanced offset schema"}setMeasureAdvancedParameter
Section titled “setMeasureAdvancedParameter”Advanced parameter
Set value for advanced operation parameter
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "variableName": { "type": "string", "description": "Name of advanced operation parameter to update" }, "value": { "type": "object", "properties": { "value": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "anyOf": [ { "type": "boolean" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } ] }, "dataType": { "type": "string", "enum": ["string", "int", "float", "boolean", "date", "millisec", "millisec_tz", "timestamp", "timestamp_tz"] } }, "required": ["value"], "additionalProperties": false } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "variableName", "value"], "additionalProperties": false, "title": "Set measure advanced parameter schema"}setMeasureAdvancedPercentileApprox
Section titled “setMeasureAdvancedPercentileApprox”Advanced percentile approx
Enable or disable approximate percentile mode
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "percentileApprox": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileApprox"], "additionalProperties": false, "title": "Measure advanced percentile approx schema"}setMeasureAdvancedPercentileContinuous
Section titled “setMeasureAdvancedPercentileContinuous”Advanced percentile continuous
Enable or disable continuous percentile mode
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "percentileContinuous": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileContinuous"], "additionalProperties": false, "title": "Measure advanced percentile continuous schema"}setMeasureAdvancedPercentileValue
Section titled “setMeasureAdvancedPercentileValue”Advanced percentile value
Set percentile value for percentile aggregation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "percentileValue": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileValue"], "additionalProperties": false, "title": "Measure advanced percentile value schema"}setMeasureAdvancedPeriodsPerYear
Section titled “setMeasureAdvancedPeriodsPerYear”Advanced periods per year
Set number of periods in a year for annualized period growth
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "periodsPerYear": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "periodsPerYear"], "additionalProperties": false, "title": "Measure advanced periods per year schema"}setMeasureAdvancedRangesComparisonEnabled
Section titled “setMeasureAdvancedRangesComparisonEnabled”Advanced ranges comparison enabled
Enable or disable ranges comparison
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "enabled": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"], "additionalProperties": false, "title": "Measure advanced ranges comparison enabled schema"}setMeasureAdvancedRangesComparisonFirstRangeEnd
Section titled “setMeasureAdvancedRangesComparisonFirstRangeEnd”Advanced ranges first range end
Set first range end for ranges comparison
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "firstRangeEnd": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "firstRangeEnd"], "additionalProperties": false, "title": "Measure advanced ranges first range end schema"}setMeasureAdvancedRangesComparisonFirstRangeStart
Section titled “setMeasureAdvancedRangesComparisonFirstRangeStart”Advanced ranges first range start
Set first range start for ranges comparison
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "firstRangeStart": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "firstRangeStart"], "additionalProperties": false, "title": "Measure advanced ranges first range start schema"}setMeasureAdvancedRangesComparisonSecondRangeEnd
Section titled “setMeasureAdvancedRangesComparisonSecondRangeEnd”Advanced ranges second range end
Set second range end for ranges comparison
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "secondRangeEnd": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondRangeEnd"], "additionalProperties": false, "title": "Measure advanced ranges second range end schema"}setMeasureAdvancedRangesComparisonSecondRangeStart
Section titled “setMeasureAdvancedRangesComparisonSecondRangeStart”Advanced ranges second range start
Set second range start for ranges comparison
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "secondRangeStart": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondRangeStart"], "additionalProperties": false, "title": "Measure advanced ranges second range start schema"}setMeasureAdvancedRangesComparisonType
Section titled “setMeasureAdvancedRangesComparisonType”Advanced ranges comparison type
Set ranges comparison type
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "type": { "type": "string", "enum": ["absolute", "percentage"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "type"], "additionalProperties": false, "title": "Measure advanced ranges comparison type schema"}setMeasureAdvancedRankSortDirection
Section titled “setMeasureAdvancedRankSortDirection”Advanced rank sort direction
Set rank sort direction for rank advanced calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "rankSortDirection": { "type": "string", "enum": ["asc", "desc"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "rankSortDirection"], "additionalProperties": false, "title": "Measure advanced rank sort direction schema"}setMeasureAdvancedSortingOrder
Section titled “setMeasureAdvancedSortingOrder”Advanced sorting order
Set sorting order used by advanced calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "sortingOrder": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sortDirection": { "type": "string", "enum": ["asc", "desc"] } }, "required": ["id", "sortDirection"], "additionalProperties": false } } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "sortingOrder"], "additionalProperties": false, "title": "Measure advanced sorting order schema"}setMeasureAdvancedStandardDeviations
Section titled “setMeasureAdvancedStandardDeviations”Advanced standard deviations
Set standard deviations for outliers aggregation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "standardDeviations": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "standardDeviations"], "additionalProperties": false, "title": "Measure advanced standard deviations schema"}setMeasureAdvancedWindowBegin
Section titled “setMeasureAdvancedWindowBegin”Advanced periods before
Set periods before for moving calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "windowBegin": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "windowBegin"], "additionalProperties": false, "title": "Measure advanced window begin schema"}setMeasureAdvancedWindowEnd
Section titled “setMeasureAdvancedWindowEnd”Advanced periods after
Set periods after for moving calculation
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection key", "type": "string", "enum": ["measures", "supportingMeasures"] }, "advancedOperationKey": { "description": "Advanced operation key", "type": "string", "enum": ["advancedCalculation", "nestedCalculation"] }, "windowEnd": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "windowEnd"], "additionalProperties": false, "title": "Measure advanced window end schema"}setMeasureDefinedParameter
Section titled “setMeasureDefinedParameter”Measure defined parameter
Configure a Defined parameter of a custom measure using its default, a static value, or an existing compatible workbook variable
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection to update. Defaults to primary measures.", "type": "string", "enum": ["measures", "supportingMeasures"] }, "parameterName": { "type": "string", "minLength": 1, "description": "Exact name of a Defined parameter exposed by the measure" }, "value": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "default" } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "static" }, "value": { "type": ["string", "number", "boolean"] } }, "required": ["type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string", "minLength": 1, "description": "Exact name of an existing compatible workbook variable" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"], "additionalProperties": false, "title": "Set measure defined parameter schema"}setMeasureFilter
Section titled “setMeasureFilter”Set measure filter
Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "contains", "excludes", "like", "notLike", "startsWith", "endsWith" ], "description": "Filter operator that requires a value" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Filter value" } }, "required": ["measureName", "fieldKey", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["isBetween", "isNotBetween"], "description": "Filter operator that requires valueFrom and valueTo" }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Lower filter value" }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Upper filter value" } }, "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["inList", "excludedFromList"], "description": "Filter operator that requires a list of values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Filter values" } }, "required": ["measureName", "fieldKey", "operator", "values"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["isNull", "notNull"], "description": "Filter operator that does not require values" } }, "required": ["measureName", "fieldKey", "operator"], "additionalProperties": false } ], "description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.", "title": "Set measure filter schema"}setOthersPosition
Section titled “setOthersPosition”Top N others position
Set position of “Others” bucket
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Position of \"Others\" item - first (at the beginning), last (at the end) or default (let engine decide)", "title": "Others position schema", "type": "string", "enum": ["default", "first", "last"]}setQueryLimit
Section titled “setQueryLimit”Query limit
Set query result limit
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Query limit schema", "type": ["number", "null"]}setQueryTimeout
Section titled “setQueryTimeout”Query timeout
Set query timeout value in seconds
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Query timeout schema", "anyOf": [ { "type": "number", "minimum": 120, "maximum": 600 }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ]}setResultFilter
Section titled “setResultFilter”Set result filter
Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "contains", "excludes", "like", "notLike", "startsWith", "endsWith" ], "description": "Filter operator that requires a value" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Filter value" } }, "required": ["measureName", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["isBetween", "isNotBetween"], "description": "Filter operator that requires valueFrom and valueTo" }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Lower filter value" }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Upper filter value" } }, "required": ["measureName", "operator", "valueFrom", "valueTo"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["inList", "excludedFromList"], "description": "Filter operator that requires a list of values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Filter values" } }, "required": ["measureName", "operator", "values"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["isNull", "notNull"], "description": "Filter operator that does not require values" } }, "required": ["measureName", "operator"], "additionalProperties": false } ], "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.", "title": "Set result filter schema"}setSortingDirection
Section titled “setSortingDirection”Sorting direction
Set sorting direction for all matching sortable items by name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "sortDirection": { "type": "string", "enum": ["ascending", "descending"] } }, "required": ["name", "sortDirection"], "additionalProperties": false, "title": "Sorting direction by name schema"}setSortingEnabled
Section titled “setSortingEnabled”Sorting enabled
Enable or disable sorting for all matching sortable items by name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" } }, "required": ["name"], "additionalProperties": false, "title": "Sorting enabled by name schema"}setStaticFilterGroup
Section titled “setStaticFilterGroup”Set static filter group
Replace all static filters with a nested AND/OR filter group.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Replace all static filters with this nested AND/OR filter group.", "title": "Set static filter group schema", "$ref": "#/$defs/__schema0", "$defs": { "__schema0": { "type": "object", "properties": { "operator": { "type": "string", "enum": ["and", "or"] }, "filters": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "anyOf": [ { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "isBetween", "isNotBetween", "isNull", "notNull", "contains", "excludes", "like", "notLike", "startsWith", "endsWith", "predefined_date_range", "previous", "current", "before", "after", "inList", "excludedFromList", "divider" ] }, { "type": "string", "enum": [ "ytd", "mtd", "qtd", "wtd", "pytd", "pmtd", "pqtd", "pwtd", "l12m", "l90d", "l30d", "l7d", "cy", "cq", "cm", "py", "pm", "pq", "pw", "today", "yesterday", "mindate", "maxdate" ] } ] }, "values": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "secondValue": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "additionalProperties": false }, "dateFilter": { "anyOf": [ { "type": "string", "enum": [ "ytd", "mtd", "qtd", "wtd", "pytd", "pmtd", "pqtd", "pwtd", "l12m", "l90d", "l30d", "l7d", "cy", "cq", "cm", "py", "pm", "pq", "pw", "today", "yesterday", "mindate", "maxdate" ] }, { "type": "null" } ] } }, "required": ["fieldKey", "operator", "values"], "additionalProperties": false }, { "$ref": "#/$defs/__schema0" } ] } } }, "required": ["operator", "filters"], "additionalProperties": false } }}setSupportingMeasureEnabled
Section titled “setSupportingMeasureEnabled”Supporting measure enabled
Enable or disable all matching supporting measures by name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" } }, "required": ["name", "enabled"], "additionalProperties": false, "title": "Supporting measure enabled by name schema"}setTableAllColumnsBackgroundColor
Section titled “setTableAllColumnsBackgroundColor”All columns background color
Set background color for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "All columns background color schema"}setTableAllColumnsBorder
Section titled “setTableAllColumnsBorder”All columns border
Set border style for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "All columns border schema", "type": "string", "enum": ["auto", "showHorizontal", "showVertical", "showAll", "noBorders"]}setTableAllColumnsDrillThroughIconBehavior
Section titled “setTableAllColumnsDrillThroughIconBehavior”All columns drill-through icon
Set drill-through icon behavior for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "All columns drill-through icon schema", "type": "string", "enum": ["always", "onHover", "hide"]}setTableAllColumnsFilterIconBehavior
Section titled “setTableAllColumnsFilterIconBehavior”All columns filter icon
Set filter icon behavior for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "All columns filter icon schema", "type": "string", "enum": ["active", "always", "onHover", "hide"]}setTableAllColumnsFontColor
Section titled “setTableAllColumnsFontColor”All columns font color
Set font color for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "All columns font color schema"}setTableAllColumnsFontStyle
Section titled “setTableAllColumnsFontStyle”All columns font style
Update font style for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "All columns font style schema", "type": "object", "properties": { "weight": { "description": "Font weight", "type": ["number", "null"] }, "bold": { "description": "Bold font. Should take precedence over weight", "type": "boolean" }, "italic": { "type": "boolean" }, "underline": { "type": "boolean" }, "strikethrough": { "type": "boolean" } }, "additionalProperties": false}setTableAllColumnsFreezeIconBehavior
Section titled “setTableAllColumnsFreezeIconBehavior”All columns freeze icon
Set freeze icon behavior for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "All columns freeze icon schema", "type": "string", "enum": ["always", "onHover", "hide"]}setTableAllColumnsHorizontalAlign
Section titled “setTableAllColumnsHorizontalAlign”All columns horizontal align
Set horizontal alignment for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "All columns horizontal align schema", "type": "string", "enum": ["auto", "left", "center", "right"]}setTableAllColumnsResponsiveWidth
Section titled “setTableAllColumnsResponsiveWidth”All columns responsive width
Enable responsive width for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "All columns responsive width schema", "type": "boolean"}setTableAllColumnsSortIconBehavior
Section titled “setTableAllColumnsSortIconBehavior”All columns sort icon
Set sort icon behavior for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "All columns sort icon schema", "type": "string", "enum": ["active", "always", "onHover", "hide"]}setTableAllColumnsVerticalAlign
Section titled “setTableAllColumnsVerticalAlign”All columns vertical align
Set vertical alignment for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "All columns vertical align schema", "type": "string", "enum": ["auto", "top", "middle", "bottom"]}setTableAllColumnsWidth
Section titled “setTableAllColumnsWidth”All columns width
Set minimum width for all columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "All columns width schema", "type": "number"}setTableAlwaysFullyExpanded
Section titled “setTableAlwaysFullyExpanded”Always fully expanded
Always expand hierarchical tables
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Always fully expanded schema", "type": "boolean"}setTableBackgroundColor
Section titled “setTableBackgroundColor”Background color
Set the table background color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Table background color schema"}setTableBackgroundType
Section titled “setTableBackgroundType”Background type
Set the table background mode
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["single", "zebra", "none"], "title": "Table background type schema"}setTableBodyFontFamily
Section titled “setTableBodyFontFamily”Body font family
Set the body font family
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Body font family", "type": ["string", "null"]}setTableBodyFontSize
Section titled “setTableBodyFontSize”Body font size
Set the body font size
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Body font size", "type": "number"}setTableBorderColor
Section titled “setTableBorderColor”Table border color
Set the table border color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Border color schema"}setTableBorderEnabled
Section titled “setTableBorderEnabled”Table border enabled
Enable or disable the table border
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Border enabled schema", "type": "boolean"}setTableBorderLineStyle
Section titled “setTableBorderLineStyle”Table border line style
Set the table border line style
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Border line style schema", "type": "string", "enum": ["line", "dashed", "dotted"]}setTableBorderRadius
Section titled “setTableBorderRadius”Table border radius
Set the table border radius
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Border radius schema", "type": "number"}setTableBorderStrokeWidth
Section titled “setTableBorderStrokeWidth”Table border width
Set the table border width
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Border stroke width schema", "type": "number"}setTableColumnBorderColor
Section titled “setTableColumnBorderColor”Divider line color
Set divider line color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Column border color schema"}setTableColumnBorders
Section titled “setTableColumnBorders”Divider lines
Control divider line visibility
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Column borders schema", "type": "string", "enum": ["auto", "showHorizontal", "showVertical", "showAll", "noBorders"]}setTableColumnWidthBehavior
Section titled “setTableColumnWidthBehavior”Column width behavior
Change how column widths are calculated
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Column width behavior schema", "type": "string", "enum": ["static", "responsive"]}setTableDataStructure
Section titled “setTableDataStructure”Table type
Change the table type (straight, expandable, pivot)
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["normal", "hierarchical", "pivot"], "title": "Table data structure schema"}setTableDimensionColumn
Section titled “setTableDimensionColumn”Dimension column mode
Set dimension column rendering mode
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Dimension column mode schema", "type": "string", "enum": ["merge", "no-repeat", "repeat"]}setTableDisableInteractiveSorting
Section titled “setTableDisableInteractiveSorting”Disable interactive sorting
Enable or disable header click sorting
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Disable interactive sorting schema", "type": "boolean"}setTableEvenBackgroundColor
Section titled “setTableEvenBackgroundColor”Even row background color
Set the even row background color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Even row background color schema"}setTableFixedRowHeightEnabled
Section titled “setTableFixedRowHeightEnabled”Fixed row height enabled
Enable or disable fixed row height
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Fixed row height enabled schema", "type": "boolean"}setTableFixedRowHeightValue
Section titled “setTableFixedRowHeightValue”Fixed row height
Set fixed row height value
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Fixed row height schema", "type": "number"}setTableFreezeColumnsNumber
Section titled “setTableFreezeColumnsNumber”Freeze columns number
Set number of frozen columns
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "type": "null" } ], "title": "Freeze columns number schema"}setTableHeaderAsChip
Section titled “setTableHeaderAsChip”Header as chip
Render header as chips
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Header as chip schema", "type": "boolean"}setTableHeaderBackgroundColor
Section titled “setTableHeaderBackgroundColor”Header background color
Set the header background color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Header background color schema"}setTableHeaderBorderColor
Section titled “setTableHeaderBorderColor”Header border color
Set the header border color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Header border color schema"}setTableHeaderFontColor
Section titled “setTableHeaderFontColor”Header text color
Set the header text color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Header font color schema"}setTableHeaderFontFamily
Section titled “setTableHeaderFontFamily”Header font family
Set the header font family
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Header font family", "type": ["string", "null"]}setTableHeaderFontSize
Section titled “setTableHeaderFontSize”Header font size
Set the header font size
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Header font size", "type": "number"}setTableHeaderFontStyle
Section titled “setTableHeaderFontStyle”Header font style
Update the header font style
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Header font style", "type": "object", "properties": { "weight": { "description": "Font weight", "type": ["number", "null"] }, "bold": { "description": "Bold font. Should take precedence over weight", "type": "boolean" }, "italic": { "type": "boolean" }, "underline": { "type": "boolean" }, "strikethrough": { "type": "boolean" } }, "additionalProperties": false}setTableHeaderHidden
Section titled “setTableHeaderHidden”Header hidden
Show or hide the header row
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Header hidden schema", "type": "boolean"}setTableHeaderResponsiveHeight
Section titled “setTableHeaderResponsiveHeight”Header responsive height
Enable responsive header height
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Header responsive height schema", "type": "boolean"}setTableHierarchicalMeasureSortItem
Section titled “setTableHierarchicalMeasureSortItem”Hierarchical measure sort
Set pivot/hierarchical measure sorting
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "sortDirection": { "type": "string", "enum": ["asc", "desc"] }, "applyTo": { "type": "string", "enum": ["rows", "rows-and-columns"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "sortDirection"], "additionalProperties": false, "title": "Hierarchical measure sort schema"}setTableHierarchicalMeasureSortItemByName
Section titled “setTableHierarchicalMeasureSortItemByName”Sort by measure
Set hierarchical measure sort item
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "measureName": { "type": "string" }, "sortDirection": { "type": "string", "enum": ["ascending", "descending"] }, "applyTo": { "type": "string", "enum": ["rows", "rows-and-columns"] } }, "required": ["measureName", "sortDirection", "applyTo"], "additionalProperties": false, "title": "Sort by measure"}setTableHighlightBackgroundColor
Section titled “setTableHighlightBackgroundColor”Highlight background color
Set the highlight background color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Highlight background color schema"}setTableHighlightMode
Section titled “setTableHighlightMode”Highlight mode
Set the hover highlight mode
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["column", "none", "row", "row-and-column"], "title": "Highlight mode schema"}setTableHighlightTextColor
Section titled “setTableHighlightTextColor”Highlight text color
Set the highlight text color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Highlight text color schema"}setTableIndexColumnLabel
Section titled “setTableIndexColumnLabel”Index column label
Set index column label
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Index column label schema", "type": "string"}setTableIndexColumnWidth
Section titled “setTableIndexColumnWidth”Index column width
Set index column width
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Index column width schema", "type": "number", "minimum": 20, "maximum": 200}setTableMaxLines
Section titled “setTableMaxLines”Max lines
Set maximum number of lines per cell
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Max lines schema", "type": "number"}setTableMeasuresLabel
Section titled “setTableMeasuresLabel”Measures label
Set the heading of the measure-name column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Measures label schema"}setTableMeasuresPosition
Section titled “setTableMeasuresPosition”Measures position
Set where measures are placed in the table
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Measures position schema", "type": "string", "enum": ["column", "row"]}setTableMergedCells
Section titled “setTableMergedCells”Merged cells
Enable or disable merged cells
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Merged cells schema", "type": "boolean"}setTableMinAutoColumnWidth
Section titled “setTableMinAutoColumnWidth”Min auto column width
Set the minimum auto column width
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Min auto column width schema", "type": "number"}setTableOddBackgroundColor
Section titled “setTableOddBackgroundColor”Odd row background color
Set the odd row background color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Odd row background color schema"}setTableResponsiveRowHeight
Section titled “setTableResponsiveRowHeight”Responsive row height
Enable or disable responsive row height
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Responsive row height schema", "type": "boolean"}setTableShowIndexColumn
Section titled “setTableShowIndexColumn”Show index column
Show or hide the index column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Show index column schema", "type": "boolean"}setTableShowOnlyAvailableValuesInFilter
Section titled “setTableShowOnlyAvailableValuesInFilter”Show only available values in filter
Show only values available in the table header filter
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Show only available values in filter schema", "type": "boolean"}setTableSortByMeasure
Section titled “setTableSortByMeasure”Sort by measure enabled
Enable or disable sorting by measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Sort by measure enabled schema", "type": "boolean"}setTableStickyColumnMinWidth
Section titled “setTableStickyColumnMinWidth”Sticky column min width
Set sticky column minimum width
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "number", "title": "Sticky column min width schema"}setTableStickyColumnResponsiveWidth
Section titled “setTableStickyColumnResponsiveWidth”Sticky column responsive width
Enable sticky column responsive width
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Sticky column responsive width schema", "type": "boolean"}setTableTotalsApplyTo
Section titled “setTableTotalsApplyTo”Totals apply to
Set which values totals apply to
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Totals apply to schema", "type": "string", "enum": ["rows", "columns", "both"]}setTableTotalsBackgroundColor
Section titled “setTableTotalsBackgroundColor”Totals background color
Set totals row background color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Totals background color schema"}setTableTotalsEnabled
Section titled “setTableTotalsEnabled”Totals enabled
Enable or disable totals row
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Totals enabled schema", "type": "boolean"}setTableTotalsFontColor
Section titled “setTableTotalsFontColor”Totals font color
Set totals row font color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Totals font color schema"}setTableTotalsFontStyle
Section titled “setTableTotalsFontStyle”Totals font style
Update totals row font style
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "weight": { "description": "Font weight", "type": ["number", "null"] }, "bold": { "description": "Bold font. Should take precedence over weight", "type": "boolean" }, "italic": { "type": "boolean" }, "underline": { "type": "boolean" }, "strikethrough": { "type": "boolean" } }, "additionalProperties": false, "title": "Totals font style schema"}setTableTotalsPosition
Section titled “setTableTotalsPosition”Totals position
Set totals row position
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["top", "bottom"], "title": "Totals position schema"}setTableTotalsResponsiveHeight
Section titled “setTableTotalsResponsiveHeight”Totals responsive height
Enable responsive totals row height
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Totals responsive height schema", "type": "boolean"}setTableTotalsShowRecordsCount
Section titled “setTableTotalsShowRecordsCount”Totals show records count
Show or hide records count in totals
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Totals show records count schema", "type": "boolean"}setTableWordWrap
Section titled “setTableWordWrap”Word wrap
Enable or disable body word wrap
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Word wrap schema", "type": "boolean"}setTableWordWrapHeader
Section titled “setTableWordWrapHeader”Word wrap header
Enable or disable header word wrap
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Word wrap header schema", "type": "boolean"}setTableWritebackMode
Section titled “setTableWritebackMode”Writeback mode
Set writeback mode
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Writeback mode schema", "type": "string", "enum": ["row", "rows", "cell"]}setTopNDimension
Section titled “setTopNDimension”Top N dimension
Choose which dimension the Top N limit applies to. Pass null to use all dimensions. By default, the last dimension is ranked within each combination of preceding dimensions.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "label": { "type": "string" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "description": "The dimension to rank by" }, { "type": "object", "properties": {}, "additionalProperties": false } ] }, { "type": "null" } ], "title": "Set top N dimension schema"}setTopNNumberOfValues
Section titled “setTopNNumberOfValues”Top N number of values
Set number of values in Top N
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Top N number of values", "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ]}setTopNOthersLabel
Section titled “setTopNOthersLabel”Top N others label
Set label for “Others” bucket
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "stringLabel": { "type": "string" } }, "additionalProperties": false, "title": "Top N others label schema"}setTopNRankEachDimensionIndividually
Section titled “setTopNRankEachDimensionIndividually”Rank each dimension individually
Set whether Top N ranks each dimension independently when all dimensions are used. Pass true to enable or false to disable. Does not change the selected ranking dimension or enable Top N.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Set top N rank each dimension individually schema"}setTopNShowOthers
Section titled “setTopNShowOthers”Top N show others
Show or hide “Others” bucket
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Group other values into one \"Others\" item", "title": "Top N show others schema", "type": "boolean"}setTopNSortOrder
Section titled “setTopNSortOrder”Top N sort order
Set Top N sort order
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Sort order (ascending or descending) to determine whether to show top or bottom N values", "title": "Top N sort order schema", "type": "string", "enum": ["asc", "desc"]}toggleColumn
Section titled “toggleColumn”Toggle column
Enable or disable a column in the table
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "enabled": { "type": "boolean", "description": "Whether the column should be enabled or disabled" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"], "additionalProperties": false, "title": "Toggle column schema"}toggleColumnByName
Section titled “toggleColumnByName”Toggle column by name
Enable, disable, or toggle a table column by its name.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string" }, "operation": { "default": "toggle", "type": "string", "enum": ["enable", "disable", "toggle"] } }, "required": ["name", "operation"], "additionalProperties": false, "title": "Toggle table column by name payload schema"}toggleSortingItem
Section titled “toggleSortingItem”Toggle sorting item
Enable or disable sorting for a field
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the sorting item" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the sorting item" }, "enabled": { "type": "boolean", "description": "Whether sorting should be enabled for the item" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"], "additionalProperties": false, "title": "Toggle sorting item schema"}toggleSupportingMeasure
Section titled “toggleSupportingMeasure”Toggle supporting measure
Enable or disable a supporting measure in the table
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be toggled" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be toggled" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Toggle supporting measure schema"}updateCalculatedColumn
Section titled “updateCalculatedColumn”Update calculated column
Update the operands or operator of a calculated column by its name.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "calculatedColumnName": { "type": "string" }, "firstColumnName": { "type": "string" }, "operator": { "type": "string", "enum": ["add", "subtract", "multiply", "divide", "growth"] }, "secondColumnName": { "type": "string" } }, "required": ["calculatedColumnName"], "additionalProperties": false, "title": "Update calculated column payload schema"}updateColumn
Section titled “updateColumn”Update column
Modify properties of an existing column
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the column" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the column" }, "changes": { "type": "object", "properties": { "label": { "type": "string" }, "customLabel": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "string" } }, "required": ["enabled"], "additionalProperties": false }, "showNullValues": { "type": "boolean" } }, "additionalProperties": false } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"], "additionalProperties": false, "title": "Update column schema"}updateSupportingMeasure
Section titled “updateSupportingMeasure”Update supporting measure
Modify properties of an existing supporting measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "changes": { "type": "object", "properties": { "customLabel": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "string" } }, "required": ["enabled"], "additionalProperties": false } }, "required": ["customLabel"], "additionalProperties": false } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"], "additionalProperties": false, "title": "Update supporting measure schema"}