Written by

🚧 [Experimental] Create wizard chart

Creates a new wizard chart.

Request

POST

https://api.datalens.tech/rpc/createWizardChart

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 3

Example: 3

Body

application/json

{
  "data": {
    "sources": {
      "datasetsIds": [
        "example"
      ],
      "updates": [
        {}
      ],
      "links": [
        {}
      ],
      "hierarchies": [
        {}
      ],
      "filters": [
        {}
      ]
    },
    "visualization": {
      "type": "line",
      "chartSettings": {},
      "x": {},
      "y": {},
      "y2": {},
      "colors": {},
      "shapes": {},
      "labels": {},
      "sort": {},
      "segments": {}
    }
  },
  "annotation": {
    "description": "example"
  },
  "key": "example",
  "workbookId": "example",
  "name": "example"
}

All of 2 types

Type: object

data

Type: WizardV1ConfigSchema

Example

{
  "sources": {
    "datasetsIds": [
      "example"
    ],
    "updates": [
      {
        "action": "add_field",
        "field": {
          "guid": "example",
          "datasetId": "example",
          "title": "example",
          "type": "DIMENSION",
          "calc_mode": "formula",
          "formula": "example",
          "aggregation": "example",
          "cast": "example",
          "source": "example",
          "data_type": "date",
          "aggregation_locked": true,
          "autoaggregated": true,
          "grouping": "example",
          "fakeTitle": "example",
          "originalTitle": "example",
          "avatar_id": "example",
          "local": true,
          "quickFormula": true,
          "originalFormula": "example",
          "originalSource": "example",
          "originalDateCast": null,
          "format": "example",
          "default_value": null
        },
        "debug_info": "example"
      }
    ],
    "links": [
      {
        "id": "example",
        "fields": {}
      }
    ],
    "hierarchies": [
      {
        "guid": "example",
        "title": "example",
        "fields": [
          {}
        ]
      }
    ],
    "filters": [
      {
        "guid": "example",
        "datasetId": "example",
        "fakeTitle": "example",
        "filter": {
          "operation": {},
          "value": null
        }
      }
    ]
  },
  "visualization": {
    "type": "line",
    "chartSettings": {
      "title": "example",
      "titleMode": "show",
      "legendMode": "show",
      "tooltip": "show",
      "tooltipSum": "on",
      "feed": "example",
      "navigatorSettings": {
        "navigatorMode": "show",
        "selectedLines": [
          null
        ],
        "linesMode": "all",
        "periodSettings": {}
      }
    },
    "x": {
      "items": [
        null
      ],
      "settings": {
        "title": "auto",
        "titleValue": "example",
        "type": "linear",
        "grid": "on",
        "gridStep": "auto",
        "gridStepValue": 0.5,
        "hideLabels": "yes",
        "labelsView": "auto",
        "axisLabelFormatting": {},
        "axisLabelDateFormat": "example",
        "axisFormatMode": "auto",
        "axisVisibility": "show",
        "holidays": "on",
        "axisModeMap": {}
      }
    },
    "y": {
      "items": [
        null
      ],
      "settings": {
        "title": "auto",
        "titleValue": "example",
        "type": "linear",
        "grid": "on",
        "gridStep": "auto",
        "gridStepValue": 0.5,
        "hideLabels": "yes",
        "labelsView": "auto",
        "axisLabelFormatting": {},
        "axisLabelDateFormat": "example",
        "axisFormatMode": "auto",
        "axisVisibility": "show",
        "scale": "auto",
        "scaleValue": null,
        "nulls": "ignore"
      }
    },
    "y2": {
      "items": [
        null
      ],
      "settings": {
        "title": "auto",
        "titleValue": "example",
        "type": "linear",
        "grid": "on",
        "gridStep": "auto",
        "gridStepValue": 0.5,
        "hideLabels": "yes",
        "labelsView": "auto",
        "axisLabelFormatting": {},
        "axisLabelDateFormat": "example",
        "axisFormatMode": "auto",
        "axisVisibility": "show",
        "scale": "auto",
        "scaleValue": null,
        "nulls": "ignore"
      }
    },
    "colors": {
      "items": [
        null
      ],
      "settings": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "polygonBorders": "show",
        "reversed": true,
        "fieldGuid": "example",
        "mountedColors": {},
        "coloredByMeasure": true,
        "palette": "example",
        "colorMode": "palette",
        "nullMode": "ignore"
      }
    },
    "shapes": {
      "items": [
        null
      ],
      "settings": {
        "fieldGuid": "example",
        "mountedShapes": {},
        "lineSettings": {},
        "commonLineSettings": {}
      }
    },
    "labels": {
      "items": [
        null
      ],
      "settings": {
        "overlap": "on"
      }
    },
    "sort": {
      "items": [
        null
      ]
    },
    "segments": {
      "items": [
        null
      ]
    }
  }
}

annotation

Type: EntryAnnotationArg

Example

{
  "description": "example"
}

Example

{
  "data": {
    "sources": {
      "datasetsIds": [
        "example"
      ],
      "updates": [
        {
          "action": "add_field",
          "field": {},
          "debug_info": "example"
        }
      ],
      "links": [
        {
          "id": "example",
          "fields": {}
        }
      ],
      "hierarchies": [
        {
          "guid": "example",
          "title": "example",
          "fields": [
            null
          ]
        }
      ],
      "filters": [
        {
          "guid": "example",
          "datasetId": "example",
          "fakeTitle": "example",
          "filter": {}
        }
      ]
    },
    "visualization": {
      "type": "line",
      "chartSettings": {
        "title": "example",
        "titleMode": "show",
        "legendMode": "show",
        "tooltip": "show",
        "tooltipSum": "on",
        "feed": "example",
        "navigatorSettings": {}
      },
      "x": {
        "items": [
          null
        ],
        "settings": {}
      },
      "y": {
        "items": [
          null
        ],
        "settings": {}
      },
      "y2": {
        "items": [
          null
        ],
        "settings": {}
      },
      "colors": {
        "items": [
          null
        ],
        "settings": {}
      },
      "shapes": {
        "items": [
          null
        ],
        "settings": {}
      },
      "labels": {
        "items": [
          null
        ],
        "settings": {}
      },
      "sort": {
        "items": [
          null
        ]
      },
      "segments": {
        "items": [
          null
        ]
      }
    }
  },
  "annotation": {
    "description": "example"
  }
}

Type: EntryLocationIdentifiers

Example

{
  "key": "example",
  "workbookId": "example",
  "name": "example"
}

WizardV1FiltersItemSchema

Name

Description

datasetId

Type: string

Identifier of the dataset containing the field.

Example: example

filter

Type: object

operation

Type: object

code

Type: string

Filter operation code.

Example: example

Operation used to compare field values.

Example

{
  "code": "example"
}

value

Any of 2 types

Type: string

Example: example
Type: string[]
Example
```
[
  "example"
]
```

Value or values used by the filter operation.

Example: example

Filter applied to the field.

Example

{
  "operation": {
    "code": "example"
  },
  "value": "example"
}

guid

Type: string

Identifier of the field used for filtering.

Example: example

fakeTitle

Type: string

Chart-local display title override for the field.

Example: example

Example

{
  "guid": "example",
  "datasetId": "example",
  "fakeTitle": "example",
  "filter": {
    "operation": {
      "code": "example"
    },
    "value": "example"
  }
}

WizardFieldSchema

Any of 4 types

Type: object

data_type

Type: string

Data type identifying this field as a hierarchy.

Const: hierarchy

Example: example

fields

Type: object[]

datasetId

Type: string

Identifier of the dataset containing the field.

Example: example

guid

Type: string

Field identifier.

Example: example

backgroundSettings

Type: object

colorFieldGuid

Type: string

Identifier of the field used to color the background.

Example: example

enabled

Type: boolean

Whether conditional background coloring is enabled.

settings

Type: object

gradientState

Type: object

gradientMode	Type: string Gradient type. Enum: `2-point`, `3-point`
gradientPalette	Type: string Gradient palette identifier. Example: `example`
leftThreshold	Type: string Lower gradient threshold. Example: `example`
middleThreshold	Type: string Middle gradient threshold. Example: `example`
nullMode	Type: string How null values are colored. Enum: `ignore`, `as-0`
reversed	Type: boolean Whether to reverse the gradient palette.
rightThreshold	Type: string Upper gradient threshold. Example: `example`
thresholdsMode	Type: string Mode used to calculate gradient thresholds. Enum: `auto`, `manual`

Continuous gradient settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "reversed": true,
  "nullMode": "ignore"
}

isContinuous

Type: boolean

Whether to use continuous instead of discrete coloring.

paletteState

Type: object

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

palette

Type: string

Color palette identifier.

Example: example

Discrete palette settings.

Example

{
  "mountedColors": {},
  "palette": "example"
}

Background color configuration.

Example

{
  "paletteState": {
    "mountedColors": {},
    "palette": "example"
  },
  "gradientState": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "reversed": true,
    "nullMode": "ignore"
  },
  "isContinuous": true
}

settingsId

Type: string

Identifier of the background color settings.

Example: example

Conditional background settings.

Example

{
  "enabled": true,
  "colorFieldGuid": "example",
  "settingsId": "example",
  "settings": {
    "paletteState": {
      "mountedColors": {},
      "palette": "example"
    },
    "gradientState": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "reversed": true,
      "nullMode": "ignore"
    },
    "isContinuous": true
  }
}

barsSettings

Type: object

align

Type: string

Bar alignment within table cells.

Enum: left, right, default

colorSettings

One of 3 types

Type: object

colorType

Type: string

Use a gradient to color bars.

Const: gradient

Example: example

settings

Type: object

gradientType

Type: string

Gradient type.

Enum: 2-point, 3-point

thresholds

One of 2 types

Type: object

mode

Type: string

Calculate gradient thresholds automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

max	Type: string Upper gradient threshold. Example: `example`
min	Type: string Lower gradient threshold. Example: `example`
mode	Type: string Use manually specified gradient thresholds. Const: `manual` Example: `example`
mid	Type: string Middle gradient threshold. Example: `example`

Example

{
  "mode": "manual",
  "min": "example",
  "mid": "example",
  "max": "example"
}

Thresholds that define the gradient color scale.

Example

{
  "mode": "auto"
}

palette

Type: string

Color palette identifier.

Example: example

reversed

Type: boolean

Whether to reverse the color palette.

Gradient bar color settings.

Example

{
  "gradientType": "2-point",
  "thresholds": {
    "mode": "auto"
  },
  "palette": "example",
  "reversed": true
}

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

Type: object

colorType

Type: string

Use one color for all bars.

Const: one-color

Example: example

settings

Type: object

color

Type: string

Custom bar color.

Example: example

colorIndex

Type: number

Selected color index in the palette.

palette

Type: string

Color palette identifier.

Example: example

Single-color bar settings.

Example

{
  "palette": "example",
  "colorIndex": 0.5,
  "color": "example"
}

Example

{
  "colorType": "one-color",
  "settings": {
    "palette": "example",
    "colorIndex": 0.5,
    "color": "example"
  }
}

Type: object

colorType

Type: string

Use separate colors for negative and positive bars.

Const: two-color

Example: example

settings

Type: object

negativeColor	Type: string Custom color for negative values. Example: `example`
negativeColorIndex	Type: number Palette color index for negative values.
palette	Type: string Color palette identifier. Example: `example`
positiveColor	Type: string Custom color for positive values. Example: `example`
positiveColorIndex	Type: number Palette color index for positive values.

Two-color bar settings.

Example

{
  "palette": "example",
  "negativeColorIndex": 0.5,
  "negativeColor": "example",
  "positiveColorIndex": 0.5,
  "positiveColor": "example"
}

Example

{
  "colorType": "two-color",
  "settings": {
    "palette": "example",
    "negativeColorIndex": 0.5,
    "negativeColor": "example",
    "positiveColorIndex": 0.5,
    "positiveColor": "example"
  }
}

Bar color settings.

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

enabled

Type: boolean

Whether to display bars in table cells.

scale

One of 2 types

Type: object

mode

Type: string

Calculate the bar scale automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

mode

Type: string

Use a manually specified bar scale.

Const: manual

Example: example

settings

Type: object

max

Type: string

Manual maximum scale value.

Example: example

min

Type: string

Manual minimum scale value.

Example: example

Manual bar scale boundaries.

Example

{
  "min": "example",
  "max": "example"
}

Example

{
  "mode": "manual",
  "settings": {
    "min": "example",
    "max": "example"
  }
}

Scale used to calculate bar lengths.

Example

{
  "mode": "auto"
}

showBarsInTotals

Type: boolean

Whether to display bars in total rows.

showLabels

Type: boolean

Whether to display values over bars.

In-cell bar settings.

Example

{
  "enabled": true,
  "colorSettings": {
    "colorType": "gradient",
    "settings": {
      "gradientType": "2-point",
      "thresholds": {},
      "palette": "example",
      "reversed": true
    }
  },
  "showLabels": true,
  "align": "left",
  "scale": {
    "mode": "auto"
  },
  "showBarsInTotals": true
}

columnSettings

Type: object

width

One of 3 types

Type: object

mode

Type: string

Calculate the column width automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```
Type: object

mode

Type: string

Set the column width as a percentage.

Const: percent

Example: example

value

Type: string

Column width percentage.

Example: example
Example
```
{
  "mode": "percent",
  "value": "example"
}
```
Type: object

mode

Type: string

Set the column width in pixels.

Const: pixel

Example: example

value

Type: string

Column width in pixels.

Example: example
Example
```
{
  "mode": "pixel",
  "value": "example"
}
```

Table column width settings.

Example

{
  "mode": "auto"
}

horizontalAlignment

Type: string

Horizontal alignment of values in the column.

Enum: auto, start, center, end

Table column settings.

Example

{
  "width": {
    "mode": "auto"
  },
  "horizontalAlignment": "auto"
}

fakeTitle

Type: string

Chart-local display title override for the field.

Example: example

format

Type: string

Date or datetime format, separate from numeric formatting.

Example: example

formatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric formatting settings for the field.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

hideLabelMode

Type: string

Whether to hide the field label.

Enum: show, hide

hintSettings

Type: object

enabled

Type: boolean

Whether the field hint is enabled.

text

Type: string

Hint text displayed for the field.

Example: example

Field hint settings.

Example

{
  "enabled": true,
  "text": "example"
}

markupType

Type: string

Markup type used to render field values.

Enum: none, md, html

subTotalsSettings

Type: object

enabled

Type: boolean

Whether to display subtotals for the field.

Subtotal settings.

Example

{
  "enabled": true
}

Fields included in the hierarchy.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {
        "colorType": "gradient",
        "settings": {}
      },
      "showLabels": true,
      "align": "left",
      "scale": {
        "mode": "auto"
      },
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {
          "mountedColors": {},
          "palette": "example"
        },
        "gradientState": {
          "thresholdsMode": "auto",
          "leftThreshold": "example",
          "middleThreshold": "example",
          "rightThreshold": "example",
          "gradientPalette": "example",
          "gradientMode": "2-point",
          "reversed": true,
          "nullMode": "ignore"
        },
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {
        "mode": "auto"
      },
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "datasetId": "example"
  }
]

guid

Type: string

Hierarchy identifier.

Example: example

title

Type: string

Hierarchy display title.

Example: example

backgroundSettings

Type: object

colorFieldGuid

Type: string

Identifier of the field used to color the background.

Example: example

enabled

Type: boolean

Whether conditional background coloring is enabled.

settings

Type: object

gradientState

Type: object

gradientMode	Type: string Gradient type. Enum: `2-point`, `3-point`
gradientPalette	Type: string Gradient palette identifier. Example: `example`
leftThreshold	Type: string Lower gradient threshold. Example: `example`
middleThreshold	Type: string Middle gradient threshold. Example: `example`
nullMode	Type: string How null values are colored. Enum: `ignore`, `as-0`
reversed	Type: boolean Whether to reverse the gradient palette.
rightThreshold	Type: string Upper gradient threshold. Example: `example`
thresholdsMode	Type: string Mode used to calculate gradient thresholds. Enum: `auto`, `manual`

Continuous gradient settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "reversed": true,
  "nullMode": "ignore"
}

isContinuous

Type: boolean

Whether to use continuous instead of discrete coloring.

paletteState

Type: object

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

palette

Type: string

Color palette identifier.

Example: example

Discrete palette settings.

Example

{
  "mountedColors": {},
  "palette": "example"
}

Background color configuration.

Example

{
  "paletteState": {
    "mountedColors": {},
    "palette": "example"
  },
  "gradientState": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "reversed": true,
    "nullMode": "ignore"
  },
  "isContinuous": true
}

settingsId

Type: string

Identifier of the background color settings.

Example: example

Conditional background settings.

Example

{
  "enabled": true,
  "colorFieldGuid": "example",
  "settingsId": "example",
  "settings": {
    "paletteState": {
      "mountedColors": {},
      "palette": "example"
    },
    "gradientState": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "reversed": true,
      "nullMode": "ignore"
    },
    "isContinuous": true
  }
}

barsSettings

Type: object

align

Type: string

Bar alignment within table cells.

Enum: left, right, default

colorSettings

One of 3 types

Type: object

colorType

Type: string

Use a gradient to color bars.

Const: gradient

Example: example

settings

Type: object

gradientType

Type: string

Gradient type.

Enum: 2-point, 3-point

thresholds

One of 2 types

Type: object

mode

Type: string

Calculate gradient thresholds automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

max	Type: string Upper gradient threshold. Example: `example`
min	Type: string Lower gradient threshold. Example: `example`
mode	Type: string Use manually specified gradient thresholds. Const: `manual` Example: `example`
mid	Type: string Middle gradient threshold. Example: `example`

Example

{
  "mode": "manual",
  "min": "example",
  "mid": "example",
  "max": "example"
}

Thresholds that define the gradient color scale.

Example

{
  "mode": "auto"
}

palette

Type: string

Color palette identifier.

Example: example

reversed

Type: boolean

Whether to reverse the color palette.

Gradient bar color settings.

Example

{
  "gradientType": "2-point",
  "thresholds": {
    "mode": "auto"
  },
  "palette": "example",
  "reversed": true
}

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

Type: object

colorType

Type: string

Use one color for all bars.

Const: one-color

Example: example

settings

Type: object

color

Type: string

Custom bar color.

Example: example

colorIndex

Type: number

Selected color index in the palette.

palette

Type: string

Color palette identifier.

Example: example

Single-color bar settings.

Example

{
  "palette": "example",
  "colorIndex": 0.5,
  "color": "example"
}

Example

{
  "colorType": "one-color",
  "settings": {
    "palette": "example",
    "colorIndex": 0.5,
    "color": "example"
  }
}

Type: object

colorType

Type: string

Use separate colors for negative and positive bars.

Const: two-color

Example: example

settings

Type: object

negativeColor	Type: string Custom color for negative values. Example: `example`
negativeColorIndex	Type: number Palette color index for negative values.
palette	Type: string Color palette identifier. Example: `example`
positiveColor	Type: string Custom color for positive values. Example: `example`
positiveColorIndex	Type: number Palette color index for positive values.

Two-color bar settings.

Example

{
  "palette": "example",
  "negativeColorIndex": 0.5,
  "negativeColor": "example",
  "positiveColorIndex": 0.5,
  "positiveColor": "example"
}

Example

{
  "colorType": "two-color",
  "settings": {
    "palette": "example",
    "negativeColorIndex": 0.5,
    "negativeColor": "example",
    "positiveColorIndex": 0.5,
    "positiveColor": "example"
  }
}

Bar color settings.

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

enabled

Type: boolean

Whether to display bars in table cells.

scale

One of 2 types

Type: object

mode

Type: string

Calculate the bar scale automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

mode

Type: string

Use a manually specified bar scale.

Const: manual

Example: example

settings

Type: object

max

Type: string

Manual maximum scale value.

Example: example

min

Type: string

Manual minimum scale value.

Example: example

Manual bar scale boundaries.

Example

{
  "min": "example",
  "max": "example"
}

Example

{
  "mode": "manual",
  "settings": {
    "min": "example",
    "max": "example"
  }
}

Scale used to calculate bar lengths.

Example

{
  "mode": "auto"
}

showBarsInTotals

Type: boolean

Whether to display bars in total rows.

showLabels

Type: boolean

Whether to display values over bars.

In-cell bar settings.

Example

{
  "enabled": true,
  "colorSettings": {
    "colorType": "gradient",
    "settings": {
      "gradientType": "2-point",
      "thresholds": {},
      "palette": "example",
      "reversed": true
    }
  },
  "showLabels": true,
  "align": "left",
  "scale": {
    "mode": "auto"
  },
  "showBarsInTotals": true
}

columnSettings

Type: object

width

One of 3 types

Type: object

mode

Type: string

Calculate the column width automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```
Type: object

