line 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”addColoringOverwriteaddDimensionaddMeasureaddMeasureAdvancedAdditionalDimensionDataFieldaddMeasureAdvancedDimensionDataFieldaddMeasureAxisBandaddMeasureFilteraddResultFilterchangeMeasureAggregationchangeMeasureAxischangeSortOrderAndDirectionclearMeasureFilterclearResultFilterduplicateDimensionduplicateMeasureenableCustomNullValueenableQueryTimeoutenableTooltipsenableTopNremoveColoringOverwriteremoveDimensionremoveMeasureremoveMeasureAdvancedAdditionalDimensionDataFieldremoveMeasureAdvancedCompareMeasureremoveMeasureAdvancedDimensionDataFieldremoveMeasureAxisBandremoveMeasureGraphColorresetChartPaletteToThemeDefaultsetAnimationEnabledsetAxisLabelColorsetAxisLineColorsetAxisRangeMaxsetAxisRangeMinsetAxisRangeOptionsetAxisScalesetAxisStartsAtZerosetAxisTickColorsetAxisTitlesetAxisTitleColorsetChartPalettesetColoringColorsetColoringOverwritessetColoringPersistentColorssetColoringSortOrdersetColoringTypesetCustomNullValuesetCustomPaletteColorssetDataGapsHandlingsetDimensionFormatStringsetDimensionFormatTypesetDimensionTemporalGroupingsetEnableContinuousAxissetEndLabelsBackdropsetEndLabelsPositionsetExportLimitsetHideZeroValuessetInvertAxissetLabelOverlapsetLegendEnabledsetLegendItemLabelFillsetLegendItemLabelFontSizesetLegendItemLabelLimitCharacterssetLegendItemLabelMaxGlyphCountsetLegendPositionsetLegendTitlesetLineChartTypesetLineTypesetMeasureAdvancedAdditionalAggregationsetMeasureAdvancedAggregationsetMeasureAdvancedCalculationTypesetMeasureAdvancedCompareMeasuresetMeasureAdvancedComparisonTypesetMeasureAdvancedDensesetMeasureAdvancedDimensionsIdssetMeasureAdvancedGroupTypesetMeasureAdvancedNonTimePeriodsetMeasureAdvancedNonTimePeriodGranularitysetMeasureAdvancedNullIfNotEnoughValuessetMeasureAdvancedOffsetsetMeasureAdvancedParametersetMeasureAdvancedPercentileApproxsetMeasureAdvancedPercentileContinuoussetMeasureAdvancedPercentileValuesetMeasureAdvancedPeriodsPerYearsetMeasureAdvancedRangesComparisonEnabledsetMeasureAdvancedRangesComparisonFirstRangeEndsetMeasureAdvancedRangesComparisonFirstRangeStartsetMeasureAdvancedRangesComparisonSecondRangeEndsetMeasureAdvancedRangesComparisonSecondRangeStartsetMeasureAdvancedRangesComparisonTypesetMeasureAdvancedRankSortDirectionsetMeasureAdvancedSortingOrdersetMeasureAdvancedStandardDeviationssetMeasureAdvancedWindowBeginsetMeasureAdvancedWindowEndsetMeasureAxisBandssetMeasureCurrencysetMeasureCurrencyIsPrefixsetMeasureDataLabelBackdropColorsetMeasureDataLabelDensitysetMeasureDataLabelFontSizesetMeasureDataLabelIsColoredsetMeasureDataLabelShowBackdropsetMeasureDataLabelsShowsetMeasureDataLabelTextColorsetMeasureDefinedParametersetMeasureFiltersetMeasureFormatStringsetMeasureFormatTypesetMeasureGraphColorsetMeasureLineSizesetMeasureLineStylesetMeasureNegativeTypesetMeasureShapesetMeasureShapeAdaptiveSizesetMeasureShapeMaxSizesetMeasureShapeMinSizesetOrientationsetOthersPositionsetQueryLimitsetQueryTimeoutsetResultFiltersetShowAxisLabelssetShowAxisLinesetShowAxisTickssetShowAxisTitlesetShowAxisTooltipsetShowEndLabelssetSortingDirectionsetSortingEnabledsetStaticFilterGroupsetSupportingMeasureEnabledsetTooltipsHideTotalsetTopNDimensionsetTopNNumberOfValuessetTopNOthersLabelsetTopNRankEachDimensionIndividuallysetTopNShowOtherssetTopNSortOrdertoggleDimensiontoggleMeasuretoggleSortingItemupdateDimensionupdateMeasure
addColoringOverwrite
Section titled “addColoringOverwrite”Add value color
Append one value color, eg. color the dimension value “Happy” dark teal. Value colors take priority over the coloring type and palette, so they apply whatever setColoringType is set to. An existing entry for the same dimension, operator and value is replaced. Earlier entries win when several match. Requires at least two enabled dimensions; with fewer, only removing value colors (including an empty list) is accepted.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "dimension": { "description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension", "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" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false }, "color": { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$", "description": "Color applied when the condition matches, eg. \"#0F766E\"" }, "operator": { "description": "How the dimension value is compared; defaults to equals. contains, startsWith and endsWith compare text, greater and less compare numbers", "type": "string", "enum": ["equals", "contains", "startsWith", "endsWith", "greater", "less", "greater-equals", "less-equals"] }, "value": { "description": "Value to compare against", "type": ["string", "number"] } }, "required": ["color", "value"], "additionalProperties": false }, { "type": "object", "properties": { "dimension": { "description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension", "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" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false }, "color": { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$", "description": "Color applied when the condition matches, eg. \"#0F766E\"" }, "operator": { "type": "string", "const": "between", "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)" }, "value": { "description": "Lower bound of the range", "type": ["string", "number"] }, "secondValue": { "description": "Upper bound of the range", "type": ["string", "number"] } }, "required": ["color", "operator", "value", "secondValue"], "additionalProperties": false }, { "type": "object", "properties": { "dimension": { "description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension", "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" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false }, "color": { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$", "description": "Color applied when the condition matches, eg. \"#0F766E\"" }, "operator": { "type": "string", "enum": ["inList", "notInList"], "description": "Match (inList) or exclude (notInList) every value in values" }, "values": { "minItems": 1, "type": "array", "items": { "type": ["string", "number"] }, "description": "Values to match" }, "delimiter": { "description": "Separator the values are stored with; defaults to \",\". No value may contain it", "type": "string", "minLength": 1 } }, "required": ["color", "operator", "values"], "additionalProperties": false } ], "title": "Add coloring overwrite schema"}addDimension
Section titled “addDimension”Add dimension
Add a new dimension to the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\"" } }, "required": ["key"], "additionalProperties": false, "title": "Add dimension schema"}addMeasure
Section titled “addMeasure”Add measure
Add a new measure to the chart
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 measure 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"}addMeasureAxisBand
Section titled “addMeasureAxisBand”Add measure axis band
Add a shaded band on the primary measure axis between two measure values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "start": { "type": "number", "description": "Measure axis value where the band starts" }, "end": { "type": "number", "description": "Measure axis value where the band ends" }, "color": { "description": "Band fill as #RRGGBB or #RRGGBBAA; defaults to a light grey when omitted", "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, "label": { "description": "Text drawn inside the band", "type": "string" } }, "required": ["start", "end"], "additionalProperties": false, "title": "Add measure axis band 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"}changeMeasureAggregation
Section titled “changeMeasureAggregation”Measure aggregation
Change how a 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 measure aggregation schema"}changeMeasureAxis
Section titled “changeMeasureAxis”Measure axis
Move a measure to the primary or the secondary measure axis
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" }, "secondaryAxis": { "type": "boolean", "description": "Whether the measure should be on the secondary axis" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondaryAxis"], "additionalProperties": false, "title": "Change measure axis schema"}changeSortOrderAndDirection
Section titled “changeSortOrderAndDirection”Sort order and direction
Change how 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"}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"}duplicateDimension
Section titled “duplicateDimension”Duplicate dimension
Create a copy of an existing 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 dimension to be duplicated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be duplicated" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Duplicate dimension schema"}duplicateMeasure
Section titled “duplicateMeasure”Duplicate measure
Create a copy of an existing 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 measure schema"}enableCustomNullValue
Section titled “enableCustomNullValue”Enable custom null value
Enable custom text display for null or empty values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Enable custom null value schema", "type": "boolean"}enableQueryTimeout
Section titled “enableQueryTimeout”Enable query timeout
Enable or disable query timeout to limit long-running queries
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Query timeout enabled schema"}enableTooltips
Section titled “enableTooltips”Enable tooltips
Enable or disable tooltips when hovering over data points
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Enable tooltips schema", "type": "boolean"}enableTopN
Section titled “enableTopN”Enable top N
Enable top N filtering to show only the highest or lowest values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Enable top N schema"}removeColoringOverwrite
Section titled “removeColoringOverwrite”Remove value color
Remove one value color by its position, as returned by getColoringOverwrites
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Zero-based position of the entry to remove" } }, "required": ["index"], "additionalProperties": false, "title": "Remove coloring overwrite schema"}removeDimension
Section titled “removeDimension”Remove dimension
Remove a dimension from the chart
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 dimension to be removed" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be removed" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Remove dimension schema"}removeMeasure
Section titled “removeMeasure”Remove measure
Remove a measure from the chart
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 measure 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"}removeMeasureAxisBand
Section titled “removeMeasureAxisBand”Remove measure axis band
Remove one shaded band from the primary measure axis by its position
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Zero-based position of the band to remove" } }, "required": ["index"], "additionalProperties": false, "title": "Remove measure axis band schema"}removeMeasureGraphColor
Section titled “removeMeasureGraphColor”Remove measure color
Remove a measure color override
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" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Remove measure graph color schema"}resetChartPaletteToThemeDefault
Section titled “resetChartPaletteToThemeDefault”Reset chart palette
Reset the chart palette back to the workbook theme default
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false, "title": "Reset chart palette schema"}setAnimationEnabled
Section titled “setAnimationEnabled”Animations
Turn the chart animations on or off. They are on by default; the host can still disable them regardless of this setting
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether the chart animates when it first renders and when its data changes" } }, "required": ["enabled"], "additionalProperties": false, "title": "Set animation enabled schema"}setAxisLabelColor
Section titled “setAxisLabelColor”Axis label color
Change the color of axis value labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "labelColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis label color schema"}setAxisLineColor
Section titled “setAxisLineColor”Axis line color
Change the color of axis lines
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "lineColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis line color schema"}setAxisRangeMax
Section titled “setAxisRangeMax”Axis range maximum
Set the maximum of a measure axis. Applies only when the axis range option is minmax or max, e.g. to give several charts the same scale.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure"] }, "maxValue": { "type": "number" } }, "required": ["axisName", "maxValue"], "additionalProperties": false, "title": "Axis range max schema"}setAxisRangeMin
Section titled “setAxisRangeMin”Axis range minimum
Set the minimum of a measure axis. Applies only when the axis range option is minmax or min, e.g. to give several charts the same scale.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure"] }, "minValue": { "type": "number" } }, "required": ["axisName", "minValue"], "additionalProperties": false, "title": "Axis range min schema"}setAxisRangeOption
Section titled “setAxisRangeOption”Axis range
Choose how a measure axis range is set: auto fits the data, minmax fixes both ends, min or max fixes one end. Fixed ends take their values from setAxisRangeMin and setAxisRangeMax.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure"] }, "axisRangeOption": { "type": "string", "enum": ["auto", "minmax", "max", "min"] } }, "required": ["axisName", "axisRangeOption"], "additionalProperties": false, "title": "Axis range option schema"}setAxisScale
Section titled “setAxisScale”Axis scale
Draw a measure axis on a linear or a logarithmic scale
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure"], "description": "Measure axis to change" }, "scale": { "type": "string", "enum": ["linear", "log"], "description": "Scale of the measure axis. A logarithmic axis draws gridlines at powers of ten, and draws zero and negative values at its floor." } }, "required": ["axisName", "scale"], "additionalProperties": false, "title": "Set axis scale schema"}setAxisStartsAtZero
Section titled “setAxisStartsAtZero”Axis starts at zero
Make an auto-ranged measure axis always include zero. Applies only when the axis range option is auto.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure"] }, "startsAtZero": { "type": "boolean" } }, "required": ["axisName", "startsAtZero"], "additionalProperties": false, "title": "Axis starts at zero schema"}setAxisTickColor
Section titled “setAxisTickColor”Axis tick color
Change the color of axis tick marks
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "tickColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis tick color schema"}setAxisTitle
Section titled “setAxisTitle”Axis title
Set a custom title for an axis
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisTitle": { "type": "string" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis title schema"}setAxisTitleColor
Section titled “setAxisTitleColor”Axis title color
Change the color of axis titles
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "titleColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis title color schema"}setChartPalette
Section titled “setChartPalette”Chart palette
Apply an existing palette using a built-in palette name or a theme palette label like “theme palette 2”. Built-in categorical palettes: astrato, classic, spectrum, flat, neon, instant, brewer, alternate, dark, bright. Built-in gradient palettes (gradient coloring): viridis, instant, coral, yellowred, greenblue, bluepurple, redpurple. Requires a palette-based coloring type. Your own colors are set with setCustomPaletteColors or setCustomGradientColors, on charts that offer them
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "minLength": 1, "title": "Chart palette schema"}setColoringColor
Section titled “setColoringColor”Coloring color
Set the single color used by the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$", "title": "Coloring color schema"}setColoringOverwrites
Section titled “setColoringOverwrites”Value colors
Replace all value colors, eg. color the dimension value “Happy” dark teal. Value colors take priority over the coloring type and palette, so they apply whatever setColoringType is set to. For ordered bands, add one entry per band with colors taken along a ramp. Requires at least two enabled dimensions; with fewer, only removing value colors (including an empty list) is accepted.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "overwrites": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "dimension": { "description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension", "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" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false }, "color": { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$", "description": "Color applied when the condition matches, eg. \"#0F766E\"" }, "operator": { "description": "How the dimension value is compared; defaults to equals. contains, startsWith and endsWith compare text, greater and less compare numbers", "type": "string", "enum": [ "equals", "contains", "startsWith", "endsWith", "greater", "less", "greater-equals", "less-equals" ] }, "value": { "description": "Value to compare against", "type": ["string", "number"] } }, "required": ["color", "value"], "additionalProperties": false }, { "type": "object", "properties": { "dimension": { "description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension", "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" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false }, "color": { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$", "description": "Color applied when the condition matches, eg. \"#0F766E\"" }, "operator": { "type": "string", "const": "between", "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)" }, "value": { "description": "Lower bound of the range", "type": ["string", "number"] }, "secondValue": { "description": "Upper bound of the range", "type": ["string", "number"] } }, "required": ["color", "operator", "value", "secondValue"], "additionalProperties": false }, { "type": "object", "properties": { "dimension": { "description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension", "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" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false }, "color": { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$", "description": "Color applied when the condition matches, eg. \"#0F766E\"" }, "operator": { "type": "string", "enum": ["inList", "notInList"], "description": "Match (inList) or exclude (notInList) every value in values" }, "values": { "minItems": 1, "type": "array", "items": { "type": ["string", "number"] }, "description": "Values to match" }, "delimiter": { "description": "Separator the values are stored with; defaults to \",\". No value may contain it", "type": "string", "minLength": 1 } }, "required": ["color", "operator", "values"], "additionalProperties": false } ] }, "description": "Ordered list of value colors; the first matching entry wins. An empty list removes them all" } }, "required": ["overwrites"], "additionalProperties": false, "title": "Set coloring overwrites schema"}setColoringPersistentColors
Section titled “setColoringPersistentColors”Persistent colors
Enable or disable persistent categorical coloring
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Enable persistent colors", "title": "Persistent colors schema", "type": "boolean"}setColoringSortOrder
Section titled “setColoringSortOrder”Coloring sort order
Set the order categorical colors and legend items follow: “alpha-asc” sorts ascending by value (numbers numerically, text A to Z), “data” keeps the order of the data. Fails when the chart cannot use categorical coloring with its current dimensions and measures
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["alpha-asc", "data"], "title": "Coloring sort order schema"}setColoringType
Section titled “setColoringType”Coloring type
Set how colors are applied to the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["single", "categorical", "gradient", "perEachMeasure", "perEachDimension"], "title": "Coloring type schema"}setCustomNullValue
Section titled “setCustomNullValue”Custom null value
Set what text to display for null or empty values
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": "Set custom null value schema"}setCustomPaletteColors
Section titled “setCustomPaletteColors”Custom palette colors
Replace the whole custom categorical palette with a provided list of colors and switch the chart to the custom palette in the same step, so setChartPalette does not need to be called first. Requires categorical or perEachMeasure or perEachDimension coloring; set the coloring type first if the chart uses single coloring. For gradient coloring use setCustomGradientColors instead
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "colors": { "minItems": 1, "type": "array", "items": { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" } } }, "required": ["colors"], "additionalProperties": false, "title": "Custom palette colors schema"}setDataGapsHandling
Section titled “setDataGapsHandling”Data gaps handling
Control how data gaps are handled
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["show", "replace", "interpolate"], "title": "Data gaps handling schema"}setDimensionFormatString
Section titled “setDimensionFormatString”Dimension format string
Set the custom display format string for a dimension. This changes label formatting only and does not change temporal grouping.
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 dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "formatString": { "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": "Dimension format string schema"}setDimensionFormatType
Section titled “setDimensionFormatType”Dimension format type
Set the display format type used by a dimension. This changes label formatting only and does not change temporal grouping.
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 dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "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": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"], "additionalProperties": false, "title": "Dimension format type schema"}setDimensionTemporalGrouping
Section titled “setDimensionTemporalGrouping”Dimension temporal grouping
Set the temporal grouping of a date dimension. 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 dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "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 dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "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 dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "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": "Dimension temporal grouping schema"}setEnableContinuousAxis
Section titled “setEnableContinuousAxis”Enable continuous axis
Use continuous scale for numeric or date values on axis
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "continuousAxis": { "type": "boolean" } }, "additionalProperties": false, "title": "Enable continuous axis schema"}setEndLabelsBackdrop
Section titled “setEndLabelsBackdrop”Line end labels backdrop
Draw each line end label on a box in its series colour, with contrasting text
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Line chart end labels backdrop schema", "type": "boolean"}setEndLabelsPosition
Section titled “setEndLabelsPosition”Line-end label position
Place the line end labels inside the plot or in a column to its right
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Line chart end labels position schema", "type": "string", "enum": ["plot", "right"]}setExportLimit
Section titled “setExportLimit”Export limit
Limit the number of rows when exporting chart data
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Set export limit schema", "type": ["number", "null"]}setHideZeroValues
Section titled “setHideZeroValues”Hide zero values
Hide or show data points with zero values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Set hide zero values schema", "type": "boolean"}setInvertAxis
Section titled “setInvertAxis”Invert axis
Reverse the direction of an axis. axisName defaults to the dimension axis; pass a measure axis to flip its value scale, e.g. to put rank 1 at the top.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "invertAxis": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["dimension", "primaryMeasure", "secondaryMeasure"] } }, "required": ["invertAxis"], "additionalProperties": false, "title": "Invert axis schema"}setLabelOverlap
Section titled “setLabelOverlap”Axis label overlap
Control how axis labels behave when they overlap
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "labelOverlap": { "type": "string", "enum": ["auto", "show-last"] } }, "additionalProperties": false, "title": "Axis label overlap schema"}setLegendEnabled
Section titled “setLegendEnabled”Legend enabled
Show or hide the chart legend
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "description": "Enable legend", "title": "Legend enabled schema"}setLegendItemLabelFill
Section titled “setLegendItemLabelFill”Legend label color
Change the color of legend text labels
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" } ], "description": "Legend item label font color (hexadecimal color code)", "title": "Legend item label fill schema"}setLegendItemLabelFontSize
Section titled “setLegendItemLabelFontSize”Legend label font size
Adjust the font size of legend labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "number", "title": "Legend item label font size schema"}setLegendItemLabelLimitCharacters
Section titled “setLegendItemLabelLimitCharacters”Enable legend label characters limit
Enable or disable character limit for legend labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Limit characters by maxGlyphCount", "title": "Legend item label limit characters schema", "type": "boolean"}setLegendItemLabelMaxGlyphCount
Section titled “setLegendItemLabelMaxGlyphCount”Legend label characters limit
Set the maximum number of characters shown in legend labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Maximum number of glyphs in the legend item label", "title": "Legend item label max glyph count schema", "type": ["number", "null"]}setLegendPosition
Section titled “setLegendPosition”Legend position
Change where the legend appears on the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["left", "right", "top", "bottom"], "description": "Legend position", "title": "Legend position schema"}setLegendTitle
Section titled “setLegendTitle”Legend title
Set a custom title for the legend
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Legend title text", "title": "Legend title schema", "type": ["string", "null"]}setLineChartType
Section titled “setLineChartType”Line chart type
Set line chart type
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Line chart type schema", "type": "string", "enum": ["line", "area", "stacked"]}setLineType
Section titled “setLineType”Line type
Set the line curve type
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["curve", "straight", "square"], "title": "Line chart line curve schema"}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"}setMeasureAxisBands
Section titled “setMeasureAxisBands”Measure axis bands
Replace all shaded bands on the primary measure axis. Each band fills the plot between two measure values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "bands": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "number", "description": "Measure axis value where the band starts" }, "end": { "type": "number", "description": "Measure axis value where the band ends" }, "color": { "description": "Band fill as #RRGGBB or #RRGGBBAA; defaults to a light grey when omitted", "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, "label": { "description": "Text drawn inside the band", "type": "string" } }, "required": ["start", "end"], "additionalProperties": false }, "description": "Bands to draw, in order; an empty array removes all bands" } }, "required": ["bands"], "additionalProperties": false, "title": "Set measure axis bands schema"}setMeasureCurrency
Section titled “setMeasureCurrency”Measure currency
Set the currency symbol used by a measure formatter
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" }, "currency": { "type": "string" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Measure currency schema"}setMeasureCurrencyIsPrefix
Section titled “setMeasureCurrencyIsPrefix”Measure currency is prefix
Set whether measure currency symbol is prefixed
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" }, "currencyIsPrefix": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Measure currency is prefix schema"}setMeasureDataLabelBackdropColor
Section titled “setMeasureDataLabelBackdropColor”Measure data label backdrop color
Set the backdrop color behind measure data 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 measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "backdropColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure data label backdrop color schema"}setMeasureDataLabelDensity
Section titled “setMeasureDataLabelDensity”Measure data label density
Control how many data labels are shown to avoid overlap
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" }, "density": { "type": "string", "enum": ["low", "medium", "high"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "density"], "additionalProperties": false, "title": "Measure data label density schema"}setMeasureDataLabelFontSize
Section titled “setMeasureDataLabelFontSize”Measure data label font size
Set the font size of data labels 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" }, "fontSize": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure data label font size schema"}setMeasureDataLabelIsColored
Section titled “setMeasureDataLabelIsColored”Measure data label colored
Set if measure measure data label should be colored
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" }, "isColored": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Measure data label colored schema"}setMeasureDataLabelShowBackdrop
Section titled “setMeasureDataLabelShowBackdrop”Measure data label backdrop
Show or hide the backdrop behind measure data 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 measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "showBackdrop": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure data label backdrop schema"}setMeasureDataLabelsShow
Section titled “setMeasureDataLabelsShow”Show measure data labels
Show or hide data labels 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" }, "show": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure data labels show schema"}setMeasureDataLabelTextColor
Section titled “setMeasureDataLabelTextColor”Measure data label text color
Set the text color of data labels 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" }, "textColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure data label text color 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"}setMeasureFormatString
Section titled “setMeasureFormatString”Measure format string
Set the custom format string 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" }, "formatString": { "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": "Measure format string schema"}setMeasureFormatType
Section titled “setMeasureFormatType”Measure format type
Set the format type used by 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" }, "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": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"], "additionalProperties": false, "title": "Measure format type schema"}setMeasureGraphColor
Section titled “setMeasureGraphColor”Measure color
Set a color override 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" }, "graphColor": { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "graphColor"], "additionalProperties": false, "title": "Measure graph color schema"}setMeasureLineSize
Section titled “setMeasureLineSize”Measure line size
Adjust the thickness of the line for a specific 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" }, "strokeWidth": { "description": "Stroke width (in pixels)", "type": "number" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure line size schema"}setMeasureLineStyle
Section titled “setMeasureLineStyle”Measure line style
Change the line style for a specific 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" }, "lineStyle": { "type": "string", "enum": ["line", "dashed", "dotted"] }, "strokeWidth": { "description": "Stroke width (in pixels)", "type": "number" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "lineStyle"], "additionalProperties": false, "title": "Set measure line style schema"}setMeasureNegativeType
Section titled “setMeasureNegativeType”Measure negative type
Set how negative values are displayed for a measure formatter
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" }, "negativeType": { "type": "string", "enum": ["symbol", "parenthesis"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Measure negative type schema"}setMeasureShape
Section titled “setMeasureShape”Measure shape
Set the shape of data points for a specific 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" }, "shape": { "anyOf": [ { "type": "string", "enum": [ "bar", "circle", "cross", "diamond", "n-polygon", "rectangle", "saltire", "square", "star", "triangle", "vertical-bar" ] }, { "type": "null" } ], "description": "Shape marking the data points" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure shape schema"}setMeasureShapeAdaptiveSize
Section titled “setMeasureShapeAdaptiveSize”Measure shape adaptive size
Enable adaptive sizing for measure shapes based on data 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 measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "adaptiveSize": { "description": "Adaptive size (in percent)", "type": "number", "minimum": 0, "maximum": 1 } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure shape adaptive size schema"}setMeasureShapeMaxSize
Section titled “setMeasureShapeMaxSize”Measure shape max size
Set the maximum size for adaptive measure shapes
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" }, "maxSize": { "description": "Max size of the datapoint (in pixels)", "type": "number", "minimum": 1, "maximum": 1000 } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure shape max size schema"}setMeasureShapeMinSize
Section titled “setMeasureShapeMinSize”Measure shape min size
Set the minimum size for adaptive measure shapes
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" }, "minSize": { "description": "Min size of the datapoint (in pixels)", "type": "number", "minimum": 1, "maximum": 100 } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure shape min size schema"}setOrientation
Section titled “setOrientation”Orientation
Set the orientation of the line chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Line chart orientation schema", "type": "string", "enum": ["horizontal", "vertical"]}setOthersPosition
Section titled “setOthersPosition”Top N others position
Set where the “Others” category appears in the chart
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": "Set others position schema", "type": "string", "enum": ["default", "first", "last"]}setQueryLimit
Section titled “setQueryLimit”Query limit
Limit the number of rows returned from the database query
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Set query limit schema", "type": ["number", "null"]}setQueryTimeout
Section titled “setQueryTimeout”Set query timeout
Set the timeout duration for database queries 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"}setShowAxisLabels
Section titled “setShowAxisLabels”Show axis labels
Show or hide value labels on chart axes
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "showLabels": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis labels schema"}setShowAxisLine
Section titled “setShowAxisLine”Show axis line
Show or hide the axis lines on the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "showAxisLine": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis line schema"}setShowAxisTicks
Section titled “setShowAxisTicks”Show axis ticks
Show or hide tick marks on chart axes
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "showAxisTicks": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis ticks schema"}setShowAxisTitle
Section titled “setShowAxisTitle”Show axis title
Show or hide axis titles on the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "showAxisName": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis title schema"}setShowAxisTooltip
Section titled “setShowAxisTooltip”Show axis tooltip
Show or hide tooltips when hovering over axis values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "showAxisTooltip": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Show axis tooltip schema"}setShowEndLabels
Section titled “setShowEndLabels”Line end labels
Show or hide the series name at the end of each line. Stacked and horizontal line charts keep the setting but draw no end labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Line chart show end labels schema", "type": "boolean"}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"}setTooltipsHideTotal
Section titled “setTooltipsHideTotal”Set tooltips hide total
Hide or show the total value in tooltips
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Set tooltips show total schema", "type": "boolean"}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 how many top values to display in the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Set top N number of values schema", "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 a custom label for the “Others” category
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "stringLabel": { "type": "string" } }, "additionalProperties": false, "title": "Set 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 an “Others” category for remaining values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Group other values into one \"Others\" item", "title": "Set top N show others schema", "type": "boolean"}setTopNSortOrder
Section titled “setTopNSortOrder”Top N sort order
Set the sorting order for top N values
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": "Set top N sort order schema", "type": "string", "enum": ["asc", "desc"]}toggleDimension
Section titled “toggleDimension”Toggle dimension
Enable or disable a dimension in the chart
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 dimension to be toggled" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be toggled" }, "enabled": { "type": "boolean", "description": "Whether the dimension should be enabled or disabled" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"], "additionalProperties": false, "title": "Toggle dimension schema"}toggleMeasure
Section titled “toggleMeasure”Toggle measure
Enable or disable a measure in the chart
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 measure 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"}updateDimension
Section titled “updateDimension”Update dimension
Modify properties of an existing 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 dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "changes": { "type": "object", "properties": { "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 dimension schema"}updateMeasure
Section titled “updateMeasure”Update measure
Modify properties of an existing 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 measure schema"}