treemap 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”addColoringOverwriteaddColoringRuleaddDimensionaddMeasureaddMeasureFilteraddResultFilterchangeMeasureAggregationclearMeasureFilterclearResultFilterduplicateDimensionduplicateMeasureremoveColoringGradientFieldremoveColoringOverwriteremoveColoringRuleremoveDimensionremoveMeasureresetChartPaletteToThemeDefaultsetAnimationEnabledsetChartPalettesetColoringColorsetColoringGradientAutosetColoringGradientFieldsetColoringGradientMaxsetColoringGradientMinsetColoringMeasureAggregationsetColoringOverwritessetColoringPersistentColorssetColoringRulessetColoringSortOrdersetColoringTypesetCustomGradientColorssetCustomPaletteColorssetDimensionFormatStringsetDimensionFormatTypesetDimensionTemporalGroupingsetLegendEnabledsetLegendItemLabelFillsetLegendItemLabelFontSizesetLegendItemLabelLimitCharacterssetLegendItemLabelMaxGlyphCountsetLegendPositionsetLegendTitlesetMeasureCurrencysetMeasureCurrencyIsPrefixsetMeasureDefinedParametersetMeasureFiltersetMeasureFormatStringsetMeasureFormatTypesetMeasureNegativeTypesetResultFiltersetSortingDirectionsetSortingEnabledsetStaticFilterGroupsetSupportingMeasureEnabledsetTreemapHeaderLabelFontSizesetTreemapHeaderLabelNumLevelssetTreemapHeaderLabelShowDimensionValuesetTreemapHeaderLabelShowMeasureValuesetTreemapHeaderLabelsShowsetTreemapLeafLabelDynamicFontSizeEnabledsetTreemapLeafLabelFontSizesetTreemapLeafLabelShowDimensionValuesetTreemapLeafLabelShowMeasureValuesetTreemapLeafLabelsShowtoggleDimensiontoggleDimensionOrMeasureByNametoggleMeasureupdateDimensionupdateMeasure
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.
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"}addColoringRule
Section titled “addColoringRule”Add measure color rule
Append one measure color rule, eg. color marks red when Sales is below 100. Earlier rules win when several match.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "measure": { "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, "description": "Measure whose value is compared" }, "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": ["equals", "not-equals", "greater", "less", "greater-equals", "less-equals"], "description": "How the measure value is compared" }, "value": { "description": "Value to compare against", "type": ["string", "number"] } }, "required": ["measure", "color", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measure": { "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, "description": "Measure whose value is compared" }, "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 measure values from value to secondValue, both inclusive" }, "value": { "description": "Lower bound of the range", "type": ["string", "number"] }, "secondValue": { "description": "Upper bound of the range", "type": ["string", "number"] } }, "required": ["measure", "color", "operator", "value", "secondValue"], "additionalProperties": false }, { "type": "object", "properties": { "measure": { "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, "description": "Measure whose value is compared" }, "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": ["measure", "color", "operator", "values"], "additionalProperties": false } ], "title": "Add coloring rule 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"}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"}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"}removeColoringGradientField
Section titled “removeColoringGradientField”Remove gradient field
Clear the selected gradient field
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false, "title": "Remove coloring gradient field 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"}removeColoringRule
Section titled “removeColoringRule”Remove measure color rule
Remove one measure color rule by its position, as returned by getColoringRules
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 rule 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"}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"}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"}setColoringGradientAuto
Section titled “setColoringGradientAuto”Automatic gradient limits
Enable automatic gradient limits from the data, or disable Auto to use the stored limits. Preserves stored minimum and maximum values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Coloring gradient auto schema"}setColoringGradientField
Section titled “setColoringGradientField”Gradient field
Select the field used for gradient coloring
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"" }, "sourceKind": { "type": "string", "const": "field", "description": "Gradient field selection always uses a raw database field." }, "aggregation": { "type": "string", "description": "Aggregation function to use for the selected field." } }, "required": ["key", "sourceKind", "aggregation"], "additionalProperties": false, "title": "Coloring gradient field schema"}setColoringGradientMax
Section titled “setColoringGradientMax”Gradient maximum
Set the maximum value of the gradient domain using a number or variable. Applies when setColoringGradientAuto is false
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "title": "Coloring gradient maximum schema"}setColoringGradientMin
Section titled “setColoringGradientMin”Gradient minimum
Set the minimum value of the gradient domain using a number or variable. Applies when setColoringGradientAuto is false
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "title": "Coloring gradient minimum schema"}setColoringMeasureAggregation
Section titled “setColoringMeasureAggregation”Coloring measure aggregation
Set the aggregation used by the gradient field
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Measure aggregation for coloring", "title": "Coloring measure aggregation schema", "type": ["string", "null"]}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.
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"}setColoringRules
Section titled “setColoringRules”Measure color rules
Replace all measure color rules, eg. color marks red when Sales is below 100. Rules apply after value colors and before the coloring type.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "measure": { "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, "description": "Measure whose value is compared" }, "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": ["equals", "not-equals", "greater", "less", "greater-equals", "less-equals"], "description": "How the measure value is compared" }, "value": { "description": "Value to compare against", "type": ["string", "number"] } }, "required": ["measure", "color", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measure": { "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, "description": "Measure whose value is compared" }, "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 measure values from value to secondValue, both inclusive" }, "value": { "description": "Lower bound of the range", "type": ["string", "number"] }, "secondValue": { "description": "Upper bound of the range", "type": ["string", "number"] } }, "required": ["measure", "color", "operator", "value", "secondValue"], "additionalProperties": false }, { "type": "object", "properties": { "measure": { "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, "description": "Measure whose value is compared" }, "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": ["measure", "color", "operator", "values"], "additionalProperties": false } ] }, "description": "Ordered list of measure color rules; the first matching rule wins. An empty list removes them all" } }, "required": ["rules"], "additionalProperties": false, "title": "Set coloring rules schema"}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"}setCustomGradientColors
Section titled “setCustomGradientColors”Custom gradient colors
Replace the whole custom gradient with a provided list of colors
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 gradient colors 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"}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"}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"]}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"}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"}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"}setResultFilter
Section titled “setResultFilter”Set result filter
Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "contains", "excludes", "like", "notLike", "startsWith", "endsWith" ], "description": "Filter operator that requires a value" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Filter value" } }, "required": ["measureName", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["isBetween", "isNotBetween"], "description": "Filter operator that requires valueFrom and valueTo" }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Lower filter value" }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Upper filter value" } }, "required": ["measureName", "operator", "valueFrom", "valueTo"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["inList", "excludedFromList"], "description": "Filter operator that requires a list of values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Filter values" } }, "required": ["measureName", "operator", "values"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["isNull", "notNull"], "description": "Filter operator that does not require values" } }, "required": ["measureName", "operator"], "additionalProperties": false } ], "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.", "title": "Set result filter schema"}setSortingDirection
Section titled “setSortingDirection”Sorting direction
Set sorting direction for all matching sortable items by name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "sortDirection": { "type": "string", "enum": ["ascending", "descending"] } }, "required": ["name", "sortDirection"], "additionalProperties": false, "title": "Sorting direction by name schema"}setSortingEnabled
Section titled “setSortingEnabled”Sorting enabled
Enable or disable sorting for all matching sortable items by name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" } }, "required": ["name"], "additionalProperties": false, "title": "Sorting enabled by name schema"}setStaticFilterGroup
Section titled “setStaticFilterGroup”Set static filter group
Replace all static filters with a nested AND/OR filter group.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Replace all static filters with this nested AND/OR filter group.", "title": "Set static filter group schema", "$ref": "#/$defs/__schema0", "$defs": { "__schema0": { "type": "object", "properties": { "operator": { "type": "string", "enum": ["and", "or"] }, "filters": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "anyOf": [ { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "isBetween", "isNotBetween", "isNull", "notNull", "contains", "excludes", "like", "notLike", "startsWith", "endsWith", "predefined_date_range", "previous", "current", "before", "after", "inList", "excludedFromList", "divider" ] }, { "type": "string", "enum": [ "ytd", "mtd", "qtd", "wtd", "pytd", "pmtd", "pqtd", "pwtd", "l12m", "l90d", "l30d", "l7d", "cy", "cq", "cm", "py", "pm", "pq", "pw", "today", "yesterday", "mindate", "maxdate" ] } ] }, "values": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "secondValue": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "additionalProperties": false }, "dateFilter": { "anyOf": [ { "type": "string", "enum": [ "ytd", "mtd", "qtd", "wtd", "pytd", "pmtd", "pqtd", "pwtd", "l12m", "l90d", "l30d", "l7d", "cy", "cq", "cm", "py", "pm", "pq", "pw", "today", "yesterday", "mindate", "maxdate" ] }, { "type": "null" } ] } }, "required": ["fieldKey", "operator", "values"], "additionalProperties": false }, { "$ref": "#/$defs/__schema0" } ] } } }, "required": ["operator", "filters"], "additionalProperties": false } }}setSupportingMeasureEnabled
Section titled “setSupportingMeasureEnabled”Supporting measure enabled
Enable or disable all matching supporting measures by name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" } }, "required": ["name", "enabled"], "additionalProperties": false, "title": "Supporting measure enabled by name schema"}setTreemapHeaderLabelFontSize
Section titled “setTreemapHeaderLabelFontSize”Treemap header label font size
Set treemap header label font size
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Labels font size", "title": "Treemap header label font size schema", "anyOf": [ { "type": "number", "minimum": 6, "maximum": 50 }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ]}setTreemapHeaderLabelNumLevels
Section titled “setTreemapHeaderLabelNumLevels”Treemap header label levels
Set how many treemap header levels can show labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Maximum number of header levels to show", "title": "Treemap header label levels schema", "type": "number", "minimum": 0, "maximum": 5}setTreemapHeaderLabelShowDimensionValue
Section titled “setTreemapHeaderLabelShowDimensionValue”Treemap header label dimension value
Show or hide dimension values in treemap header labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Display dimension value", "title": "Treemap header label dimension value schema", "type": "boolean"}setTreemapHeaderLabelShowMeasureValue
Section titled “setTreemapHeaderLabelShowMeasureValue”Treemap header label measure value
Show or hide measure values in treemap header labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Display measure value", "title": "Treemap header label measure value schema", "type": "boolean"}setTreemapHeaderLabelsShow
Section titled “setTreemapHeaderLabelsShow”Show treemap header labels
Show or hide treemap header labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Display labels", "title": "Treemap header labels show schema", "type": "boolean"}setTreemapLeafLabelDynamicFontSizeEnabled
Section titled “setTreemapLeafLabelDynamicFontSizeEnabled”Treemap leaf dynamic label font size
Enable or disable dynamic font sizing for treemap leaf labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Maximum number of header levels to show", "title": "Treemap leaf dynamic label font size schema", "type": "boolean"}setTreemapLeafLabelFontSize
Section titled “setTreemapLeafLabelFontSize”Treemap leaf label font size
Set treemap leaf label font size
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Labels font size", "title": "Treemap leaf label font size schema", "anyOf": [ { "type": "number", "minimum": 6, "maximum": 50 }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ]}setTreemapLeafLabelShowDimensionValue
Section titled “setTreemapLeafLabelShowDimensionValue”Treemap leaf label dimension value
Show or hide dimension values in treemap leaf labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Display dimension value", "title": "Treemap leaf label dimension value schema", "type": "boolean"}setTreemapLeafLabelShowMeasureValue
Section titled “setTreemapLeafLabelShowMeasureValue”Treemap leaf label measure value
Show or hide measure values in treemap leaf labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Display measure value", "title": "Treemap leaf label measure value schema", "type": "boolean"}setTreemapLeafLabelsShow
Section titled “setTreemapLeafLabelsShow”Show treemap leaf labels
Show or hide treemap leaf labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Display labels", "title": "Treemap leaf labels show schema", "type": "boolean"}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"}toggleDimensionOrMeasureByName
Section titled “toggleDimensionOrMeasureByName”Toggle dimension/measure by name
Enable, disable, or toggle a dimension or measure by its name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string" }, "operation": { "type": "string", "enum": ["enable", "disable", "toggle"] } }, "required": ["name", "operation"], "additionalProperties": false, "title": "Toggle dimension or measure by name 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"}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"}