mode

Type: string

Set the column width as a percentage.

Const: percent

Example: example

value

Type: string

Column width percentage.

Example: example
Example
```
{
  "mode": "percent",
  "value": "example"
}
```
Type: object

mode

Type: string

Set the column width in pixels.

Const: pixel

Example: example

value

Type: string

Column width in pixels.

Example: example
Example
```
{
  "mode": "pixel",
  "value": "example"
}
```

Table column width settings.

Example

{
  "mode": "auto"
}

horizontalAlignment

Type: string

Horizontal alignment of values in the column.

Enum: auto, start, center, end

Table column settings.

Example

{
  "width": {
    "mode": "auto"
  },
  "horizontalAlignment": "auto"
}

fakeTitle

Type: string

Chart-local display title override for the field.

Example: example

format

Type: string

Date or datetime format, separate from numeric formatting.

Example: example

formatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric formatting settings for the field.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

hideLabelMode

Type: string

Whether to hide the field label.

Enum: show, hide

hintSettings

Type: object

enabled

Type: boolean

Whether the field hint is enabled.

text

Type: string

Hint text displayed for the field.

Example: example

Field hint settings.

Example

{
  "enabled": true,
  "text": "example"
}

markupType

Type: string

Markup type used to render field values.

Enum: none, md, html

subTotalsSettings

Type: object

enabled

Type: boolean

Whether to display subtotals for the field.

Subtotal settings.

Example

{
  "enabled": true
}

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {
      "colorType": "gradient",
      "settings": {
        "gradientType": "2-point",
        "thresholds": null,
        "palette": "example",
        "reversed": true
      }
    },
    "showLabels": true,
    "align": "left",
    "scale": {
      "mode": "auto"
    },
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {
        "mountedColors": {},
        "palette": "example"
      },
      "gradientState": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "reversed": true,
        "nullMode": "ignore"
      },
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {
      "mode": "auto"
    },
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "guid": "example",
  "title": "example",
  "data_type": "hierarchy",
  "fields": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": {},
        "showLabels": true,
        "align": "left",
        "scale": {},
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {
          "paletteState": {},
          "gradientState": {},
          "isContinuous": true
        }
      },
      "columnSettings": {
        "width": {},
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

datasetId

Type: string

Identifier of the dataset containing the field.

Example: example

guid

Type: string

Field identifier.

Example: example

backgroundSettings

Type: object

colorFieldGuid

Type: string

Identifier of the field used to color the background.

Example: example

enabled

Type: boolean

Whether conditional background coloring is enabled.

settings

Type: object

gradientState

Type: object

gradientMode	Type: string Gradient type. Enum: `2-point`, `3-point`
gradientPalette	Type: string Gradient palette identifier. Example: `example`
leftThreshold	Type: string Lower gradient threshold. Example: `example`
middleThreshold	Type: string Middle gradient threshold. Example: `example`
nullMode	Type: string How null values are colored. Enum: `ignore`, `as-0`
reversed	Type: boolean Whether to reverse the gradient palette.
rightThreshold	Type: string Upper gradient threshold. Example: `example`
thresholdsMode	Type: string Mode used to calculate gradient thresholds. Enum: `auto`, `manual`

Continuous gradient settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "reversed": true,
  "nullMode": "ignore"
}

isContinuous

Type: boolean

Whether to use continuous instead of discrete coloring.

paletteState

Type: object

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

palette

Type: string

Color palette identifier.

Example: example

Discrete palette settings.

Example

{
  "mountedColors": {},
  "palette": "example"
}

Background color configuration.

Example

{
  "paletteState": {
    "mountedColors": {},
    "palette": "example"
  },
  "gradientState": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "reversed": true,
    "nullMode": "ignore"
  },
  "isContinuous": true
}

settingsId

Type: string

Identifier of the background color settings.

Example: example

Conditional background settings.

Example

{
  "enabled": true,
  "colorFieldGuid": "example",
  "settingsId": "example",
  "settings": {
    "paletteState": {
      "mountedColors": {},
      "palette": "example"
    },
    "gradientState": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "reversed": true,
      "nullMode": "ignore"
    },
    "isContinuous": true
  }
}

barsSettings

Type: object

align

Type: string

Bar alignment within table cells.

Enum: left, right, default

colorSettings

One of 3 types

Type: object

colorType

Type: string

Use a gradient to color bars.

Const: gradient

Example: example

settings

Type: object

gradientType

Type: string

Gradient type.

Enum: 2-point, 3-point

thresholds

One of 2 types

Type: object

mode

Type: string

Calculate gradient thresholds automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

max	Type: string Upper gradient threshold. Example: `example`
min	Type: string Lower gradient threshold. Example: `example`
mode	Type: string Use manually specified gradient thresholds. Const: `manual` Example: `example`
mid	Type: string Middle gradient threshold. Example: `example`

Example

{
  "mode": "manual",
  "min": "example",
  "mid": "example",
  "max": "example"
}

Thresholds that define the gradient color scale.

Example

{
  "mode": "auto"
}

palette

Type: string

Color palette identifier.

Example: example

reversed

Type: boolean

Whether to reverse the color palette.

Gradient bar color settings.

Example

{
  "gradientType": "2-point",
  "thresholds": {
    "mode": "auto"
  },
  "palette": "example",
  "reversed": true
}

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

Type: object

colorType

Type: string

Use one color for all bars.

Const: one-color

Example: example

settings

Type: object

color

Type: string

Custom bar color.

Example: example

colorIndex

Type: number

Selected color index in the palette.

palette

Type: string

Color palette identifier.

Example: example

Single-color bar settings.

Example

{
  "palette": "example",
  "colorIndex": 0.5,
  "color": "example"
}

Example

{
  "colorType": "one-color",
  "settings": {
    "palette": "example",
    "colorIndex": 0.5,
    "color": "example"
  }
}

Type: object

colorType

Type: string

Use separate colors for negative and positive bars.

Const: two-color

Example: example

settings

Type: object

negativeColor	Type: string Custom color for negative values. Example: `example`
negativeColorIndex	Type: number Palette color index for negative values.
palette	Type: string Color palette identifier. Example: `example`
positiveColor	Type: string Custom color for positive values. Example: `example`
positiveColorIndex	Type: number Palette color index for positive values.

Two-color bar settings.

Example

{
  "palette": "example",
  "negativeColorIndex": 0.5,
  "negativeColor": "example",
  "positiveColorIndex": 0.5,
  "positiveColor": "example"
}

Example

{
  "colorType": "two-color",
  "settings": {
    "palette": "example",
    "negativeColorIndex": 0.5,
    "negativeColor": "example",
    "positiveColorIndex": 0.5,
    "positiveColor": "example"
  }
}

Bar color settings.

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

enabled

Type: boolean

Whether to display bars in table cells.

scale

One of 2 types

Type: object

mode

Type: string

Calculate the bar scale automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

mode

Type: string

Use a manually specified bar scale.

Const: manual

Example: example

settings

Type: object

max

Type: string

Manual maximum scale value.

Example: example

min

Type: string

Manual minimum scale value.

Example: example

Manual bar scale boundaries.

Example

{
  "min": "example",
  "max": "example"
}

Example

{
  "mode": "manual",
  "settings": {
    "min": "example",
    "max": "example"
  }
}

Scale used to calculate bar lengths.

Example

{
  "mode": "auto"
}

showBarsInTotals

Type: boolean

Whether to display bars in total rows.

showLabels

Type: boolean

Whether to display values over bars.

In-cell bar settings.

Example

{
  "enabled": true,
  "colorSettings": {
    "colorType": "gradient",
    "settings": {
      "gradientType": "2-point",
      "thresholds": {},
      "palette": "example",
      "reversed": true
    }
  },
  "showLabels": true,
  "align": "left",
  "scale": {
    "mode": "auto"
  },
  "showBarsInTotals": true
}

columnSettings

Type: object

width

One of 3 types

Type: object

mode

Type: string

Calculate the column width automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```
Type: object

mode

Type: string

Set the column width as a percentage.

Const: percent

Example: example

value

Type: string

Column width percentage.

Example: example
Example
```
{
  "mode": "percent",
  "value": "example"
}
```
Type: object

mode

Type: string

Set the column width in pixels.

Const: pixel

Example: example

value

Type: string

Column width in pixels.

Example: example
Example
```
{
  "mode": "pixel",
  "value": "example"
}
```

Table column width settings.

Example

{
  "mode": "auto"
}

horizontalAlignment

Type: string

Horizontal alignment of values in the column.

Enum: auto, start, center, end

Table column settings.

Example

{
  "width": {
    "mode": "auto"
  },
  "horizontalAlignment": "auto"
}

fakeTitle

Type: string

Chart-local display title override for the field.

Example: example

format

Type: string

Date or datetime format, separate from numeric formatting.

Example: example

formatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric formatting settings for the field.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

hideLabelMode

Type: string

Whether to hide the field label.

Enum: show, hide

hintSettings

Type: object

enabled

Type: boolean

Whether the field hint is enabled.

text

Type: string

Hint text displayed for the field.

Example: example

Field hint settings.

Example

{
  "enabled": true,
  "text": "example"
}

markupType

Type: string

Markup type used to render field values.

Enum: none, md, html

subTotalsSettings

Type: object

enabled

Type: boolean

Whether to display subtotals for the field.

Subtotal settings.

Example

{
  "enabled": true
}

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {
      "colorType": "gradient",
      "settings": {
        "gradientType": "2-point",
        "thresholds": null,
        "palette": "example",
        "reversed": true
      }
    },
    "showLabels": true,
    "align": "left",
    "scale": {
      "mode": "auto"
    },
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {
        "mountedColors": {},
        "palette": "example"
      },
      "gradientState": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "reversed": true,
        "nullMode": "ignore"
      },
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {
      "mode": "auto"
    },
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "guid": "example",
  "datasetId": "example"
}

Type: object

data_type

Type: string

String data type of the Measure Names pseudo-field.

Const: string

Example: example

title

Type: string

Title identifying the Measure Names pseudo-field.

Const: Measure Names

Example: example

type

Type: string

Field type identifying a pseudo-field.

Const: PSEUDO

Example: example

backgroundSettings

Type: object

colorFieldGuid

Type: string

Identifier of the field used to color the background.

Example: example

enabled

Type: boolean

Whether conditional background coloring is enabled.

settings

Type: object

gradientState

Type: object

gradientMode	Type: string Gradient type. Enum: `2-point`, `3-point`
gradientPalette	Type: string Gradient palette identifier. Example: `example`
leftThreshold	Type: string Lower gradient threshold. Example: `example`
middleThreshold	Type: string Middle gradient threshold. Example: `example`
nullMode	Type: string How null values are colored. Enum: `ignore`, `as-0`
reversed	Type: boolean Whether to reverse the gradient palette.
rightThreshold	Type: string Upper gradient threshold. Example: `example`
thresholdsMode	Type: string Mode used to calculate gradient thresholds. Enum: `auto`, `manual`

Continuous gradient settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "reversed": true,
  "nullMode": "ignore"
}

isContinuous

Type: boolean

Whether to use continuous instead of discrete coloring.

paletteState

Type: object

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

palette

Type: string

Color palette identifier.

Example: example

Discrete palette settings.

Example

{
  "mountedColors": {},
  "palette": "example"
}

Background color configuration.

Example

{
  "paletteState": {
    "mountedColors": {},
    "palette": "example"
  },
  "gradientState": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "reversed": true,
    "nullMode": "ignore"
  },
  "isContinuous": true
}

settingsId

Type: string

Identifier of the background color settings.

Example: example

Conditional background settings.

Example

{
  "enabled": true,
  "colorFieldGuid": "example",
  "settingsId": "example",
  "settings": {
    "paletteState": {
      "mountedColors": {},
      "palette": "example"
    },
    "gradientState": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "reversed": true,
      "nullMode": "ignore"
    },
    "isContinuous": true
  }
}

barsSettings

Type: object

align

Type: string

Bar alignment within table cells.

Enum: left, right, default

colorSettings

One of 3 types

Type: object

colorType

Type: string

Use a gradient to color bars.

Const: gradient

Example: example

settings

Type: object

gradientType

Type: string

Gradient type.

Enum: 2-point, 3-point

thresholds

One of 2 types

Type: object

mode

Type: string

Calculate gradient thresholds automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

max	Type: string Upper gradient threshold. Example: `example`
min	Type: string Lower gradient threshold. Example: `example`
mode	Type: string Use manually specified gradient thresholds. Const: `manual` Example: `example`
mid	Type: string Middle gradient threshold. Example: `example`

Example

{
  "mode": "manual",
  "min": "example",
  "mid": "example",
  "max": "example"
}

Thresholds that define the gradient color scale.

Example

{
  "mode": "auto"
}

palette

Type: string

Color palette identifier.

Example: example

reversed

Type: boolean

Whether to reverse the color palette.

Gradient bar color settings.

Example

{
  "gradientType": "2-point",
  "thresholds": {
    "mode": "auto"
  },
  "palette": "example",
  "reversed": true
}

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

Type: object

colorType

Type: string

Use one color for all bars.

Const: one-color

Example: example

settings

Type: object

color

Type: string

Custom bar color.

Example: example

colorIndex

Type: number

Selected color index in the palette.

palette

Type: string

Color palette identifier.

Example: example

Single-color bar settings.

Example

{
  "palette": "example",
  "colorIndex": 0.5,
  "color": "example"
}

Example

{
  "colorType": "one-color",
  "settings": {
    "palette": "example",
    "colorIndex": 0.5,
    "color": "example"
  }
}

Type: object

colorType

Type: string

Use separate colors for negative and positive bars.

Const: two-color

Example: example

settings

Type: object

negativeColor	Type: string Custom color for negative values. Example: `example`
negativeColorIndex	Type: number Palette color index for negative values.
palette	Type: string Color palette identifier. Example: `example`
positiveColor	Type: string Custom color for positive values. Example: `example`
positiveColorIndex	Type: number Palette color index for positive values.

Two-color bar settings.

Example

{
  "palette": "example",
  "negativeColorIndex": 0.5,
  "negativeColor": "example",
  "positiveColorIndex": 0.5,
  "positiveColor": "example"
}

Example

{
  "colorType": "two-color",
  "settings": {
    "palette": "example",
    "negativeColorIndex": 0.5,
    "negativeColor": "example",
    "positiveColorIndex": 0.5,
    "positiveColor": "example"
  }
}

Bar color settings.

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

enabled

Type: boolean

Whether to display bars in table cells.

scale

One of 2 types

Type: object

mode

Type: string

Calculate the bar scale automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

mode

Type: string

Use a manually specified bar scale.

Const: manual

Example: example

settings

Type: object

max

Type: string

Manual maximum scale value.

Example: example

min

Type: string

Manual minimum scale value.

Example: example

Manual bar scale boundaries.

Example

{
  "min": "example",
  "max": "example"
}

Example

{
  "mode": "manual",
  "settings": {
    "min": "example",
    "max": "example"
  }
}

Scale used to calculate bar lengths.

Example

{
  "mode": "auto"
}

showBarsInTotals

Type: boolean

Whether to display bars in total rows.

showLabels

Type: boolean

Whether to display values over bars.

In-cell bar settings.

Example

{
  "enabled": true,
  "colorSettings": {
    "colorType": "gradient",
    "settings": {
      "gradientType": "2-point",
      "thresholds": {},
      "palette": "example",
      "reversed": true
    }
  },
  "showLabels": true,
  "align": "left",
  "scale": {
    "mode": "auto"
  },
  "showBarsInTotals": true
}

columnSettings

Type: object

width

One of 3 types

Type: object

mode

Type: string

Calculate the column width automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```
Type: object

mode

Type: string

Set the column width as a percentage.

Const: percent

Example: example

value

Type: string

Column width percentage.

Example: example
Example
```
{
  "mode": "percent",
  "value": "example"
}
```
Type: object

mode

Type: string

Set the column width in pixels.

Const: pixel

Example: example

value

Type: string

Column width in pixels.

Example: example
Example
```
{
  "mode": "pixel",
  "value": "example"
}
```

Table column width settings.

Example

{
  "mode": "auto"
}

horizontalAlignment

Type: string

Horizontal alignment of values in the column.

Enum: auto, start, center, end

Table column settings.

Example

{
  "width": {
    "mode": "auto"
  },
  "horizontalAlignment": "auto"
}

fakeTitle

Type: string

Chart-local display title override for the field.

Example: example

format

Type: string

Date or datetime format, separate from numeric formatting.

Example: example

formatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric formatting settings for the field.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

hideLabelMode

Type: string

Whether to hide the field label.

Enum: show, hide

hintSettings

Type: object

enabled

Type: boolean

Whether the field hint is enabled.

text

Type: string

Hint text displayed for the field.

Example: example

Field hint settings.

Example

{
  "enabled": true,
  "text": "example"
}

markupType

Type: string

Markup type used to render field values.

Enum: none, md, html

subTotalsSettings

Type: object

enabled

Type: boolean

Whether to display subtotals for the field.

Subtotal settings.

Example

{
  "enabled": true
}

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {
      "colorType": "gradient",
      "settings": {
        "gradientType": "2-point",
        "thresholds": null,
        "palette": "example",
        "reversed": true
      }
    },
    "showLabels": true,
    "align": "left",
    "scale": {
      "mode": "auto"
    },
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {
        "mountedColors": {},
        "palette": "example"
      },
      "gradientState": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "reversed": true,
        "nullMode": "ignore"
      },
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {
      "mode": "auto"
    },
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "title": "Measure Names",
  "type": "PSEUDO",
  "data_type": "string"
}

Type: object

data_type

Type: string

Numeric data type of the Measure Values pseudo-field.

Const: float

Example: example

title

Type: string

Title identifying the Measure Values pseudo-field.

Const: Measure Values

Example: example

type

Type: string

Field type identifying a pseudo-field.

Const: PSEUDO

Example: example

backgroundSettings

Type: object

colorFieldGuid

Type: string

Identifier of the field used to color the background.

Example: example

enabled

Type: boolean

Whether conditional background coloring is enabled.

settings

Type: object

gradientState

Type: object

gradientMode	Type: string Gradient type. Enum: `2-point`, `3-point`
gradientPalette	Type: string Gradient palette identifier. Example: `example`
leftThreshold	Type: string Lower gradient threshold. Example: `example`
middleThreshold	Type: string Middle gradient threshold. Example: `example`
nullMode	Type: string How null values are colored. Enum: `ignore`, `as-0`
reversed	Type: boolean Whether to reverse the gradient palette.
rightThreshold	Type: string Upper gradient threshold. Example: `example`
thresholdsMode	Type: string Mode used to calculate gradient thresholds. Enum: `auto`, `manual`

Continuous gradient settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "reversed": true,
  "nullMode": "ignore"
}

isContinuous

Type: boolean

Whether to use continuous instead of discrete coloring.

paletteState

Type: object

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

palette

Type: string

Color palette identifier.

Example: example

Discrete palette settings.

Example

{
  "mountedColors": {},
  "palette": "example"
}

Background color configuration.

Example

{
  "paletteState": {
    "mountedColors": {},
    "palette": "example"
  },
  "gradientState": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "reversed": true,
    "nullMode": "ignore"
  },
  "isContinuous": true
}

settingsId

Type: string

Identifier of the background color settings.

Example: example

Conditional background settings.

Example

{
  "enabled": true,
  "colorFieldGuid": "example",
  "settingsId": "example",
  "settings": {
    "paletteState": {
      "mountedColors": {},
      "palette": "example"
    },
    "gradientState": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "reversed": true,
      "nullMode": "ignore"
    },
    "isContinuous": true
  }
}

barsSettings

Type: object

align

Type: string

Bar alignment within table cells.

Enum: left, right, default

colorSettings

One of 3 types

Type: object

colorType

Type: string

Use a gradient to color bars.

Const: gradient

Example: example

settings

Type: object

gradientType

Type: string

Gradient type.

Enum: 2-point, 3-point

thresholds

One of 2 types

Type: object

mode

Type: string

Calculate gradient thresholds automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

max	Type: string Upper gradient threshold. Example: `example`
min	Type: string Lower gradient threshold. Example: `example`
mode	Type: string Use manually specified gradient thresholds. Const: `manual` Example: `example`
mid	Type: string Middle gradient threshold. Example: `example`

Example

{
  "mode": "manual",
  "min": "example",
  "mid": "example",
  "max": "example"
}

Thresholds that define the gradient color scale.

Example

{
  "mode": "auto"
}

palette

Type: string

Color palette identifier.

Example: example

reversed

Type: boolean

Whether to reverse the color palette.

Gradient bar color settings.

Example

{
  "gradientType": "2-point",
  "thresholds": {
    "mode": "auto"
  },
  "palette": "example",
  "reversed": true
}

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

Type: object

colorType

Type: string

Use one color for all bars.

Const: one-color

Example: example

settings

Type: object

color

Type: string

Custom bar color.

Example: example

colorIndex

Type: number

Selected color index in the palette.

palette

Type: string

Color palette identifier.

Example: example

Single-color bar settings.

Example

{
  "palette": "example",
  "colorIndex": 0.5,
  "color": "example"
}

Example

{
  "colorType": "one-color",
  "settings": {
    "palette": "example",
    "colorIndex": 0.5,
    "color": "example"
  }
}

Type: object

colorType

Type: string

Use separate colors for negative and positive bars.

Const: two-color

Example: example

settings

Type: object

negativeColor	Type: string Custom color for negative values. Example: `example`
negativeColorIndex	Type: number Palette color index for negative values.
palette	Type: string Color palette identifier. Example: `example`
positiveColor	Type: string Custom color for positive values. Example: `example`
positiveColorIndex	Type: number Palette color index for positive values.

Two-color bar settings.

Example

{
  "palette": "example",
  "negativeColorIndex": 0.5,
  "negativeColor": "example",
  "positiveColorIndex": 0.5,
  "positiveColor": "example"
}

Example

{
  "colorType": "two-color",
  "settings": {
    "palette": "example",
    "negativeColorIndex": 0.5,
    "negativeColor": "example",
    "positiveColorIndex": 0.5,
    "positiveColor": "example"
  }
}

Bar color settings.

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

enabled

Type: boolean

Whether to display bars in table cells.

scale

One of 2 types

Type: object

mode

Type: string

Calculate the bar scale automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

mode

Type: string

Use a manually specified bar scale.

Const: manual

Example: example

settings

Type: object

max

Type: string

Manual maximum scale value.

Example: example

min

Type: string

Manual minimum scale value.

Example: example

Manual bar scale boundaries.

Example

{
  "min": "example",
  "max": "example"
}

Example

{
  "mode": "manual",
  "settings": {
    "min": "example",
    "max": "example"
  }
}

Scale used to calculate bar lengths.

Example

{
  "mode": "auto"
}

showBarsInTotals

Type: boolean

Whether to display bars in total rows.

showLabels

Type: boolean

Whether to display values over bars.

In-cell bar settings.

Example

{
  "enabled": true,
  "colorSettings": {
    "colorType": "gradient",
    "settings": {
      "gradientType": "2-point",
      "thresholds": {},
      "palette": "example",
      "reversed": true
    }
  },
  "showLabels": true,
  "align": "left",
  "scale": {
    "mode": "auto"
  },
  "showBarsInTotals": true
}

columnSettings

Type: object

width

One of 3 types

Type: object

mode

Type: string

Calculate the column width automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```
Type: object

mode

Type: string

Set the column width as a percentage.

Const: percent

Example: example

value

Type: string

Column width percentage.

Example: example
Example
```
{
  "mode": "percent",
  "value": "example"
}
```
Type: object

mode

Type: string

Set the column width in pixels.

Const: pixel

Example: example

value

Type: string

Column width in pixels.

Example: example
Example
```
{
  "mode": "pixel",
  "value": "example"
}
```

Table column width settings.

Example

{
  "mode": "auto"
}

horizontalAlignment

Type: string

Horizontal alignment of values in the column.

Enum: auto, start, center, end

Table column settings.

Example

{
  "width": {
    "mode": "auto"
  },
  "horizontalAlignment": "auto"
}

fakeTitle

Type: string

Chart-local display title override for the field.

Example: example

format

Type: string

Date or datetime format, separate from numeric formatting.

Example: example

formatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric formatting settings for the field.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

hideLabelMode

Type: string

Whether to hide the field label.

Enum: show, hide

hintSettings

Type: object

enabled

Type: boolean

Whether the field hint is enabled.

text

Type: string

Hint text displayed for the field.

Example: example

Field hint settings.

Example

{
  "enabled": true,
  "text": "example"
}

markupType

Type: string

Markup type used to render field values.

Enum: none, md, html

subTotalsSettings

Type: object

enabled

Type: boolean

Whether to display subtotals for the field.

Subtotal settings.

Example

{
  "enabled": true
}

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {
      "colorType": "gradient",
      "settings": {
        "gradientType": "2-point",
        "thresholds": null,
        "palette": "example",
        "reversed": true
      }
    },
    "showLabels": true,
    "align": "left",
    "scale": {
      "mode": "auto"
    },
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {
        "mountedColors": {},
        "palette": "example"
      },
      "gradientState": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "reversed": true,
        "nullMode": "ignore"
      },
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {
      "mode": "auto"
    },
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "title": "Measure Values",
  "type": "PSEUDO",
  "data_type": "float"
}

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {
      "colorType": "gradient",
      "settings": {}
    },
    "showLabels": true,
    "align": "left",
    "scale": {
      "mode": "auto"
    },
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {
        "mountedColors": {},
        "palette": "example"
      },
      "gradientState": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "reversed": true,
        "nullMode": "ignore"
      },
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {
      "mode": "auto"
    },
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "guid": "example",
  "title": "example",
  "data_type": "hierarchy",
  "fields": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

WizardV1LineShapeSettingsSchema

Name	Description
linecap	Type: string Shape used at line endpoints. Enum: `butt`, `round`, `square`, `none`
linejoin	Type: string Shape used at line segment joins. Enum: `bevel`, `round`, `miter`, `unset`
lineWidth	Any of 2 types Type: number Type: string Const: `auto` Example: `example` Line width in pixels or automatic width. Example: `0.5`

Example

{
  "lineWidth": 0.5,
  "linecap": "butt",
  "linejoin": "bevel"
}

WizardLabelsItemSchema

All of 2 types

Type: WizardFieldSchema

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {
      "colorType": "gradient",
      "settings": {}
    },
    "showLabels": true,
    "align": "left",
    "scale": {
      "mode": "auto"
    },
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {
        "mountedColors": {},
        "palette": "example"
      },
      "gradientState": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "reversed": true,
        "nullMode": "ignore"
      },
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {
      "mode": "auto"
    },
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "guid": "example",
  "title": "example",
  "data_type": "hierarchy",
  "fields": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

labelPercentageBase

Type: string

Base used to calculate percentage labels.

Enum: auto, first, previous
Example
```
{
  "labelPercentageBase": "auto"
}
```

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {},
    "showLabels": true,
    "align": "left",
    "scale": {},
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {},
      "gradientState": {},
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {},
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "guid": "example",
  "title": "example",
  "data_type": "hierarchy",
  "fields": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "datasetId": "example"
    }
  ],
  "labelPercentageBase": "auto"
}

WizardPseudoFieldSchema

Any of 2 types

Type: object

data_type

Type: string

String data type of the Measure Names pseudo-field.

Const: string

Example: example

title

Type: string

Title identifying the Measure Names pseudo-field.

Const: Measure Names

Example: example

type

Type: string

Field type identifying a pseudo-field.

Const: PSEUDO

Example: example

backgroundSettings

Type: object

colorFieldGuid

Type: string

Identifier of the field used to color the background.

Example: example

enabled

Type: boolean

Whether conditional background coloring is enabled.

settings

Type: object

gradientState

Type: object

gradientMode	Type: string Gradient type. Enum: `2-point`, `3-point`
gradientPalette	Type: string Gradient palette identifier. Example: `example`
leftThreshold	Type: string Lower gradient threshold. Example: `example`
middleThreshold	Type: string Middle gradient threshold. Example: `example`
nullMode	Type: string How null values are colored. Enum: `ignore`, `as-0`
reversed	Type: boolean Whether to reverse the gradient palette.
rightThreshold	Type: string Upper gradient threshold. Example: `example`
thresholdsMode	Type: string Mode used to calculate gradient thresholds. Enum: `auto`, `manual`

Continuous gradient settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "reversed": true,
  "nullMode": "ignore"
}

isContinuous

Type: boolean

Whether to use continuous instead of discrete coloring.

paletteState

Type: object

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

palette

Type: string

Color palette identifier.

Example: example

Discrete palette settings.

Example

{
  "mountedColors": {},
  "palette": "example"
}

Background color configuration.

Example

{
  "paletteState": {
    "mountedColors": {},
    "palette": "example"
  },
  "gradientState": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "reversed": true,
    "nullMode": "ignore"
  },
  "isContinuous": true
}

settingsId

Type: string

Identifier of the background color settings.

Example: example

Conditional background settings.

Example

{
  "enabled": true,
  "colorFieldGuid": "example",
  "settingsId": "example",
  "settings": {
    "paletteState": {
      "mountedColors": {},
      "palette": "example"
    },
    "gradientState": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "reversed": true,
      "nullMode": "ignore"
    },
    "isContinuous": true
  }
}

barsSettings

Type: object

align

Type: string

Bar alignment within table cells.

Enum: left, right, default

colorSettings

One of 3 types

Type: object

colorType

Type: string

Use a gradient to color bars.

Const: gradient

Example: example

settings

Type: object

gradientType

Type: string

Gradient type.

Enum: 2-point, 3-point

thresholds

One of 2 types

Type: object

mode

Type: string

Calculate gradient thresholds automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

max	Type: string Upper gradient threshold. Example: `example`
min	Type: string Lower gradient threshold. Example: `example`
mode	Type: string Use manually specified gradient thresholds. Const: `manual` Example: `example`
mid	Type: string Middle gradient threshold. Example: `example`

Example

{
  "mode": "manual",
  "min": "example",
  "mid": "example",
  "max": "example"
}

Thresholds that define the gradient color scale.

Example

{
  "mode": "auto"
}

palette

Type: string

Color palette identifier.

Example: example

reversed

Type: boolean

Whether to reverse the color palette.

Gradient bar color settings.

Example

{
  "gradientType": "2-point",
  "thresholds": {
    "mode": "auto"
  },
  "palette": "example",
  "reversed": true
}

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

Type: object

colorType

Type: string

Use one color for all bars.

Const: one-color

Example: example

settings

Type: object

color

Type: string

Custom bar color.

Example: example

colorIndex

Type: number

Selected color index in the palette.

palette

Type: string

Color palette identifier.

Example: example

Single-color bar settings.

Example

{
  "palette": "example",
  "colorIndex": 0.5,
  "color": "example"
}

Example

{
  "colorType": "one-color",
  "settings": {
    "palette": "example",
    "colorIndex": 0.5,
    "color": "example"
  }
}

Type: object

colorType

Type: string

Use separate colors for negative and positive bars.

Const: two-color

Example: example

settings

Type: object

negativeColor	Type: string Custom color for negative values. Example: `example`
negativeColorIndex	Type: number Palette color index for negative values.
palette	Type: string Color palette identifier. Example: `example`
positiveColor	Type: string Custom color for positive values. Example: `example`
positiveColorIndex	Type: number Palette color index for positive values.

Two-color bar settings.

Example

{
  "palette": "example",
  "negativeColorIndex": 0.5,
  "negativeColor": "example",
  "positiveColorIndex": 0.5,
  "positiveColor": "example"
}

Example

{
  "colorType": "two-color",
  "settings": {
    "palette": "example",
    "negativeColorIndex": 0.5,
    "negativeColor": "example",
    "positiveColorIndex": 0.5,
    "positiveColor": "example"
  }
}

Bar color settings.

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

enabled

Type: boolean

Whether to display bars in table cells.

scale

One of 2 types

Type: object

mode

Type: string

Calculate the bar scale automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

mode

Type: string

Use a manually specified bar scale.

Const: manual

Example: example

settings

Type: object

max

Type: string

Manual maximum scale value.

Example: example

min

Type: string

Manual minimum scale value.

Example: example

Manual bar scale boundaries.

Example

{
  "min": "example",
  "max": "example"
}

Example

{
  "mode": "manual",
  "settings": {
    "min": "example",
    "max": "example"
  }
}

Scale used to calculate bar lengths.

Example

{
  "mode": "auto"
}

showBarsInTotals

Type: boolean

Whether to display bars in total rows.

showLabels

Type: boolean

Whether to display values over bars.

In-cell bar settings.

Example

{
  "enabled": true,
  "colorSettings": {
    "colorType": "gradient",
    "settings": {
      "gradientType": "2-point",
      "thresholds": {},
      "palette": "example",
      "reversed": true
    }
  },
  "showLabels": true,
  "align": "left",
  "scale": {
    "mode": "auto"
  },
  "showBarsInTotals": true
}

columnSettings

Type: object

width

One of 3 types

Type: object

mode

Type: string

Calculate the column width automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```
Type: object

mode

Type: string

Set the column width as a percentage.

Const: percent

Example: example

value

Type: string

Column width percentage.

Example: example
Example
```
{
  "mode": "percent",
  "value": "example"
}
```
Type: object

mode

Type: string

Set the column width in pixels.

Const: pixel

Example: example

value

Type: string

Column width in pixels.

Example: example
Example
```
{
  "mode": "pixel",
  "value": "example"
}
```

Table column width settings.

Example

{
  "mode": "auto"
}

horizontalAlignment

Type: string

Horizontal alignment of values in the column.

Enum: auto, start, center, end

Table column settings.

Example

{
  "width": {
    "mode": "auto"
  },
  "horizontalAlignment": "auto"
}

fakeTitle

Type: string

Chart-local display title override for the field.

Example: example

format

Type: string

Date or datetime format, separate from numeric formatting.

Example: example

formatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric formatting settings for the field.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

hideLabelMode

Type: string

Whether to hide the field label.

Enum: show, hide

hintSettings

Type: object

enabled

Type: boolean

Whether the field hint is enabled.

text

Type: string

Hint text displayed for the field.

Example: example

Field hint settings.

Example

{
  "enabled": true,
  "text": "example"
}

markupType

Type: string

Markup type used to render field values.

Enum: none, md, html

subTotalsSettings

Type: object

enabled

Type: boolean

Whether to display subtotals for the field.

Subtotal settings.

Example

{
  "enabled": true
}

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {
      "colorType": "gradient",
      "settings": {
        "gradientType": "2-point",
        "thresholds": null,
        "palette": "example",
        "reversed": true
      }
    },
    "showLabels": true,
    "align": "left",
    "scale": {
      "mode": "auto"
    },
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {
        "mountedColors": {},
        "palette": "example"
      },
      "gradientState": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "reversed": true,
        "nullMode": "ignore"
      },
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {
      "mode": "auto"
    },
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "title": "Measure Names",
  "type": "PSEUDO",
  "data_type": "string"
}

Type: object

data_type

Type: string

Numeric data type of the Measure Values pseudo-field.

Const: float

Example: example

title

Type: string

Title identifying the Measure Values pseudo-field.

Const: Measure Values

Example: example

type

Type: string

Field type identifying a pseudo-field.

Const: PSEUDO

Example: example

backgroundSettings

Type: object

colorFieldGuid

Type: string

Identifier of the field used to color the background.

Example: example

enabled

Type: boolean

Whether conditional background coloring is enabled.

settings

Type: object

gradientState

Type: object

gradientMode	Type: string Gradient type. Enum: `2-point`, `3-point`
gradientPalette	Type: string Gradient palette identifier. Example: `example`
leftThreshold	Type: string Lower gradient threshold. Example: `example`
middleThreshold	Type: string Middle gradient threshold. Example: `example`
nullMode	Type: string How null values are colored. Enum: `ignore`, `as-0`
reversed	Type: boolean Whether to reverse the gradient palette.
rightThreshold	Type: string Upper gradient threshold. Example: `example`
thresholdsMode	Type: string Mode used to calculate gradient thresholds. Enum: `auto`, `manual`

Continuous gradient settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "reversed": true,
  "nullMode": "ignore"
}

isContinuous

Type: boolean

Whether to use continuous instead of discrete coloring.

paletteState

Type: object

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

palette

Type: string

Color palette identifier.

Example: example

Discrete palette settings.

Example

{
  "mountedColors": {},
  "palette": "example"
}

Background color configuration.

Example

{
  "paletteState": {
    "mountedColors": {},
    "palette": "example"
  },
  "gradientState": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "reversed": true,
    "nullMode": "ignore"
  },
  "isContinuous": true
}

settingsId

Type: string

Identifier of the background color settings.

Example: example

Conditional background settings.

Example

{
  "enabled": true,
  "colorFieldGuid": "example",
  "settingsId": "example",
  "settings": {
    "paletteState": {
      "mountedColors": {},
      "palette": "example"
    },
    "gradientState": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "reversed": true,
      "nullMode": "ignore"
    },
    "isContinuous": true
  }
}

barsSettings

Type: object

align

Type: string

Bar alignment within table cells.

Enum: left, right, default

colorSettings

One of 3 types

Type: object

colorType

Type: string

Use a gradient to color bars.

Const: gradient

Example: example

settings

Type: object

gradientType

Type: string

Gradient type.

Enum: 2-point, 3-point

thresholds

One of 2 types

Type: object

mode

Type: string

Calculate gradient thresholds automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

max	Type: string Upper gradient threshold. Example: `example`
min	Type: string Lower gradient threshold. Example: `example`
mode	Type: string Use manually specified gradient thresholds. Const: `manual` Example: `example`
mid	Type: string Middle gradient threshold. Example: `example`

Example

{
  "mode": "manual",
  "min": "example",
  "mid": "example",
  "max": "example"
}

Thresholds that define the gradient color scale.

Example

{
  "mode": "auto"
}

palette

Type: string

Color palette identifier.

Example: example

reversed

Type: boolean

Whether to reverse the color palette.

Gradient bar color settings.

Example

{
  "gradientType": "2-point",
  "thresholds": {
    "mode": "auto"
  },
  "palette": "example",
  "reversed": true
}

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

Type: object

colorType

Type: string

Use one color for all bars.

Const: one-color

Example: example

settings

Type: object

color

Type: string

Custom bar color.

Example: example

colorIndex

Type: number

Selected color index in the palette.

palette

Type: string

Color palette identifier.

Example: example

Single-color bar settings.

Example

{
  "palette": "example",
  "colorIndex": 0.5,
  "color": "example"
}

Example

{
  "colorType": "one-color",
  "settings": {
    "palette": "example",
    "colorIndex": 0.5,
    "color": "example"
  }
}

Type: object

colorType

Type: string

Use separate colors for negative and positive bars.

Const: two-color

Example: example

settings

Type: object

negativeColor	Type: string Custom color for negative values. Example: `example`
negativeColorIndex	Type: number Palette color index for negative values.
palette	Type: string Color palette identifier. Example: `example`
positiveColor	Type: string Custom color for positive values. Example: `example`
positiveColorIndex	Type: number Palette color index for positive values.

Two-color bar settings.

Example

{
  "palette": "example",
  "negativeColorIndex": 0.5,
  "negativeColor": "example",
  "positiveColorIndex": 0.5,
  "positiveColor": "example"
}

Example

{
  "colorType": "two-color",
  "settings": {
    "palette": "example",
    "negativeColorIndex": 0.5,
    "negativeColor": "example",
    "positiveColorIndex": 0.5,
    "positiveColor": "example"
  }
}

Bar color settings.

Example

{
  "colorType": "gradient",
  "settings": {
    "gradientType": "2-point",
    "thresholds": {
      "mode": "auto"
    },
    "palette": "example",
    "reversed": true
  }
}

enabled

Type: boolean

Whether to display bars in table cells.

scale

One of 2 types

Type: object

mode

Type: string

Calculate the bar scale automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```

Type: object

mode

Type: string

Use a manually specified bar scale.

Const: manual

Example: example

settings

Type: object

max

Type: string

Manual maximum scale value.

Example: example

min

Type: string

Manual minimum scale value.

Example: example

Manual bar scale boundaries.

Example

{
  "min": "example",
  "max": "example"
}

Example

{
  "mode": "manual",
  "settings": {
    "min": "example",
    "max": "example"
  }
}

Scale used to calculate bar lengths.

Example

{
  "mode": "auto"
}

showBarsInTotals

Type: boolean

Whether to display bars in total rows.

showLabels

Type: boolean

Whether to display values over bars.

In-cell bar settings.

Example

{
  "enabled": true,
  "colorSettings": {
    "colorType": "gradient",
    "settings": {
      "gradientType": "2-point",
      "thresholds": {},
      "palette": "example",
      "reversed": true
    }
  },
  "showLabels": true,
  "align": "left",
  "scale": {
    "mode": "auto"
  },
  "showBarsInTotals": true
}

columnSettings

Type: object

width

One of 3 types

Type: object

mode

Type: string

Calculate the column width automatically.

Const: auto

Example: example
Example
```
{
  "mode": "auto"
}
```
Type: object

mode

Type: string

Set the column width as a percentage.

Const: percent

Example: example

value

Type: string

Column width percentage.

Example: example
Example
```
{
  "mode": "percent",
  "value": "example"
}
```
Type: object

mode

Type: string

Set the column width in pixels.

Const: pixel

Example: example

value

Type: string

Column width in pixels.

Example: example
Example
```
{
  "mode": "pixel",
  "value": "example"
}
```

Table column width settings.

Example

{
  "mode": "auto"
}

horizontalAlignment

Type: string

Horizontal alignment of values in the column.

Enum: auto, start, center, end

Table column settings.

Example

{
  "width": {
    "mode": "auto"
  },
  "horizontalAlignment": "auto"
}

fakeTitle

Type: string

Chart-local display title override for the field.

Example: example

format

Type: string

Date or datetime format, separate from numeric formatting.

Example: example

formatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric formatting settings for the field.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

hideLabelMode

Type: string

Whether to hide the field label.

Enum: show, hide

hintSettings

Type: object

enabled

Type: boolean

Whether the field hint is enabled.

text

Type: string

Hint text displayed for the field.

Example: example

Field hint settings.

Example

{
  "enabled": true,
  "text": "example"
}

markupType

Type: string

Markup type used to render field values.

Enum: none, md, html

subTotalsSettings

Type: object

enabled

Type: boolean

Whether to display subtotals for the field.

Subtotal settings.

Example

{
  "enabled": true
}

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {
      "colorType": "gradient",
      "settings": {
        "gradientType": "2-point",
        "thresholds": null,
        "palette": "example",
        "reversed": true
      }
    },
    "showLabels": true,
    "align": "left",
    "scale": {
      "mode": "auto"
    },
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {
        "mountedColors": {},
        "palette": "example"
      },
      "gradientState": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "reversed": true,
        "nullMode": "ignore"
      },
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {
      "mode": "auto"
    },
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "title": "Measure Values",
  "type": "PSEUDO",
  "data_type": "float"
}

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {
      "colorType": "gradient",
      "settings": {}
    },
    "showLabels": true,
    "align": "left",
    "scale": {
      "mode": "auto"
    },
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {
        "mountedColors": {},
        "palette": "example"
      },
      "gradientState": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "reversed": true,
        "nullMode": "ignore"
      },
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {
      "mode": "auto"
    },
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "title": "Measure Names",
  "type": "PSEUDO",
  "data_type": "string"
}

WizardSortItemSchema

Any of 2 types

Type: object

datasetId	Type: string Identifier of the dataset containing the field. Example: `example`
direction	Type: string Sort direction. Enum: `ASC`, `DESC`
guid	Type: string Identifier of the field used for sorting. Example: `example`
fakeTitle	Type: string Chart-local display title override for the field. Example: `example`
format	Type: string Date or datetime format, separate from numeric formatting. Example: `example`

Example

{
  "fakeTitle": "example",
  "format": "example",
  "direction": "ASC",
  "guid": "example",
  "datasetId": "example"
}

All of 2 types

Type: WizardPseudoFieldSchema

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {
      "colorType": "gradient",
      "settings": {}
    },
    "showLabels": true,
    "align": "left",
    "scale": {
      "mode": "auto"
    },
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {
        "mountedColors": {},
        "palette": "example"
      },
      "gradientState": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "reversed": true,
        "nullMode": "ignore"
      },
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {
      "mode": "auto"
    },
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "title": "Measure Names",
  "type": "PSEUDO",
  "data_type": "string"
}

Type: object

direction

Type: string

Sort direction.

Enum: ASC, DESC

fakeTitle

Type: string

Chart-local display title override for the field.

Example: example

format

Type: string

Date or datetime format, separate from numeric formatting.

Example: example

Example

{
  "fakeTitle": "example",
  "format": "example",
  "direction": "ASC"
}

Example

{
  "fakeTitle": "example",
  "markupType": "none",
  "formatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "format": "example",
  "hideLabelMode": "show",
  "barsSettings": {
    "enabled": true,
    "colorSettings": {},
    "showLabels": true,
    "align": "left",
    "scale": {},
    "showBarsInTotals": true
  },
  "subTotalsSettings": {
    "enabled": true
  },
  "backgroundSettings": {
    "enabled": true,
    "colorFieldGuid": "example",
    "settingsId": "example",
    "settings": {
      "paletteState": {},
      "gradientState": {},
      "isContinuous": true
    }
  },
  "columnSettings": {
    "width": {},
    "horizontalAlignment": "auto"
  },
  "hintSettings": {
    "enabled": true,
    "text": "example"
  },
  "title": "Measure Names",
  "type": "PSEUDO",
  "data_type": "string",
  "direction": "ASC"
}

Example

{
  "fakeTitle": "example",
  "format": "example",
  "direction": "ASC",
  "guid": "example",
  "datasetId": "example"
}

WizardV1GeolayerLayerSchema

One of 5 types

Type: object

layerSettings

Type: object

Type: string

Unique layer identifier.

Example: example

name

Type: string

Layer display name.

Example: example

alpha

Type: number

Layer opacity as a percentage from 0 to 100.

Geographic layer configuration.

Example

{
  "id": "example",
  "name": "example",
  "alpha": 0.5
}

points

Type: object

items

Type: WizardFieldSchema[]

Fields containing point coordinates.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Point coordinate configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Geopoint layer type.

Const: geopoint

Example: example

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

filters

Type: object

items

Type: WizardV1FiltersItemSchema[]

Filters applied to the layer.

Example

[
  {
    "guid": "example",
    "datasetId": "example",
    "fakeTitle": "example",
    "filter": {
      "operation": {
        "code": "example"
      },
      "value": "example"
    }
  }
]

Filter configuration.

Example

{
  "items": [
    {
      "guid": "example",
      "datasetId": "example",
      "fakeTitle": "example",
      "filter": {
        "operation": {
          "code": "example"
        },
        "value": "example"
      }
    }
  ]
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as point labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ]
}

size

Type: object

items

Type: WizardFieldSchema[]

Fields used to determine map point sizes.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

radius

Type: number

Radius of map points in pixels.

Map point size settings.

Example

{
  "radius": 0.5
}

Point size configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "radius": 0.5
  }
}

tooltip

Type: object

items

Type: WizardFieldSchema[]

Fields displayed in point tooltips.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

color

Type: string

Whether to display series colors in the tooltip.

Enum: on, off

fieldTitle

Type: string

Whether to display field titles in the tooltip.

Enum: on, off

Tooltip display settings.

Example

{
  "color": "on",
  "fieldTitle": "on"
}

Tooltip configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "color": "on",
    "fieldTitle": "on"
  }
}

Example

{
  "type": "geopoint",
  "layerSettings": {
    "id": "example",
    "name": "example",
    "alpha": 0.5
  },
  "points": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "size": {
    "items": [
      null
    ],
    "settings": {
      "radius": 0.5
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "labels": {
    "items": [
      null
    ]
  },
  "tooltip": {
    "items": [
      null
    ],
    "settings": {
      "color": "on",
      "fieldTitle": "on"
    }
  },
  "filters": {
    "items": [
      {
        "guid": "example",
        "datasetId": "example",
        "fakeTitle": "example",
        "filter": {
          "operation": {},
          "value": null
        }
      }
    ]
  }
}

Type: object

layerSettings

Type: object

Type: string

Unique layer identifier.

Example: example

name

Type: string

Layer display name.

Example: example

alpha

Type: number

Layer opacity as a percentage from 0 to 100.

Geographic layer configuration.

Example

{
  "id": "example",
  "name": "example",
  "alpha": 0.5
}

points

Type: object

items

Type: WizardFieldSchema[]

Fields containing point coordinates.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Point coordinate configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Clustered geopoint layer type.

Const: geopoint-with-cluster

Example: example

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

filters

Type: object

items

Type: WizardV1FiltersItemSchema[]

Filters applied to the layer.

Example

[
  {
    "guid": "example",
    "datasetId": "example",
    "fakeTitle": "example",
    "filter": {
      "operation": {
        "code": "example"
      },
      "value": "example"
    }
  }
]

Filter configuration.

Example

{
  "items": [
    {
      "guid": "example",
      "datasetId": "example",
      "fakeTitle": "example",
      "filter": {
        "operation": {
          "code": "example"
        },
        "value": "example"
      }
    }
  ]
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as point labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ]
}

size

Type: object

items

Type: WizardFieldSchema[]

Fields used to determine map point sizes.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

radius

Type: number

Radius of map points in pixels.

Map point size settings.

Example

{
  "radius": 0.5
}

Point size configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "radius": 0.5
  }
}

tooltip

Type: object

items

Type: WizardFieldSchema[]

Fields displayed in point tooltips.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

color

Type: string

Whether to display series colors in the tooltip.

Enum: on, off

fieldTitle

Type: string

Whether to display field titles in the tooltip.

Enum: on, off

Tooltip display settings.

Example

{
  "color": "on",
  "fieldTitle": "on"
}

Tooltip configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "color": "on",
    "fieldTitle": "on"
  }
}

Example

{
  "layerSettings": {
    "id": "example",
    "name": "example",
    "alpha": 0.5
  },
  "points": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "size": {
    "items": [
      null
    ],
    "settings": {
      "radius": 0.5
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "labels": {
    "items": [
      null
    ]
  },
  "tooltip": {
    "items": [
      null
    ],
    "settings": {
      "color": "on",
      "fieldTitle": "on"
    }
  },
  "filters": {
    "items": [
      {
        "guid": "example",
        "datasetId": "example",
        "fakeTitle": "example",
        "filter": {
          "operation": {},
          "value": null
        }
      }
    ]
  },
  "type": "geopoint-with-cluster"
}

Type: object

layerSettings

Type: object

Type: string

Unique layer identifier.

Example: example

name

Type: string

Layer display name.

Example: example

alpha

Type: number

Layer opacity as a percentage from 0 to 100.

Geographic layer configuration.

Example

{
  "id": "example",
  "name": "example",
  "alpha": 0.5
}

polylines

Type: object

items

Type: WizardFieldSchema[]

Fields containing polyline coordinates.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

polylinePoints

Type: string

Whether vertices are displayed on polylines.

Enum: on, off

Polyline display settings.

Example

{
  "polylinePoints": "on"
}

Polyline configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "polylinePoints": "on"
  }
}

type

Type: string

Geopolyline layer type.

Const: polyline

Example: example

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

filters

Type: object

items

Type: WizardV1FiltersItemSchema[]

Filters applied to the layer.

Example

[
  {
    "guid": "example",
    "datasetId": "example",
    "fakeTitle": "example",
    "filter": {
      "operation": {
        "code": "example"
      },
      "value": "example"
    }
  }
]

Filter configuration.

Example

{
  "items": [
    {
      "guid": "example",
      "datasetId": "example",
      "fakeTitle": "example",
      "filter": {
        "operation": {
          "code": "example"
        },
        "value": "example"
      }
    }
  ]
}

grouping

Type: object

items

Type: WizardFieldSchema[]

Fields used to group polyline points.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Grouping configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

measures

Type: object

items

Type: WizardFieldSchema[]

Measures displayed in polyline tooltips.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Measure configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Example

{
  "type": "polyline",
  "layerSettings": {
    "id": "example",
    "name": "example",
    "alpha": 0.5
  },
  "polylines": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "polylinePoints": "on"
    }
  },
  "measures": {
    "items": [
      null
    ]
  },
  "grouping": {
    "items": [
      null
    ]
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  },
  "filters": {
    "items": [
      {
        "guid": "example",
        "datasetId": "example",
        "fakeTitle": "example",
        "filter": {
          "operation": {},
          "value": null
        }
      }
    ]
  }
}

Type: object

layerSettings

Type: object

Type: string

Unique layer identifier.

Example: example

name

Type: string

Layer display name.

Example: example

alpha

Type: number

Layer opacity as a percentage from 0 to 100.

Geographic layer configuration.

Example

{
  "id": "example",
  "name": "example",
  "alpha": 0.5
}

polygons

Type: object

items

Type: WizardFieldSchema[]

Fields containing polygon geometry.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Polygon configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Geopolygon layer type.

Const: geopolygon

Example: example

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

filters

Type: object

items

Type: WizardV1FiltersItemSchema[]

Filters applied to the layer.

Example

[
  {
    "guid": "example",
    "datasetId": "example",
    "fakeTitle": "example",
    "filter": {
      "operation": {
        "code": "example"
      },
      "value": "example"
    }
  }
]

Filter configuration.

Example

{
  "items": [
    {
      "guid": "example",
      "datasetId": "example",
      "fakeTitle": "example",
      "filter": {
        "operation": {
          "code": "example"
        },
        "value": "example"
      }
    }
  ]
}

tooltip

Type: object

items

Type: WizardFieldSchema[]

Fields displayed in polygon tooltips.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

color

Type: string

Whether to display series colors in the tooltip.

Enum: on, off

fieldTitle

Type: string

Whether to display field titles in the tooltip.

Enum: on, off

Tooltip display settings.

Example

{
  "color": "on",
  "fieldTitle": "on"
}

Tooltip configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "color": "on",
    "fieldTitle": "on"
  }
}

Example

{
  "type": "geopolygon",
  "layerSettings": {
    "id": "example",
    "name": "example",
    "alpha": 0.5
  },
  "polygons": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "tooltip": {
    "items": [
      null
    ],
    "settings": {
      "color": "on",
      "fieldTitle": "on"
    }
  },
  "filters": {
    "items": [
      {
        "guid": "example",
        "datasetId": "example",
        "fakeTitle": "example",
        "filter": {
          "operation": {},
          "value": null
        }
      }
    ]
  }
}

Type: object

layerSettings

Type: object

Type: string

Unique layer identifier.

Example: example

name

Type: string

Layer display name.

Example: example

alpha

Type: number

Layer opacity as a percentage from 0 to 100.

Geographic layer configuration.

Example

{
  "id": "example",
  "name": "example",
  "alpha": 0.5
}

points

Type: object

items

Type: WizardFieldSchema[]

Fields containing heatmap point coordinates.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Point coordinate configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Geo heatmap layer type.

Const: heatmap

Example: example

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

filters

Type: object

items

Type: WizardV1FiltersItemSchema[]

Filters applied to the layer.

Example

[
  {
    "guid": "example",
    "datasetId": "example",
    "fakeTitle": "example",
    "filter": {
      "operation": {
        "code": "example"
      },
      "value": "example"
    }
  }
]

Filter configuration.

Example

{
  "items": [
    {
      "guid": "example",
      "datasetId": "example",
      "fakeTitle": "example",
      "filter": {
        "operation": {
          "code": "example"
        },
        "value": "example"
      }
    }
  ]
}

Example

{
  "type": "heatmap",
  "layerSettings": {
    "id": "example",
    "name": "example",
    "alpha": 0.5
  },
  "points": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "filters": {
    "items": [
      {
        "guid": "example",
        "datasetId": "example",
        "fakeTitle": "example",
        "filter": {
          "operation": {},
          "value": null
        }
      }
    ]
  }
}

Example

{
  "type": "geopoint",
  "layerSettings": {
    "id": "example",
    "name": "example",
    "alpha": 0.5
  },
  "points": {
    "items": [
      {}
    ]
  },
  "size": {
    "items": [
      null
    ],
    "settings": {
      "radius": 0.5
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "labels": {
    "items": [
      null
    ]
  },
  "tooltip": {
    "items": [
      null
    ],
    "settings": {
      "color": "on",
      "fieldTitle": "on"
    }
  },
  "filters": {
    "items": [
      {
        "guid": "example",
        "datasetId": "example",
        "fakeTitle": "example",
        "filter": {}
      }
    ]
  }
}

WizardV1CombinedChartLayerSchema

One of 3 types

Type: object

layerSettings

Type: object

Type: string

Unique layer identifier.

Example: example

name

Type: string

Layer display name.

Example: example

Layer configuration.

Example

{
  "id": "example",
  "name": "example"
}

type

Type: string

Line layer type.

Const: line

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "axisModeMap": {}
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "axisModeMap": {}
  }
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as data labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

overlap

Type: string

Whether data labels may overlap.

Enum: on, off

Data label settings.

Example

{
  "overlap": "on"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "overlap": "on"
  }
}

shapes

Type: object

items

Type: WizardFieldSchema[]

Fields used for line encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

commonLineSettings

Type: object

linecap

Type: string

Shape used at line endpoints.

Enum: butt, round, square, none

linejoin

Type: string

Shape used at line segment joins.

Enum: bevel, round, miter, unset

lineWidth

Any of 2 types

Type: number
Type: string

Const: auto

Example: example

Line width in pixels or automatic width.

Example: 0.5

Line shape settings shared by all series.

Example

{
  "lineWidth": 0.5,
  "linecap": "butt",
  "linejoin": "bevel"
}

fieldGuid

Type: string

Identifier of the field used to assign shapes.

Example: example

lineSettings

Type: object

[additional]

Type: WizardV1LineShapeSettingsSchema

Example

{
  "lineWidth": 0.5,
  "linecap": "butt",
  "linejoin": "bevel"
}

Line shape settings by series.

Example

{}

mountedShapes

Type: object

[additional]

Type: string

Example: example

Mapping of series or field values to line dash styles.

Example

{}

Line shape settings.

Example

{
  "fieldGuid": "example",
  "mountedShapes": {},
  "lineSettings": {},
  "commonLineSettings": {
    "lineWidth": 0.5,
    "linecap": "butt",
    "linejoin": "bevel"
  }
}

Line shape configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "fieldGuid": "example",
    "mountedShapes": {},
    "lineSettings": {},
    "commonLineSettings": {
      "lineWidth": 0.5,
      "linecap": "butt",
      "linejoin": "bevel"
    }
  }
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the primary Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Primary Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

Primary Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the secondary Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Secondary Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

Secondary Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Example

{
  "type": "line",
  "layerSettings": {
    "id": "example",
    "name": "example"
  },
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "y2": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "shapes": {
    "items": [
      null
    ],
    "settings": {
      "fieldGuid": "example",
      "mountedShapes": {},
      "lineSettings": {},
      "commonLineSettings": {
        "lineWidth": 0.5,
        "linecap": "butt",
        "linejoin": "bevel"
      }
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
}

Type: object

layerSettings

Type: object

Type: string

Unique layer identifier.

Example: example

name

Type: string

Layer display name.

Example: example

Layer configuration.

Example

{
  "id": "example",
  "name": "example"
}

type

Type: string

Column layer type.

Const: column

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "axisModeMap": {}
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "axisModeMap": {}
  }
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as data labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

labelsPosition

Type: string

Position of data labels relative to columns.

Enum: outside, inside

overlap

Type: string

Whether data labels may overlap.

Enum: on, off

Data label settings.

Example

{
  "overlap": "on",
  "labelsPosition": "outside"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "overlap": "on",
    "labelsPosition": "outside"
  }
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Example

{
  "type": "column",
  "layerSettings": {
    "id": "example",
    "name": "example"
  },
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on",
      "labelsPosition": "outside"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
}

Type: object

layerSettings

Type: object

Type: string

Unique layer identifier.

Example: example

name

Type: string

Layer display name.

Example: example

Layer configuration.

Example

{
  "id": "example",
  "name": "example"
}

type

Type: string

Area layer type.

Const: area

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "axisModeMap": {}
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "axisModeMap": {}
  }
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as data labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

overlap

Type: string

Whether data labels may overlap.

Enum: on, off

Data label settings.

Example

{
  "overlap": "on"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "overlap": "on"
  }
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Example

{
  "type": "area",
  "layerSettings": {
    "id": "example",
    "name": "example"
  },
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
}

Example

{
  "type": "line",
  "layerSettings": {
    "id": "example",
    "name": "example"
  },
  "x": {
    "items": [
      {}
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "y2": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "shapes": {
    "items": [
      null
    ],
    "settings": {
      "fieldGuid": "example",
      "mountedShapes": {},
      "lineSettings": {},
      "commonLineSettings": {
        "lineWidth": null,
        "linecap": "butt",
        "linejoin": "bevel"
      }
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on"
    }
  },
  "sort": {
    "items": [
      {}
    ]
  }
}

WizardV1ConfigSchema

Name

Description

sources

Type: object

datasetsIds

Type: string[]

Datasets used by the chart to retrieve data.

Example

[
  "example"
]

filters

Type: WizardV1FiltersItemSchema[]

Filters applied to chart data.

Example

[
  {
    "guid": "example",
    "datasetId": "example",
    "fakeTitle": "example",
    "filter": {
      "operation": {
        "code": "example"
      },
      "value": "example"
    }
  }
]

hierarchies

Type: object[]

fields

Type: object[]

datasetId

Type: string

Identifier of the dataset containing the field.

Example: example

guid

Type: string

Identifier of a field in the hierarchy.

Example: example

Ordered fields included in the hierarchy.

Example

[
  {
    "guid": "example",
    "datasetId": "example"
  }
]

guid

Type: string

Hierarchy identifier.

Example: example

title

Type: string

Hierarchy display title.

Example: example

Sets of fields used for interactive drill-down in the chart.

Example

[
  {
    "guid": "example",
    "title": "example",
    "fields": [
      {
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

links

Type: object[]

fields

Type: object

[additional]

Type: object

dataset

Type: object

Type: string

Linked dataset identifier.

Example: example

realName

Type: string

Linked dataset display name.

Example: example

Dataset containing the linked field.

Example

{
  "id": "example",
  "realName": "example"
}

field

Type: object

guid

Type: string

Linked field identifier.

Example: example

title

Type: string

Linked field title.

Example: example

Field participating in the dataset link.

Example

{
  "title": "example",
  "guid": "example"
}

Example

{
  "field": {
    "title": "example",
    "guid": "example"
  },
  "dataset": {
    "id": "example",
    "realName": "example"
  }
}

Linked field information keyed by dataset identifier.

Example

{}

Type: string

Dataset link identifier.

Example: example

Fields used to link datasets in multi-dataset charts.

Example

[
  {
    "id": "example",
    "fields": {}
  }
]

updates

Type: object[]

action

Type: string

Operation applied to the local field.

Enum: add_field, add, update_field, update, delete, delete_field

field

Type: object

guid	Type: string Unique field identifier. Example: `example`
aggregation	Type: string Aggregation applied to the field. Example: `example`
aggregation_locked	Type: boolean Whether the field aggregation cannot be changed.
autoaggregated	Type: boolean Whether the field is aggregated automatically.
avatar_id	Type: string Identifier of the dataset source containing the field. Example: `example`
calc_mode	Type: string Field calculation mode. Enum: `formula`, `direct`, `parameter`
cast	Type: string Data type conversion applied to the field. Example: `example`
data_type	Type: string Field data type. Enum: `date`, `genericdatetime`, `datetimetz`, `integer`, `uinteger`, `string`, `float`, `boolean`, `geopoint`, `geopolygon`, `markup`, `heatmap`, `array_int`, `array_float`, `array_str`, `unsupported`, `hierarchy`, `tree_str`, `tree_int`, `tree_float`
datasetId	Type: string Identifier of the dataset containing the field. Example: `example`
default_value	Any of 5 types Type: string Example: `example` Type: number Type: boolean Type: null Example: `null` Type: null Example: `null` Value of a parameter added in the chart. Example: `example`
fakeTitle	Type: string Chart-local display title override for the field. Example: `example`
format	Type: string Date or datetime format, separate from numeric formatting. Example: `example`
formula	Type: string Formula used to calculate the field. Example: `example`
grouping	Type: string Date or numeric grouping mode. Example: `example`
local	Type: boolean Whether the field exists only in this chart.
originalDateCast	Any of 3 types Type: string Enum: `date`, `genericdatetime`, `datetimetz`, `integer`, `uinteger`, `string`, `float`, `boolean`, `geopoint`, `geopolygon`, `markup`, `heatmap`, `array_int`, `array_float`, `array_str`, `unsupported`, `hierarchy`, `tree_str`, `tree_int`, `tree_float` Type: null Example: `null` Type: null Example: `null` Original date data type before local conversion. Example: `date`
originalFormula	Type: string Formula before local transformations. Example: `example`
originalSource	Type: string Source before local transformations. Example: `example`
originalTitle	Type: string Original field title before local changes. Example: `example`
quickFormula	Type: boolean Whether the field was created with a quick formula.
source	Type: string Source expression or source field name. Example: `example`
title	Type: string Field display title. Example: `example`
type	Type: string Field role in the chart. Enum: `DIMENSION`, `MEASURE`, `PSEUDO`, `PARAMETER`

Field properties changed by the operation.

Example

{
  "guid": "example",
  "datasetId": "example",
  "title": "example",
  "type": "DIMENSION",
  "calc_mode": "formula",
  "formula": "example",
  "aggregation": "example",
  "cast": "example",
  "source": "example",
  "data_type": "date",
  "aggregation_locked": true,
  "autoaggregated": true,
  "grouping": "example",
  "fakeTitle": "example",
  "originalTitle": "example",
  "avatar_id": "example",
  "local": true,
  "quickFormula": true,
  "originalFormula": "example",
  "originalSource": "example",
  "originalDateCast": "date",
  "format": "example",
  "default_value": "example"
}

debug_info

Type: string

Internal marker describing how the field update was produced.

Example: example

Operations that add, update, or delete chart-local fields.

Example

[
  {
    "action": "add_field",
    "field": {
      "guid": "example",
      "datasetId": "example",
      "title": "example",
      "type": "DIMENSION",
      "calc_mode": "formula",
      "formula": "example",
      "aggregation": "example",
      "cast": "example",
      "source": "example",
      "data_type": "date",
      "aggregation_locked": true,
      "autoaggregated": true,
      "grouping": "example",
      "fakeTitle": "example",
      "originalTitle": "example",
      "avatar_id": "example",
      "local": true,
      "quickFormula": true,
      "originalFormula": "example",
      "originalSource": "example",
      "originalDateCast": "date",
      "format": "example",
      "default_value": "example"
    },
    "debug_info": "example"
  }
]

Data sources, chart-local field updates, dataset links, hierarchies, and filters used by the chart.

Example

{
  "datasetsIds": [
    "example"
  ],
  "updates": [
    {
      "action": "add_field",
      "field": {
        "guid": "example",
        "datasetId": "example",
        "title": "example",
        "type": "DIMENSION",
        "calc_mode": "formula",
        "formula": "example",
        "aggregation": "example",
        "cast": "example",
        "source": "example",
        "data_type": "date",
        "aggregation_locked": true,
        "autoaggregated": true,
        "grouping": "example",
        "fakeTitle": "example",
        "originalTitle": "example",
        "avatar_id": "example",
        "local": true,
        "quickFormula": true,
        "originalFormula": "example",
        "originalSource": "example",
        "originalDateCast": "date",
        "format": "example",
        "default_value": "example"
      },
      "debug_info": "example"
    }
  ],
  "links": [
    {
      "id": "example",
      "fields": {}
    }
  ],
  "hierarchies": [
    {
      "guid": "example",
      "title": "example",
      "fields": [
        {
          "guid": "example",
          "datasetId": "example"
        }
      ]
    }
  ],
  "filters": [
    {
      "guid": "example",
      "datasetId": "example",
      "fakeTitle": "example",
      "filter": {
        "operation": {
          "code": "example"
        },
        "value": "example"
      }
    }
  ]
}

visualization

One of 17 types

Type: object

type

Type: string

Line visualization type.

Const: line

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "axisModeMap": {}
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "axisModeMap": {}
  }
}

chartSettings

Type: object

feed

Type: string

Comment feed identifier.

Example: example

legendMode

Type: string

Whether the chart legend is displayed.

Enum: show, hide

navigatorSettings

Type: object

linesMode

Type: string

Which chart series are displayed in the navigator.

Enum: all, selected

navigatorMode

Type: string

Whether the chart navigator is displayed.

Enum: show, hide

periodSettings

Type: object

period

Type: string

Unit of the navigator window size.

Enum: month, year, day, hour, week, quarter

type

Type: string

Data type of the navigator axis field.

Enum: date, genericdatetime, datetimetz, integer, uinteger, string, float, boolean, geopoint, geopolygon, markup, heatmap, array_int, array_float, array_str, unsupported, hierarchy, tree_str, tree_int, tree_float

value

Type: string

Initial navigator window size.

Example: example

Size and unit of the initial navigator window.

Example

{
  "type": "date",
  "value": "example",
  "period": "month"
}

selectedLines

Type: string[]

Series names shown in the navigator; values are not field GUIDs.

Example

[
  "example"
]

Chart navigator settings.

Example

{
  "navigatorMode": "show",
  "selectedLines": [
    "example"
  ],
  "linesMode": "all",
  "periodSettings": {
    "type": "date",
    "value": "example",
    "period": "month"
  }
}

title

Type: string

Chart title.

Example: example

titleMode

Type: string

Whether the chart title is displayed.

Enum: show, hide

tooltip

Type: string

Whether chart tooltips are displayed.

Enum: show, hide

tooltipSum

Type: string

Whether tooltips include a total value.

Enum: on, off

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "tooltipSum": "on",
  "feed": "example",
  "navigatorSettings": {
    "navigatorMode": "show",
    "selectedLines": [
      "example"
    ],
    "linesMode": "all",
    "periodSettings": {
      "type": "date",
      "value": "example",
      "period": "month"
    }
  }
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as data labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

overlap

Type: string

Whether data labels may overlap.

Enum: on, off

Data label settings.

Example

{
  "overlap": "on"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "overlap": "on"
  }
}

segments

Type: object

items

Type: WizardFieldSchema[]

Fields used to split the chart into segments.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Segmentation configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

shapes

Type: object

items

Type: WizardFieldSchema[]

Fields used for line encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

commonLineSettings

Type: object

linecap

Type: string

Shape used at line endpoints.

Enum: butt, round, square, none

linejoin

Type: string

Shape used at line segment joins.

Enum: bevel, round, miter, unset

lineWidth

Any of 2 types

Type: number
Type: string

Const: auto

Example: example

Line width in pixels or automatic width.

Example: 0.5

Line shape settings shared by all series.

Example

{
  "lineWidth": 0.5,
  "linecap": "butt",
  "linejoin": "bevel"
}

fieldGuid

Type: string

Identifier of the field used to assign shapes.

Example: example

lineSettings

Type: object

[additional]

Type: WizardV1LineShapeSettingsSchema

Example

{
  "lineWidth": 0.5,
  "linecap": "butt",
  "linejoin": "bevel"
}

Line shape settings by series.

Example

{}

mountedShapes

Type: object

[additional]

Type: string

Example: example

Mapping of series or field values to line dash styles.

Example

{}

Line shape settings.

Example

{
  "fieldGuid": "example",
  "mountedShapes": {},
  "lineSettings": {},
  "commonLineSettings": {
    "lineWidth": 0.5,
    "linecap": "butt",
    "linejoin": "bevel"
  }
}

Line shape configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "fieldGuid": "example",
    "mountedShapes": {},
    "lineSettings": {},
    "commonLineSettings": {
      "lineWidth": 0.5,
      "linecap": "butt",
      "linejoin": "bevel"
    }
  }
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the primary Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Primary Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

Primary Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the secondary Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Secondary Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

Secondary Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Example

{
  "type": "line",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "tooltipSum": "on",
    "feed": "example",
    "navigatorSettings": {
      "navigatorMode": "show",
      "selectedLines": [
        "example"
      ],
      "linesMode": "all",
      "periodSettings": {
        "type": "date",
        "value": "example",
        "period": "month"
      }
    }
  },
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "y2": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "shapes": {
    "items": [
      null
    ],
    "settings": {
      "fieldGuid": "example",
      "mountedShapes": {},
      "lineSettings": {},
      "commonLineSettings": {
        "lineWidth": 0.5,
        "linecap": "butt",
        "linejoin": "bevel"
      }
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  },
  "segments": {
    "items": [
      null
    ]
  }
}

Type: object

type

Type: string

Column visualization type.

Const: column

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "axisModeMap": {}
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "axisModeMap": {}
  }
}

chartSettings

Type: object

feed

Type: string

Comment feed identifier.

Example: example

legendMode

Type: string

Whether the chart legend is displayed.

Enum: show, hide

navigatorSettings

Type: object

linesMode

Type: string

Which chart series are displayed in the navigator.

Enum: all, selected

navigatorMode

Type: string

Whether the chart navigator is displayed.

Enum: show, hide

periodSettings

Type: object

period

Type: string

Unit of the navigator window size.

Enum: month, year, day, hour, week, quarter

type

Type: string

Data type of the navigator axis field.

value

Type: string

Initial navigator window size.

Example: example

Size and unit of the initial navigator window.

Example

{
  "type": "date",
  "value": "example",
  "period": "month"
}

selectedLines

Type: string[]

Series names shown in the navigator; values are not field GUIDs.

Example

[
  "example"
]

Chart navigator settings.

Example

{
  "navigatorMode": "show",
  "selectedLines": [
    "example"
  ],
  "linesMode": "all",
  "periodSettings": {
    "type": "date",
    "value": "example",
    "period": "month"
  }
}

title

Type: string

Chart title.

Example: example

titleMode

Type: string

Whether the chart title is displayed.

Enum: show, hide

tooltip

Type: string

Whether chart tooltips are displayed.

Enum: show, hide

tooltipSum

Type: string

Whether tooltips include a total value.

Enum: on, off

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "tooltipSum": "on",
  "feed": "example",
  "navigatorSettings": {
    "navigatorMode": "show",
    "selectedLines": [
      "example"
    ],
    "linesMode": "all",
    "periodSettings": {
      "type": "date",
      "value": "example",
      "period": "month"
    }
  }
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as data labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

labelsPosition

Type: string

Position of data labels relative to columns.

Enum: outside, inside

overlap

Type: string

Whether data labels may overlap.

Enum: on, off

Data label settings.

Example

{
  "overlap": "on",
  "labelsPosition": "outside"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "overlap": "on",
    "labelsPosition": "outside"
  }
}

segments

Type: object

items

Type: WizardFieldSchema[]

Fields used to split the chart into segments.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Segmentation configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Example

{
  "type": "column",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "tooltipSum": "on",
    "feed": "example",
    "navigatorSettings": {
      "navigatorMode": "show",
      "selectedLines": [
        "example"
      ],
      "linesMode": "all",
      "periodSettings": {
        "type": "date",
        "value": "example",
        "period": "month"
      }
    }
  },
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on",
      "labelsPosition": "outside"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  },
  "segments": {
    "items": [
      null
    ]
  }
}

Type: object

type

Type: string

Normalized column visualization type.

Const: column100p

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "axisModeMap": {}
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "axisModeMap": {}
  }
}

chartSettings

Type: object

feed

Type: string

Comment feed identifier.

Example: example

legendMode

Type: string

Whether the chart legend is displayed.

Enum: show, hide

navigatorSettings

Type: object

linesMode

Type: string

Which chart series are displayed in the navigator.

Enum: all, selected

navigatorMode

Type: string

Whether the chart navigator is displayed.

Enum: show, hide

periodSettings

Type: object

period

Type: string

Unit of the navigator window size.

Enum: month, year, day, hour, week, quarter

type

Type: string

Data type of the navigator axis field.

value

Type: string

Initial navigator window size.

Example: example

Size and unit of the initial navigator window.

Example

{
  "type": "date",
  "value": "example",
  "period": "month"
}

selectedLines

Type: string[]

Series names shown in the navigator; values are not field GUIDs.

Example

[
  "example"
]

Chart navigator settings.

Example

{
  "navigatorMode": "show",
  "selectedLines": [
    "example"
  ],
  "linesMode": "all",
  "periodSettings": {
    "type": "date",
    "value": "example",
    "period": "month"
  }
}

title

Type: string

Chart title.

Example: example

titleMode

Type: string

Whether the chart title is displayed.

Enum: show, hide

tooltip

Type: string

Whether chart tooltips are displayed.

Enum: show, hide

tooltipSum

Type: string

Whether tooltips include a total value.

Enum: on, off

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "tooltipSum": "on",
  "feed": "example",
  "navigatorSettings": {
    "navigatorMode": "show",
    "selectedLines": [
      "example"
    ],
    "linesMode": "all",
    "periodSettings": {
      "type": "date",
      "value": "example",
      "period": "month"
    }
  }
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as data labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

overlap

Type: string

Whether data labels may overlap.

Enum: on, off

Data label settings.

Example

{
  "overlap": "on"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "overlap": "on"
  }
}

segments

Type: object

items

Type: WizardFieldSchema[]

Fields used to split the chart into segments.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Segmentation configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Example

{
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "tooltipSum": "on",
    "feed": "example",
    "navigatorSettings": {
      "navigatorMode": "show",
      "selectedLines": [
        "example"
      ],
      "linesMode": "all",
      "periodSettings": {
        "type": "date",
        "value": "example",
        "period": "month"
      }
    }
  },
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  },
  "segments": {
    "items": [
      null
    ]
  },
  "type": "column100p",
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on"
    }
  }
}

Type: object

type

Type: string

Area visualization type.

Const: area

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "axisModeMap": {}
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "axisModeMap": {}
  }
}

chartSettings

Type: object

feed

Type: string

Comment feed identifier.

Example: example

legendMode

Type: string

Whether the chart legend is displayed.

Enum: show, hide

navigatorSettings

Type: object

linesMode

Type: string

Which chart series are displayed in the navigator.

Enum: all, selected

navigatorMode

Type: string

Whether the chart navigator is displayed.

Enum: show, hide

periodSettings

Type: object

period

Type: string

Unit of the navigator window size.

Enum: month, year, day, hour, week, quarter

type

Type: string

Data type of the navigator axis field.

value

Type: string

Initial navigator window size.

Example: example

Size and unit of the initial navigator window.

Example

{
  "type": "date",
  "value": "example",
  "period": "month"
}

selectedLines

Type: string[]

Series names shown in the navigator; values are not field GUIDs.

Example

[
  "example"
]

Chart navigator settings.

Example

{
  "navigatorMode": "show",
  "selectedLines": [
    "example"
  ],
  "linesMode": "all",
  "periodSettings": {
    "type": "date",
    "value": "example",
    "period": "month"
  }
}

stacking

Type: string

Whether area series are stacked.

Enum: on, off

title

Type: string

Chart title.

Example: example

titleMode

Type: string

Whether the chart title is displayed.

Enum: show, hide

tooltip

Type: string

Whether chart tooltips are displayed.

Enum: show, hide

tooltipSum

Type: string

Whether tooltips include a total value.

Enum: on, off

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "tooltipSum": "on",
  "feed": "example",
  "navigatorSettings": {
    "navigatorMode": "show",
    "selectedLines": [
      "example"
    ],
    "linesMode": "all",
    "periodSettings": {
      "type": "date",
      "value": "example",
      "period": "month"
    }
  },
  "stacking": "on"
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as data labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

overlap

Type: string

Whether data labels may overlap.

Enum: on, off

Data label settings.

Example

{
  "overlap": "on"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "overlap": "on"
  }
}

segments

Type: object

items

Type: WizardFieldSchema[]

Fields used to split the chart into segments.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Segmentation configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Example

{
  "type": "area",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "tooltipSum": "on",
    "feed": "example",
    "navigatorSettings": {
      "navigatorMode": "show",
      "selectedLines": [
        "example"
      ],
      "linesMode": "all",
      "periodSettings": {
        "type": "date",
        "value": "example",
        "period": "month"
      }
    },
    "stacking": "on"
  },
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  },
  "segments": {
    "items": [
      null
    ]
  }
}

Type: object

type

Type: string

Normalized area visualization type.

Const: area100p

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "axisModeMap": {}
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "axisModeMap": {}
  }
}

chartSettings

Type: object

feed

Type: string

Comment feed identifier.

Example: example

legendMode

Type: string

Whether the chart legend is displayed.

Enum: show, hide

navigatorSettings

Type: object

linesMode

Type: string

Which chart series are displayed in the navigator.

Enum: all, selected

navigatorMode

Type: string

Whether the chart navigator is displayed.

Enum: show, hide

periodSettings

Type: object

period

Type: string

Unit of the navigator window size.

Enum: month, year, day, hour, week, quarter

type

Type: string

Data type of the navigator axis field.

value

Type: string

Initial navigator window size.

Example: example

Size and unit of the initial navigator window.

Example

{
  "type": "date",
  "value": "example",
  "period": "month"
}

selectedLines

Type: string[]

Series names shown in the navigator; values are not field GUIDs.

Example

[
  "example"
]

Chart navigator settings.

Example

{
  "navigatorMode": "show",
  "selectedLines": [
    "example"
  ],
  "linesMode": "all",
  "periodSettings": {
    "type": "date",
    "value": "example",
    "period": "month"
  }
}

title

Type: string

Chart title.

Example: example

titleMode

Type: string

Whether the chart title is displayed.

Enum: show, hide

tooltip

Type: string

Whether chart tooltips are displayed.

Enum: show, hide

tooltipSum

Type: string

Whether tooltips include a total value.

Enum: on, off

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "tooltipSum": "on",
  "feed": "example",
  "navigatorSettings": {
    "navigatorMode": "show",
    "selectedLines": [
      "example"
    ],
    "linesMode": "all",
    "periodSettings": {
      "type": "date",
      "value": "example",
      "period": "month"
    }
  }
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as data labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

overlap

Type: string

Whether data labels may overlap.

Enum: on, off

Data label settings.

Example

{
  "overlap": "on"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "overlap": "on"
  }
}

segments

Type: object

items

Type: WizardFieldSchema[]

Fields used to split the chart into segments.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Segmentation configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Example

{
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  },
  "segments": {
    "items": [
      null
    ]
  },
  "type": "area100p",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "tooltipSum": "on",
    "feed": "example",
    "navigatorSettings": {
      "navigatorMode": "show",
      "selectedLines": [
        "example"
      ],
      "linesMode": "all",
      "periodSettings": {
        "type": "date",
        "value": "example",
        "period": "month"
      }
    }
  }
}

Type: object

type

Type: string

Bar visualization type.

Const: bar

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "axisModeMap": {}
}

Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "axisModeMap": {}
  }
}

chartSettings

Type: object

feed	Type: string Comment feed identifier. Example: `example`
legendMode	Type: string Whether the chart legend is displayed. Enum: `show`, `hide`
title	Type: string Chart title. Example: `example`
titleMode	Type: string Whether the chart title is displayed. Enum: `show`, `hide`
tooltip	Type: string Whether chart tooltips are displayed. Enum: `show`, `hide`
tooltipSum	Type: string Whether tooltips include a total value. Enum: `on`, `off`

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "tooltipSum": "on",
  "feed": "example"
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as data labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

labelsPosition

Type: string

Position of data labels relative to bars.

Enum: outside, inside

overlap

Type: string

Whether data labels may overlap.

Enum: on, off

Data label settings.

Example

{
  "overlap": "on",
  "labelsPosition": "outside"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "overlap": "on",
    "labelsPosition": "outside"
  }
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Example

{
  "type": "bar",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "tooltipSum": "on",
    "feed": "example"
  },
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "axisModeMap": {}
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on",
      "labelsPosition": "outside"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
}

Type: object

type

Type: string

Normalized bar visualization type.

Const: bar100p

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "axisModeMap": {}
}

Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "axisModeMap": {}
  }
}

chartSettings

Type: object

feed	Type: string Comment feed identifier. Example: `example`
legendMode	Type: string Whether the chart legend is displayed. Enum: `show`, `hide`
title	Type: string Chart title. Example: `example`
titleMode	Type: string Whether the chart title is displayed. Enum: `show`, `hide`
tooltip	Type: string Whether chart tooltips are displayed. Enum: `show`, `hide`
tooltipSum	Type: string Whether tooltips include a total value. Enum: `on`, `off`

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "tooltipSum": "on",
  "feed": "example"
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as data labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

overlap

Type: string

Whether data labels may overlap.

Enum: on, off

Data label settings.

Example

{
  "overlap": "on"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "overlap": "on"
  }
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

nulls

Type: string

How null values are displayed.

Enum: ignore, connect, as-0, use-previous

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "scale": "auto",
  "scaleValue": "min-max",
  "nulls": "ignore"
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "scale": "auto",
    "scaleValue": "min-max",
    "nulls": "ignore"
  }
}

Example

{
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "tooltipSum": "on",
    "feed": "example"
  },
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "axisModeMap": {}
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  },
  "type": "bar100p",
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on"
    }
  }
}

Type: object

dimensions

Type: object

items

Type: WizardFieldSchema[]

Dimensions used to create funnel stages.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Dimension configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

measures

Type: object

items

Type: WizardFieldSchema[]

Measures used to size funnel stages.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Measure configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Funnel visualization type.

Const: funnel

Example: example

chartSettings

Type: object

barGap	Type: string Gap between funnel segments. Enum: `auto`, `s`, `m`, `l`, `none`
legendMode	Type: string Whether the chart legend is displayed. Enum: `show`, `hide`
shape	Type: string Funnel segment shape. Enum: `auto`, `rectangle`, `trapezoid`
title	Type: string Chart title. Example: `example`
titleMode	Type: string Whether the chart title is displayed. Enum: `show`, `hide`
tooltip	Type: string Whether chart tooltips are displayed. Enum: `show`, `hide`
tooltipPercentageBase	Type: string Base used to calculate tooltip percentages. Enum: `auto`, `first`, `previous`

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "barGap": "auto",
  "shape": "auto",
  "tooltipPercentageBase": "auto"
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used to assign stage colors.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as stage labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

settings

Type: object

align	Type: string Data label alignment. Enum: `auto`, `left`, `center`, `right`
overlap	Type: string Whether data labels may overlap. Enum: `on`, `off`
position	Type: string Position of labels relative to funnel stages. Enum: `outside`, `inside`
reserveSpace	Type: string Mode for reserving chart space for data labels. Enum: `auto`, `on`, `off`
separator	Type: string Separator between label parts. Enum: `auto`, `space`, `line-break`

Data label settings.

Example

{
  "position": "outside",
  "align": "auto",
  "reserveSpace": "auto",
  "separator": "auto",
  "overlap": "on"
}

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ],
  "settings": {
    "position": "outside",
    "align": "auto",
    "reserveSpace": "auto",
    "separator": "auto",
    "overlap": "on"
  }
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Example

{
  "type": "funnel",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "barGap": "auto",
    "shape": "auto",
    "tooltipPercentageBase": "auto"
  },
  "dimensions": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "measures": {
    "items": [
      null
    ]
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "position": "outside",
      "align": "auto",
      "reserveSpace": "auto",
      "separator": "auto",
      "overlap": "on"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
}

Type: object

type

Type: string

Scatter visualization type.

Const: scatter

Example: example

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the X-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

holidays

Type: string

Whether holidays are highlighted on the axis.

Enum: on, off

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

X-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "holidays": "on",
  "scale": "auto",
  "scaleValue": "min-max",
  "axisModeMap": {}
}

X-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "holidays": "on",
    "scale": "auto",
    "scaleValue": "min-max",
    "axisModeMap": {}
  }
}

chartSettings

Type: object

feed	Type: string Comment feed identifier. Example: `example`
legendMode	Type: string Whether the chart legend is displayed. Enum: `show`, `hide`
title	Type: string Chart title. Example: `example`
titleMode	Type: string Whether the chart title is displayed. Enum: `show`, `hide`
tooltip	Type: string Whether chart tooltips are displayed. Enum: `show`, `hide`

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "feed": "example"
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

points

Type: object

items

Type: WizardFieldSchema[]

Fields used to group points and add tooltip information.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Point grouping configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

shapes

Type: object

items

Type: WizardFieldSchema[]

Fields used for shape encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

fieldGuid

Type: string

Identifier of the field used to assign shapes.

Example: example

mountedShapes

Type: object

[additional]

Type: string

Example: example

Mapping of field values to marker shapes.

Example

{}

Marker shape settings.

Example

{
  "fieldGuid": "example",
  "mountedShapes": {}
}

Marker shape configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "fieldGuid": "example",
    "mountedShapes": {}
  }
}

size

Type: object

items

Type: WizardFieldSchema[]

Fields used to determine point sizes.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

maxRadius

Type: number

Maximum point radius in pixels.

minRadius

Type: number

Minimum point radius in pixels.

radius

Type: number

Default point radius in pixels.

Point size settings.

Example

{
  "radius": 0.5,
  "minRadius": 0.5,
  "maxRadius": 0.5
}

Point size configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "radius": 0.5,
    "minRadius": 0.5,
    "maxRadius": 0.5
  }
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Type: object

items

Type: WizardFieldSchema[]

Fields placed on the Y-axis.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

axisFormatMode

Type: string

Axis label formatting mode.

Enum: auto, by-field, manual

axisLabelDateFormat

Type: string

Date or datetime axis label format.

Example: example

axisLabelFormatting

Type: object

format	Type: string Number formatting mode. Enum: `number`, `percent`
labelMode	Type: string How the formatted label is displayed. Enum: `absolute`, `percent`
postfix	Type: string Text displayed after the formatted value. Example: `example`
precision	Type: number Number of decimal places to display.
prefix	Type: string Text displayed before the formatted value. Example: `example`
showRankDelimiter	Type: boolean Whether to separate digit groups in numbers.
unit	Type: string Unit used to scale the numeric value. Enum: `auto`, `k`, `m`, `b`, `t`

Numeric axis label formatting.

Example

{
  "format": "number",
  "showRankDelimiter": true,
  "prefix": "example",
  "postfix": "example",
  "unit": "auto",
  "precision": 0.5,
  "labelMode": "absolute"
}

axisModeMap

Type: object

[additional]

Type: string

Enum: discrete, continuous

Maps field GUIDs to discrete or continuous axis modes.

Example

{}

axisVisibility

Type: string

Whether the axis is displayed.

Enum: show, hide

grid

Type: string

Whether axis grid lines are displayed.

Enum: on, off

gridStep

Type: string

Grid step calculation mode.

Enum: auto, manual

gridStepValue

Type: number

Manual grid-line spacing in pixels.

hideLabels

Type: string

Whether axis labels are hidden.

Enum: yes, no

labelsView

Type: string

Axis label orientation.

Enum: auto, horizontal, vertical, angle

scale

Type: string

Axis boundary calculation mode.

Enum: auto, manual

scaleValue

Any of 2 types

Type: string

Enum: min-max, data-min-max, 0-max
Type: unknown[]
Example
```
[
  null
]
```

Automatic scale mode or manual minimum and maximum values.

Example: min-max

title

Type: string

Axis title display mode.

Enum: auto, manual, off

titleValue

Type: string

Custom axis title.

Example: example

type

Type: string

Axis scale type.

Enum: linear, logarithmic

Y-axis settings.

Example

{
  "title": "auto",
  "titleValue": "example",
  "type": "linear",
  "grid": "on",
  "gridStep": "auto",
  "gridStepValue": 0.5,
  "hideLabels": "yes",
  "labelsView": "auto",
  "axisLabelFormatting": {
    "format": "number",
    "showRankDelimiter": true,
    "prefix": "example",
    "postfix": "example",
    "unit": "auto",
    "precision": 0.5,
    "labelMode": "absolute"
  },
  "axisLabelDateFormat": "example",
  "axisFormatMode": "auto",
  "axisVisibility": "show",
  "scale": "auto",
  "scaleValue": "min-max",
  "axisModeMap": {}
}

Y-axis configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "title": "auto",
    "titleValue": "example",
    "type": "linear",
    "grid": "on",
    "gridStep": "auto",
    "gridStepValue": 0.5,
    "hideLabels": "yes",
    "labelsView": "auto",
    "axisLabelFormatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "axisLabelDateFormat": "example",
    "axisFormatMode": "auto",
    "axisVisibility": "show",
    "scale": "auto",
    "scaleValue": "min-max",
    "axisModeMap": {}
  }
}

Example

{
  "type": "scatter",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "feed": "example"
  },
  "x": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "scale": "auto",
      "scaleValue": "min-max",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "axisModeMap": {}
    }
  },
  "points": {
    "items": [
      null
    ]
  },
  "size": {
    "items": [
      null
    ],
    "settings": {
      "radius": 0.5,
      "minRadius": 0.5,
      "maxRadius": 0.5
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "shapes": {
    "items": [
      null
    ],
    "settings": {
      "fieldGuid": "example",
      "mountedShapes": {}
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
}

Type: object

measures

Type: object

items

Type: WizardFieldSchema[]

Measures used to determine slice sizes.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Measure configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Pie visualization type.

Const: pie

Example: example

chartSettings

Type: object

legendMode	Type: string Whether the chart legend is displayed. Enum: `show`, `hide`
title	Type: string Chart title. Example: `example`
titleMode	Type: string Whether the chart title is displayed. Enum: `show`, `hide`
tooltip	Type: string Whether chart tooltips are displayed. Enum: `show`, `hide`

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show"
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

dimensions

Type: object

items

Type: WizardFieldSchema[]

Dimensions used to create pie slices.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Dimension configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as slice labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ]
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Example

{
  "type": "pie",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show"
  },
  "dimensions": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "measures": {
    "items": [
      null
    ]
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  },
  "labels": {
    "items": [
      null
    ]
  }
}

Type: object

measures

Type: object

items

Type: WizardFieldSchema[]

Measures used to determine slice sizes.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Measure configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Donut visualization type.

Const: donut

Example: example

chartSettings

Type: object

legendMode	Type: string Whether the chart legend is displayed. Enum: `show`, `hide`
title	Type: string Chart title. Example: `example`
titleMode	Type: string Whether the chart title is displayed. Enum: `show`, `hide`
tooltip	Type: string Whether chart tooltips are displayed. Enum: `show`, `hide`
totals	Type: string Whether the donut center displays a total. Enum: `on`, `off`

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "totals": "on"
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for color encoding.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

dimensions

Type: object

items

Type: WizardFieldSchema[]

Dimensions used to create pie slices.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Dimension configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

labels

Type: object

items

Type: WizardLabelsItemSchema[]

Fields whose values are displayed as slice labels.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": null,
      "showLabels": true,
      "align": "left",
      "scale": null,
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {}
    },
    "columnSettings": {
      "width": null,
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {}
    ],
    "labelPercentageBase": "auto"
  }
]

Data label configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {},
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {},
      "subTotalsSettings": {},
      "backgroundSettings": {},
      "columnSettings": {},
      "hintSettings": {},
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        null
      ],
      "labelPercentageBase": "auto"
    }
  ]
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Example

{
  "dimensions": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "measures": {
    "items": [
      null
    ]
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  },
  "labels": {
    "items": [
      null
    ]
  },
  "type": "donut",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "totals": "on"
  }
}

Type: object

measures

Type: object

items

Type: WizardFieldSchema[]

Measures displayed by the metric.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Measure configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Metric visualization type.

Const: metric

Example: example

chartSettings

Type: object

metricFontColor	Type: string Custom color of the metric value. Example: `example`
metricFontColorIndex	Type: number Metric value color index in the palette.
metricFontColorPalette	Type: string Color palette used for the metric value. Example: `example`
metricFontSize	Type: string Font size of the metric value. Enum: `s`, `m`, `l`, `xl`
title	Type: string Metric title. Example: `example`
titleMode	Type: string Metric title display mode. Enum: `by-field`, `manual`, `hide`

Chart configuration.

Example

{
  "metricFontColorPalette": "example",
  "metricFontSize": "s",
  "metricFontColor": "example",
  "metricFontColorIndex": 0.5,
  "titleMode": "by-field",
  "title": "example"
}

colors

Type: object

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

isMarkup

Type: boolean

Whether the metric value uses the markup data type.

Example

{
  "type": "metric",
  "isMarkup": true,
  "chartSettings": {
    "metricFontColorPalette": "example",
    "metricFontSize": "s",
    "metricFontColor": "example",
    "metricFontColorIndex": 0.5,
    "titleMode": "by-field",
    "title": "example"
  },
  "measures": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "colors": {
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  }
}

Type: object

dimensions

Type: object

items

Type: WizardFieldSchema[]

Dimensions used to group treemap nodes.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Dimension configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

measures

Type: object

items

Type: WizardFieldSchema[]

Measures used to size treemap nodes.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Measure configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Treemap visualization type.

Const: treemap

Example: example

chartSettings

Type: object

title

Type: string

Chart title.

Example: example

titleMode

Type: string

Whether the chart title is displayed.

Enum: show, hide

tooltip

Type: string

Whether chart tooltips are displayed.

Enum: show, hide

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "tooltip": "show"
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used to assign node colors.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

Example

{
  "type": "treemap",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "tooltip": "show"
  },
  "dimensions": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "measures": {
    "items": [
      null
    ]
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  }
}

Type: object

columns

Type: object

items

Type: WizardFieldSchema[]

Fields displayed as table columns.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Column configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Flat table visualization type.

Const: flatTable

Example: example

chartSettings

Type: object

grouping	Type: string Table row grouping mode. Enum: `on`, `disabled`, `off`
limit	Type: number Maximum number of rows displayed per page.
pagination	Type: string Whether table pagination is enabled. Enum: `on`, `off`
pinnedColumns	Type: number Number of columns pinned to the left side.
preserveWhiteSpace	Type: boolean Whether whitespace in table values is preserved.
size	Type: string Table row density. Enum: `l`, `m`, `s`
title	Type: string Chart title. Example: `example`
titleMode	Type: string Whether the chart title is displayed. Enum: `show`, `hide`
totals	Type: string Whether a total row is displayed. Enum: `on`, `off`

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "size": "l",
  "pagination": "on",
  "limit": 0.5,
  "grouping": "on",
  "totals": "on",
  "pinnedColumns": 0.5,
  "preserveWhiteSpace": true
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for conditional coloring.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Example

{
  "type": "flatTable",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "size": "l",
    "pagination": "on",
    "limit": 0.5,
    "grouping": "on",
    "totals": "on",
    "pinnedColumns": 0.5,
    "preserveWhiteSpace": true
  },
  "columns": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
}

Type: object

columns

Type: object

items

Type: WizardFieldSchema[]

Dimensions displayed as pivot columns.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Column configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

measures

Type: object

items

Type: WizardFieldSchema[]

Measures displayed in pivot cells.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Measure configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

rows

Type: object

items

Type: WizardFieldSchema[]

Dimensions displayed as pivot rows.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

Row configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ]
}

type

Type: string

Pivot table visualization type.

Const: pivotTable

Example: example

chartSettings

Type: object

limit	Type: number Maximum number of rows displayed per page.
pagination	Type: string Whether table pagination is enabled. Enum: `on`, `off`
pinnedColumns	Type: number Number of columns pinned to the left side.
pivotFallback	Type: string Whether to use the legacy pivot-table renderer. Enum: `on`, `off`
pivotInlineSort	Type: string Whether sorting the pivot table by rows is enabled. Enum: `on`, `off`
preserveWhiteSpace	Type: boolean Whether whitespace in table values is preserved.
size	Type: string Table row density. Enum: `l`, `m`, `s`
title	Type: string Chart title. Example: `example`
titleMode	Type: string Whether the chart title is displayed. Enum: `show`, `hide`

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "size": "l",
  "pagination": "on",
  "limit": 0.5,
  "pivotFallback": "on",
  "pivotInlineSort": "on",
  "pinnedColumns": 0.5,
  "preserveWhiteSpace": true
}

colors

Type: object

items

Type: WizardFieldSchema[]

Fields used for conditional coloring.

Example

[
  {
    "fakeTitle": "example",
    "markupType": "none",
    "formatting": {
      "format": "number",
      "showRankDelimiter": true,
      "prefix": "example",
      "postfix": "example",
      "unit": "auto",
      "precision": 0.5,
      "labelMode": "absolute"
    },
    "format": "example",
    "hideLabelMode": "show",
    "barsSettings": {
      "enabled": true,
      "colorSettings": {},
      "showLabels": true,
      "align": "left",
      "scale": {},
      "showBarsInTotals": true
    },
    "subTotalsSettings": {
      "enabled": true
    },
    "backgroundSettings": {
      "enabled": true,
      "colorFieldGuid": "example",
      "settingsId": "example",
      "settings": {
        "paletteState": {},
        "gradientState": {},
        "isContinuous": true
      }
    },
    "columnSettings": {
      "width": {},
      "horizontalAlignment": "auto"
    },
    "hintSettings": {
      "enabled": true,
      "text": "example"
    },
    "guid": "example",
    "title": "example",
    "data_type": "hierarchy",
    "fields": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
]

settings

Type: object

coloredByMeasure

Type: boolean

Whether colors are determined by a measure.

colorMode

Type: string

Color assignment mode.

Enum: palette, gradient

fieldGuid

Type: string

Identifier of the field used for coloring.

Example: example

gradientMode

Type: string

Gradient type.

Enum: 2-point, 3-point

gradientPalette

Type: string

Gradient palette identifier.

Example: example

leftThreshold

Type: string

Lower gradient threshold.

Example: example

middleThreshold

Type: string

Middle gradient threshold.

Example: example

mountedColors

Type: object

[additional]

Type: string

Example: example

Mapping of field values to colors.

Example

{}

nullMode

Type: string

How null values are colored.

Enum: ignore, as-0

palette

Type: string

Color palette identifier.

Example: example

polygonBorders

Type: string

Whether polygon borders are displayed.

Enum: show, hide

reversed

Type: boolean

Whether to reverse the color palette.

rightThreshold

Type: string

Upper gradient threshold.

Example: example

thresholdsMode

Type: string

Mode used to calculate gradient thresholds.

Enum: auto, manual

Color settings.

Example

{
  "thresholdsMode": "auto",
  "leftThreshold": "example",
  "middleThreshold": "example",
  "rightThreshold": "example",
  "gradientPalette": "example",
  "gradientMode": "2-point",
  "polygonBorders": "show",
  "reversed": true,
  "fieldGuid": "example",
  "mountedColors": {},
  "coloredByMeasure": true,
  "palette": "example",
  "colorMode": "palette",
  "nullMode": "ignore"
}

Color configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "markupType": "none",
      "formatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "format": "example",
      "hideLabelMode": "show",
      "barsSettings": {
        "enabled": true,
        "colorSettings": null,
        "showLabels": true,
        "align": "left",
        "scale": null,
        "showBarsInTotals": true
      },
      "subTotalsSettings": {
        "enabled": true
      },
      "backgroundSettings": {
        "enabled": true,
        "colorFieldGuid": "example",
        "settingsId": "example",
        "settings": {}
      },
      "columnSettings": {
        "width": null,
        "horizontalAlignment": "auto"
      },
      "hintSettings": {
        "enabled": true,
        "text": "example"
      },
      "guid": "example",
      "title": "example",
      "data_type": "hierarchy",
      "fields": [
        {}
      ]
    }
  ],
  "settings": {
    "thresholdsMode": "auto",
    "leftThreshold": "example",
    "middleThreshold": "example",
    "rightThreshold": "example",
    "gradientPalette": "example",
    "gradientMode": "2-point",
    "polygonBorders": "show",
    "reversed": true,
    "fieldGuid": "example",
    "mountedColors": {},
    "coloredByMeasure": true,
    "palette": "example",
    "colorMode": "palette",
    "nullMode": "ignore"
  }
}

sort

Type: object

items

Type: WizardSortItemSchema[]

Chart sorting rules.

Example

[
  {
    "fakeTitle": "example",
    "format": "example",
    "direction": "ASC",
    "guid": "example",
    "datasetId": "example"
  }
]

Sorting configuration.

Example

{
  "items": [
    {
      "fakeTitle": "example",
      "format": "example",
      "direction": "ASC",
      "guid": "example",
      "datasetId": "example"
    }
  ]
}

Example

{
  "type": "pivotTable",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "size": "l",
    "pagination": "on",
    "limit": 0.5,
    "pivotFallback": "on",
    "pivotInlineSort": "on",
    "pinnedColumns": 0.5,
    "preserveWhiteSpace": true
  },
  "columns": {
    "items": [
      {
        "fakeTitle": "example",
        "markupType": "none",
        "formatting": {},
        "format": "example",
        "hideLabelMode": "show",
        "barsSettings": {},
        "subTotalsSettings": {},
        "backgroundSettings": {},
        "columnSettings": {},
        "hintSettings": {},
        "guid": "example",
        "title": "example",
        "data_type": "hierarchy",
        "fields": [
          null
        ]
      }
    ]
  },
  "rows": {
    "items": [
      null
    ]
  },
  "measures": {
    "items": [
      null
    ]
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "sort": {
    "items": [
      {
        "fakeTitle": "example",
        "format": "example",
        "direction": "ASC",
        "guid": "example",
        "datasetId": "example"
      }
    ]
  }
}

Type: object

layers

Type: WizardV1GeolayerLayerSchema[]

Layers included in the map.

Example

[
  {
    "type": "geopoint",
    "layerSettings": {
      "id": "example",
      "name": "example",
      "alpha": 0.5
    },
    "points": {
      "items": [
        null
      ]
    },
    "size": {
      "items": [
        null
      ],
      "settings": {
        "radius": 0.5
      }
    },
    "colors": {
      "items": [
        null
      ],
      "settings": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "polygonBorders": "show",
        "reversed": true,
        "fieldGuid": "example",
        "mountedColors": {},
        "coloredByMeasure": true,
        "palette": "example",
        "colorMode": "palette",
        "nullMode": "ignore"
      }
    },
    "labels": {
      "items": [
        null
      ]
    },
    "tooltip": {
      "items": [
        null
      ],
      "settings": {
        "color": "on",
        "fieldTitle": "on"
      }
    },
    "filters": {
      "items": [
        {}
      ]
    }
  }
]

type

Type: string

Geolayer visualization type.

Const: geolayer

Example: example

chartSettings

Type: object

legendMode	Type: string Whether the map legend is displayed. Enum: `show`, `hide`
mapCenterMode	Type: string Mode used to determine the initial map center. Enum: `auto`, `manual`
mapCenterValue	Any of 3 types Type: string Example: `example` Type: null Example: `null` Type: null Example: `null` Map center in "latitude,longitude" format. Example: `example`
title	Type: string Chart title. Example: `example`
titleMode	Type: string Whether the chart title is displayed. Enum: `show`, `hide`
zoomMode	Type: string Mode used to determine the initial map zoom. Enum: `auto`, `manual`
zoomValue	Any of 3 types Type: number Type: null Example: `null` Type: null Example: `null` Initial map zoom level from 1 to 21. Example: `0.5`

Map configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "mapCenterMode": "auto",
  "mapCenterValue": "example",
  "zoomMode": "auto",
  "zoomValue": 0.5
}

selectedLayerId

Type: string

Identifier of the currently selected layer.

Example: example

Example

{
  "type": "geolayer",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "mapCenterMode": "auto",
    "mapCenterValue": "example",
    "zoomMode": "auto",
    "zoomValue": 0.5
  },
  "layers": [
    {
      "type": "geopoint",
      "layerSettings": {
        "id": "example",
        "name": "example",
        "alpha": 0.5
      },
      "points": {
        "items": [
          null
        ]
      },
      "size": {
        "items": [
          null
        ],
        "settings": {}
      },
      "colors": {
        "items": [
          null
        ],
        "settings": {}
      },
      "labels": {
        "items": [
          null
        ]
      },
      "tooltip": {
        "items": [
          null
        ],
        "settings": {}
      },
      "filters": {
        "items": [
          null
        ]
      }
    }
  ],
  "selectedLayerId": "example"
}

Type: object

layers

Type: WizardV1CombinedChartLayerSchema[]

Layers included in the combined chart.

Example

[
  {
    "type": "line",
    "layerSettings": {
      "id": "example",
      "name": "example"
    },
    "x": {
      "items": [
        null
      ],
      "settings": {
        "title": "auto",
        "titleValue": "example",
        "type": "linear",
        "grid": "on",
        "gridStep": "auto",
        "gridStepValue": 0.5,
        "hideLabels": "yes",
        "labelsView": "auto",
        "axisLabelFormatting": {},
        "axisLabelDateFormat": "example",
        "axisFormatMode": "auto",
        "axisVisibility": "show",
        "holidays": "on",
        "axisModeMap": {}
      }
    },
    "y": {
      "items": [
        null
      ],
      "settings": {
        "title": "auto",
        "titleValue": "example",
        "type": "linear",
        "grid": "on",
        "gridStep": "auto",
        "gridStepValue": 0.5,
        "hideLabels": "yes",
        "labelsView": "auto",
        "axisLabelFormatting": {},
        "axisLabelDateFormat": "example",
        "axisFormatMode": "auto",
        "axisVisibility": "show",
        "scale": "auto",
        "scaleValue": null,
        "nulls": "ignore"
      }
    },
    "y2": {
      "items": [
        null
      ],
      "settings": {
        "title": "auto",
        "titleValue": "example",
        "type": "linear",
        "grid": "on",
        "gridStep": "auto",
        "gridStepValue": 0.5,
        "hideLabels": "yes",
        "labelsView": "auto",
        "axisLabelFormatting": {},
        "axisLabelDateFormat": "example",
        "axisFormatMode": "auto",
        "axisVisibility": "show",
        "scale": "auto",
        "scaleValue": null,
        "nulls": "ignore"
      }
    },
    "colors": {
      "items": [
        null
      ],
      "settings": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "polygonBorders": "show",
        "reversed": true,
        "fieldGuid": "example",
        "mountedColors": {},
        "coloredByMeasure": true,
        "palette": "example",
        "colorMode": "palette",
        "nullMode": "ignore"
      }
    },
    "shapes": {
      "items": [
        null
      ],
      "settings": {
        "fieldGuid": "example",
        "mountedShapes": {},
        "lineSettings": {},
        "commonLineSettings": {}
      }
    },
    "labels": {
      "items": [
        null
      ],
      "settings": {
        "overlap": "on"
      }
    },
    "sort": {
      "items": [
        null
      ]
    }
  }
]

type

Type: string

Combined chart visualization type.

Const: combined-chart

Example: example

chartSettings

Type: object

feed	Type: string Comment feed identifier. Example: `example`
legendMode	Type: string Whether the chart legend is displayed. Enum: `show`, `hide`
title	Type: string Chart title. Example: `example`
titleMode	Type: string Whether the chart title is displayed. Enum: `show`, `hide`
tooltip	Type: string Whether chart tooltips are displayed. Enum: `show`, `hide`

Chart configuration.

Example

{
  "title": "example",
  "titleMode": "show",
  "legendMode": "show",
  "tooltip": "show",
  "feed": "example"
}

selectedLayerId

Type: string

Identifier of the currently selected layer.

Example: example

Example

{
  "type": "combined-chart",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "feed": "example"
  },
  "layers": [
    {
      "type": "line",
      "layerSettings": {
        "id": "example",
        "name": "example"
      },
      "x": {
        "items": [
          null
        ],
        "settings": {}
      },
      "y": {
        "items": [
          null
        ],
        "settings": {}
      },
      "y2": {
        "items": [
          null
        ],
        "settings": {}
      },
      "colors": {
        "items": [
          null
        ],
        "settings": {}
      },
      "shapes": {
        "items": [
          null
        ],
        "settings": {}
      },
      "labels": {
        "items": [
          null
        ],
        "settings": {}
      },
      "sort": {
        "items": [
          null
        ]
      }
    }
  ],
  "selectedLayerId": "example"
}

Chart visualization configuration.

Example

{
  "type": "line",
  "chartSettings": {
    "title": "example",
    "titleMode": "show",
    "legendMode": "show",
    "tooltip": "show",
    "tooltipSum": "on",
    "feed": "example",
    "navigatorSettings": {
      "navigatorMode": "show",
      "selectedLines": [
        "example"
      ],
      "linesMode": "all",
      "periodSettings": {
        "type": "date",
        "value": "example",
        "period": "month"
      }
    }
  },
  "x": {
    "items": [
      {}
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "holidays": "on",
      "axisModeMap": {}
    }
  },
  "y": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "y2": {
    "items": [
      null
    ],
    "settings": {
      "title": "auto",
      "titleValue": "example",
      "type": "linear",
      "grid": "on",
      "gridStep": "auto",
      "gridStepValue": 0.5,
      "hideLabels": "yes",
      "labelsView": "auto",
      "axisLabelFormatting": {
        "format": "number",
        "showRankDelimiter": true,
        "prefix": "example",
        "postfix": "example",
        "unit": "auto",
        "precision": 0.5,
        "labelMode": "absolute"
      },
      "axisLabelDateFormat": "example",
      "axisFormatMode": "auto",
      "axisVisibility": "show",
      "scale": "auto",
      "scaleValue": "min-max",
      "nulls": "ignore"
    }
  },
  "colors": {
    "items": [
      null
    ],
    "settings": {
      "thresholdsMode": "auto",
      "leftThreshold": "example",
      "middleThreshold": "example",
      "rightThreshold": "example",
      "gradientPalette": "example",
      "gradientMode": "2-point",
      "polygonBorders": "show",
      "reversed": true,
      "fieldGuid": "example",
      "mountedColors": {},
      "coloredByMeasure": true,
      "palette": "example",
      "colorMode": "palette",
      "nullMode": "ignore"
    }
  },
  "shapes": {
    "items": [
      null
    ],
    "settings": {
      "fieldGuid": "example",
      "mountedShapes": {},
      "lineSettings": {},
      "commonLineSettings": {
        "lineWidth": null,
        "linecap": "butt",
        "linejoin": "bevel"
      }
    }
  },
  "labels": {
    "items": [
      null
    ],
    "settings": {
      "overlap": "on"
    }
  },
  "sort": {
    "items": [
      {}
    ]
  },
  "segments": {
    "items": [
      null
    ]
  }
}

Example

{
  "sources": {
    "datasetsIds": [
      "example"
    ],
    "updates": [
      {
        "action": "add_field",
        "field": {
          "guid": "example",
          "datasetId": "example",
          "title": "example",
          "type": "DIMENSION",
          "calc_mode": "formula",
          "formula": "example",
          "aggregation": "example",
          "cast": "example",
          "source": "example",
          "data_type": "date",
          "aggregation_locked": true,
          "autoaggregated": true,
          "grouping": "example",
          "fakeTitle": "example",
          "originalTitle": "example",
          "avatar_id": "example",
          "local": true,
          "quickFormula": true,
          "originalFormula": "example",
          "originalSource": "example",
          "originalDateCast": null,
          "format": "example",
          "default_value": null
        },
        "debug_info": "example"
      }
    ],
    "links": [
      {
        "id": "example",
        "fields": {}
      }
    ],
    "hierarchies": [
      {
        "guid": "example",
        "title": "example",
        "fields": [
          {}
        ]
      }
    ],
    "filters": [
      {
        "guid": "example",
        "datasetId": "example",
        "fakeTitle": "example",
        "filter": {
          "operation": {},
          "value": null
        }
      }
    ]
  },
  "visualization": {
    "type": "line",
    "chartSettings": {
      "title": "example",
      "titleMode": "show",
      "legendMode": "show",
      "tooltip": "show",
      "tooltipSum": "on",
      "feed": "example",
      "navigatorSettings": {
        "navigatorMode": "show",
        "selectedLines": [
          null
        ],
        "linesMode": "all",
        "periodSettings": {}
      }
    },
    "x": {
      "items": [
        null
      ],
      "settings": {
        "title": "auto",
        "titleValue": "example",
        "type": "linear",
        "grid": "on",
        "gridStep": "auto",
        "gridStepValue": 0.5,
        "hideLabels": "yes",
        "labelsView": "auto",
        "axisLabelFormatting": {},
        "axisLabelDateFormat": "example",
        "axisFormatMode": "auto",
        "axisVisibility": "show",
        "holidays": "on",
        "axisModeMap": {}
      }
    },
    "y": {
      "items": [
        null
      ],
      "settings": {
        "title": "auto",
        "titleValue": "example",
        "type": "linear",
        "grid": "on",
        "gridStep": "auto",
        "gridStepValue": 0.5,
        "hideLabels": "yes",
        "labelsView": "auto",
        "axisLabelFormatting": {},
        "axisLabelDateFormat": "example",
        "axisFormatMode": "auto",
        "axisVisibility": "show",
        "scale": "auto",
        "scaleValue": null,
        "nulls": "ignore"
      }
    },
    "y2": {
      "items": [
        null
      ],
      "settings": {
        "title": "auto",
        "titleValue": "example",
        "type": "linear",
        "grid": "on",
        "gridStep": "auto",
        "gridStepValue": 0.5,
        "hideLabels": "yes",
        "labelsView": "auto",
        "axisLabelFormatting": {},
        "axisLabelDateFormat": "example",
        "axisFormatMode": "auto",
        "axisVisibility": "show",
        "scale": "auto",
        "scaleValue": null,
        "nulls": "ignore"
      }
    },
    "colors": {
      "items": [
        null
      ],
      "settings": {
        "thresholdsMode": "auto",
        "leftThreshold": "example",
        "middleThreshold": "example",
        "rightThreshold": "example",
        "gradientPalette": "example",
        "gradientMode": "2-point",
        "polygonBorders": "show",
        "reversed": true,
        "fieldGuid": "example",
        "mountedColors": {},
        "coloredByMeasure": true,
        "palette": "example",
        "colorMode": "palette",
        "nullMode": "ignore"
      }
    },
    "shapes": {
      "items": [
        null
      ],
      "settings": {
        "fieldGuid": "example",
        "mountedShapes": {},
        "lineSettings": {},
        "commonLineSettings": {}
      }
    },
    "labels": {
      "items": [
        null
      ],
      "settings": {
        "overlap": "on"
      }
    },
    "sort": {
      "items": [
        null
      ]
    },
    "segments": {
      "items": [
        null
      ]
    }
  }
}

EntryAnnotationArg

Name

Description

description

Type: string

Description of the entry.

Example: example

Example

{
  "description": "example"
}

EntryLocationIdentifiers

Name	Description
key	Type: string Entry key when creating the entry in a folder. Example: `example`
name	Type: string Entry name when creating the entry in a workbook. Example: `example`
workbookId	Type: string ID of the workbook where the entry should be created. Example: `example`

Example

{
  "key": "example",
  "workbookId": "example",
  "name": "example"
}

Responses

200 OK

Response

Body

application/json

{
  "entry": {
    "version": 1,
    "entryId": "example",
    "key": null,
    "createdAt": "example",
    "createdBy": "example",
    "updatedAt": "example",
    "updatedBy": "example",
    "revId": "example",
    "savedId": "example",
    "publishedId": "example",
    "tenantId": "example",
    "hidden": true,
    "public": true,
    "workbookId": null,
    "scope": "widget",
    "type": "graph_wizard_node",
    "meta": {},
    "links": {},
    "annotation": {
      "description": "example"
    },
    "data": {
      "sources": {
        "datasetsIds": [
          "example"
        ],
        "updates": [
          {}
        ],
        "links": [
          {}
        ],
        "hierarchies": [
          {}
        ],
        "filters": [
          {}
        ]
      },
      "visualization": {
        "type": "line",
        "chartSettings": {},
        "x": {},
        "y": {},
        "y2": {},
        "colors": {},
        "shapes": {},
        "labels": {},
        "sort": {},
        "segments": {}
      }
    }
  }
}

Name

Description

entry

Type: WizardV1

Example

{
  "version": 1,
  "entryId": "example",
  "key": null,
  "createdAt": "example",
  "createdBy": "example",
  "updatedAt": "example",
  "updatedBy": "example",
  "revId": "example",
  "savedId": "example",
  "publishedId": "example",
  "tenantId": "example",
  "hidden": true,
  "public": true,
  "workbookId": null,
  "scope": "widget",
  "type": "graph_wizard_node",
  "meta": {},
  "links": {},
  "annotation": {
    "description": "example"
  },
  "data": {
    "sources": {
      "datasetsIds": [
        "example"
      ],
      "updates": [
        {
          "action": "add_field",
          "field": {},
          "debug_info": "example"
        }
      ],
      "links": [
        {
          "id": "example",
          "fields": {}
        }
      ],
      "hierarchies": [
        {
          "guid": "example",
          "title": "example",
          "fields": [
            null
          ]
        }
      ],
      "filters": [
        {
          "guid": "example",
          "datasetId": "example",
          "fakeTitle": "example",
          "filter": {}
        }
      ]
    },
    "visualization": {
      "type": "line",
      "chartSettings": {
        "title": "example",
        "titleMode": "show",
        "legendMode": "show",
        "tooltip": "show",
        "tooltipSum": "on",
        "feed": "example",
        "navigatorSettings": {}
      },
      "x": {
        "items": [
          null
        ],
        "settings": {}
      },
      "y": {
        "items": [
          null
        ],
        "settings": {}
      },
      "y2": {
        "items": [
          null
        ],
        "settings": {}
      },
      "colors": {
        "items": [
          null
        ],
        "settings": {}
      },
      "shapes": {
        "items": [
          null
        ],
        "settings": {}
      },
      "labels": {
        "items": [
          null
        ],
        "settings": {}
      },
      "sort": {
        "items": [
          null
        ]
      },
      "segments": {
        "items": [
          null
        ]
      }
    }
  }
}

WizardV1

Name	Description
createdAt	Type: string Creation timestamp. Example: `example`
createdBy	Type: string Creator of the entry. Example: `example`
data	Type: WizardV1ConfigSchema Example { "sources": { "datasetsIds": [ "example" ], "updates": [ { "action": "add_field", "field": { "guid": "example", "datasetId": "example", "title": "example", "type": "DIMENSION", "calc_mode": "formula", "formula": "example", "aggregation": "example", "cast": "example", "source": "example", "data_type": "date", "aggregation_locked": true, "autoaggregated": true, "grouping": "example", "fakeTitle": "example", "originalTitle": "example", "avatar_id": "example", "local": true, "quickFormula": true, "originalFormula": "example", "originalSource": "example", "originalDateCast": null, "format": "example", "default_value": null }, "debug_info": "example" } ], "links": [ { "id": "example", "fields": {} } ], "hierarchies": [ { "guid": "example", "title": "example", "fields": [ {} ] } ], "filters": [ { "guid": "example", "datasetId": "example", "fakeTitle": "example", "filter": { "operation": {}, "value": null } } ] }, "visualization": { "type": "line", "chartSettings": { "title": "example", "titleMode": "show", "legendMode": "show", "tooltip": "show", "tooltipSum": "on", "feed": "example", "navigatorSettings": { "navigatorMode": "show", "selectedLines": [ null ], "linesMode": "all", "periodSettings": {} } }, "x": { "items": [ null ], "settings": { "title": "auto", "titleValue": "example", "type": "linear", "grid": "on", "gridStep": "auto", "gridStepValue": 0.5, "hideLabels": "yes", "labelsView": "auto", "axisLabelFormatting": {}, "axisLabelDateFormat": "example", "axisFormatMode": "auto", "axisVisibility": "show", "holidays": "on", "axisModeMap": {} } }, "y": { "items": [ null ], "settings": { "title": "auto", "titleValue": "example", "type": "linear", "grid": "on", "gridStep": "auto", "gridStepValue": 0.5, "hideLabels": "yes", "labelsView": "auto", "axisLabelFormatting": {}, "axisLabelDateFormat": "example", "axisFormatMode": "auto", "axisVisibility": "show", "scale": "auto", "scaleValue": null, "nulls": "ignore" } }, "y2": { "items": [ null ], "settings": { "title": "auto", "titleValue": "example", "type": "linear", "grid": "on", "gridStep": "auto", "gridStepValue": 0.5, "hideLabels": "yes", "labelsView": "auto", "axisLabelFormatting": {}, "axisLabelDateFormat": "example", "axisFormatMode": "auto", "axisVisibility": "show", "scale": "auto", "scaleValue": null, "nulls": "ignore" } }, "colors": { "items": [ null ], "settings": { "thresholdsMode": "auto", "leftThreshold": "example", "middleThreshold": "example", "rightThreshold": "example", "gradientPalette": "example", "gradientMode": "2-point", "polygonBorders": "show", "reversed": true, "fieldGuid": "example", "mountedColors": {}, "coloredByMeasure": true, "palette": "example", "colorMode": "palette", "nullMode": "ignore" } }, "shapes": { "items": [ null ], "settings": { "fieldGuid": "example", "mountedShapes": {}, "lineSettings": {}, "commonLineSettings": {} } }, "labels": { "items": [ null ], "settings": { "overlap": "on" } }, "sort": { "items": [ null ] }, "segments": { "items": [ null ] } } }
entryId	Type: string Unique identifier of the entry. Example: `example`
hidden	Type: boolean Indicates if the entry is hidden.
key	Any of 3 types Type: null Example: `null` Type: string Example: `example` Type: null Example: `null` Key identifier of the entry. Example: `null`
meta	Type: object \| null Metadata associated with the entry. Example `{}`
public	Type: boolean Indicates if the entry is public.
publishedId	Type: string \| null Published version ID. Example: `example`
revId	Type: string Version ID for the Wizard chart. Example: `example`
savedId	Type: string Saved version ID. Example: `example`
scope	Type: string Type of the entry. For charts takes value: widget Const: `widget` Example: `example`
tenantId	Type: string Tenant ID. Example: `example`
updatedAt	Type: string Last update timestamp. Example: `example`
updatedBy	Type: string Last updater of the entry. Example: `example`
version	Type: number Entry API version. Const: `1`
workbookId	Any of 3 types Type: null Example: `null` Type: string Example: `example` Type: null Example: `null` ID of the workbook the Wizard chart belongs to. Example: `null`
annotation	Type: object \| null Annotation information. Example `{ "description": "example" }`
links	Type: object \| null Link information. Example `{}`
type	Type: string Enum: `graph_wizard_node`, `table_wizard_node`, `ymap_wizard_node`, `metric_wizard_node`, `markup_wizard_node`, `timeseries_wizard_node`, `d3_wizard_node`

Example

{
  "version": 1,
  "entryId": "example",
  "key": null,
  "createdAt": "example",
  "createdBy": "example",
  "updatedAt": "example",
  "updatedBy": "example",
  "revId": "example",
  "savedId": "example",
  "publishedId": "example",
  "tenantId": "example",
  "hidden": true,
  "public": true,
  "workbookId": null,
  "scope": "widget",
  "type": "graph_wizard_node",
  "meta": {},
  "links": {},
  "annotation": {
    "description": "example"
  },
  "data": {
    "sources": {
      "datasetsIds": [
        "example"
      ],
      "updates": [
        {
          "action": "add_field",
          "field": {},
          "debug_info": "example"
        }
      ],
      "links": [
        {
          "id": "example",
          "fields": {}
        }
      ],
      "hierarchies": [
        {
          "guid": "example",
          "title": "example",
          "fields": [
            null
          ]
        }
      ],
      "filters": [
        {
          "guid": "example",
          "datasetId": "example",
          "fakeTitle": "example",
          "filter": {}
        }
      ]
    },
    "visualization": {
      "type": "line",
      "chartSettings": {
        "title": "example",
        "titleMode": "show",
        "legendMode": "show",
        "tooltip": "show",
        "tooltipSum": "on",
        "feed": "example",
        "navigatorSettings": {}
      },
      "x": {
        "items": [
          null
        ],
        "settings": {}
      },
      "y": {
        "items": [
          null
        ],
        "settings": {}
      },
      "y2": {
        "items": [
          null
        ],
        "settings": {}
      },
      "colors": {
        "items": [
          null
        ],
        "settings": {}
      },
      "shapes": {
        "items": [
          null
        ],
        "settings": {}
      },
      "labels": {
        "items": [
          null
        ],
        "settings": {}
      },
      "sort": {
        "items": [
          null
        ]
      },
      "segments": {
        "items": [
          null
        ]
      }
    }
  }
}

🚧 [Experimental] Create wizard chart

RequestRequest

HeadersHeaders

BodyBody

WizardV1FiltersItemSchemaWizardV1FiltersItemSchema

WizardFieldSchemaWizardFieldSchema

WizardV1LineShapeSettingsSchemaWizardV1LineShapeSettingsSchema

WizardLabelsItemSchemaWizardLabelsItemSchema

WizardPseudoFieldSchemaWizardPseudoFieldSchema

WizardSortItemSchemaWizardSortItemSchema

WizardV1GeolayerLayerSchemaWizardV1GeolayerLayerSchema

WizardV1CombinedChartLayerSchemaWizardV1CombinedChartLayerSchema

WizardV1ConfigSchemaWizardV1ConfigSchema

EntryAnnotationArgEntryAnnotationArg

EntryLocationIdentifiersEntryLocationIdentifiers

ResponsesResponses

200 OK200 OK

BodyBody

WizardV1WizardV1

Was the article helpful?

Request

Headers

Body

WizardV1FiltersItemSchema

WizardFieldSchema

WizardV1LineShapeSettingsSchema

WizardLabelsItemSchema

WizardPseudoFieldSchema

WizardSortItemSchema

WizardV1GeolayerLayerSchema

WizardV1CombinedChartLayerSchema

WizardV1ConfigSchema

EntryAnnotationArg

EntryLocationIdentifiers

Responses

200 OK

Body

WizardV1