formatPanel
Through the formatPanel property, you are able to control all aspects of the format panel.
Through this function prop, we will provide the configuration for each of the format sections, which you can modify the values of.
Default section configs
Column chart
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "chartStyles",
"title": "Chart Settings",
"description": "",
"subSectionDefinition": {
"stacked": {
"type": "stacked",
"title": "Layout",
"description": "",
"namespace": "stacked"
},
"legend": {
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
},
"namespace": "chart_styles",
"subSection": [
{
"type": "stacked",
"title": "Layout",
"description": "",
"namespace": "stacked"
},
{
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
]
},
{
"type": "axisLabels",
"title": "Axis Preferences",
"description": "",
"subSectionDefinition": {
"x": {
"title": "X Axis",
"description": "",
"namespace": "x"
},
"x.prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"x.postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"x.format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"x.count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"x.axis_title": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
},
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y"
},
"y.prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"y.postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"y.format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"y.count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"y.axis_title": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"namespace": "axis_labels",
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"x": {
"title": "X Axis",
"description": "",
"namespace": "x",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
}
}
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"namespace": "conditional_formatting",
"ruleType": "backgroundColor"
},
{
"type": "goalLine",
"title": "Goal Lines",
"description": "",
"namespace": "goal_line"
},
{
"type": "headline",
"title": "Headline",
"description": "",
"namespace": "headline"
}
]Horizontal bar chart
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "chartStyles",
"title": "Chart Settings",
"description": "",
"subSectionDefinition": {
"stacked": {
"type": "stacked",
"title": "Layout",
"description": "",
"namespace": "stacked"
},
"legend": {
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
},
"namespace": "chart_styles",
"subSection": [
{
"type": "stacked",
"title": "Layout",
"description": "",
"namespace": "stacked"
},
{
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
]
},
{
"type": "axisLabels",
"title": "Axis Preferences",
"description": "",
"subSectionDefinition": {
"x": {
"title": "X Axis",
"description": "",
"namespace": "x"
},
"x.prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"x.postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"x.format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"x.count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"x.axis_title": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
},
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y"
},
"y.prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"y.postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"y.format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"y.count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"y.axis_title": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"namespace": "axis_labels",
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"x": {
"title": "X Axis",
"description": "",
"namespace": "x",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
}
}
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"namespace": "conditional_formatting",
"ruleType": "backgroundColor"
},
{
"type": "headline",
"title": "Headline",
"description": "",
"namespace": "headline"
}
]Funnel chart
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "chartStyles",
"title": "Chart Settings",
"description": "",
"subSectionDefinition": {
"legend": {
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
},
"namespace": "chart_styles",
"subSection": [
{
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
]
},
{
"type": "axisLabels",
"title": "Axis Preferences",
"description": "",
"subSectionDefinition": {
"x": {
"title": "X Axis",
"description": "",
"namespace": "x"
},
"x.prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"x.postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"x.format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"x.count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"x.axis_title": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
},
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y"
},
"y.prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"y.postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"y.format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"y.count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"y.axis_title": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"namespace": "axis_labels",
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"x": {
"title": "X Axis",
"description": "",
"namespace": "x",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
}
}
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"namespace": "conditional_formatting",
"ruleType": "backgroundColor"
},
{
"type": "headline",
"title": "Headline",
"description": "",
"namespace": "headline"
}
]Area chart
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "chartStyles",
"title": "Chart Settings",
"description": "",
"subSectionDefinition": {
"stacked": {
"type": "stacked",
"title": "Layout",
"description": "",
"namespace": "stacked"
},
"legend": {
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
},
"curve": {
"type": "curve",
"title": "Line Curve",
"description": "",
"namespace": "curve"
}
},
"namespace": "chart_styles",
"subSection": [
{
"type": "stacked",
"title": "Layout",
"description": "",
"namespace": "stacked"
},
{
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
},
{
"type": "curve",
"title": "Line Curve",
"description": "",
"namespace": "curve"
}
]
},
{
"type": "axisLabels",
"title": "Axis Preferences",
"description": "",
"subSectionDefinition": {
"x": {
"title": "X Axis",
"description": "",
"namespace": "x"
},
"x.prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"x.postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"x.format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"x.count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"x.axis_title": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
},
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y"
},
"y.prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"y.postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"y.format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"y.count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"y.axis_title": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"namespace": "axis_labels",
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"x": {
"title": "X Axis",
"description": "",
"namespace": "x",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
}
}
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"namespace": "conditional_formatting",
"ruleType": "areaColor"
},
{
"type": "goalLine",
"title": "Goal Lines",
"description": "",
"namespace": "goal_line"
},
{
"type": "headline",
"title": "Headline",
"description": "",
"namespace": "headline"
}
]Line chart
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "chartStyles",
"title": "Chart Settings",
"description": "",
"subSectionDefinition": {
"curve": {
"type": "curve",
"title": "Line Style",
"description": "",
"namespace": "curve"
},
"legend": {
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
},
"namespace": "chart_styles",
"subSection": [
{
"type": "curve",
"title": "Line Style",
"description": "",
"namespace": "curve"
},
{
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
]
},
{
"type": "axisLabels",
"title": "Axis Preferences",
"description": "",
"subSectionDefinition": {
"x": {
"title": "X Axis",
"description": "",
"namespace": "x"
},
"x.prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"x.postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"x.format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"x.count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"x.axis_title": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
},
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y"
},
"y.prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"y.postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"y.format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"y.count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"y.axis_title": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"namespace": "axis_labels",
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"x": {
"title": "X Axis",
"description": "",
"namespace": "x",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
}
}
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"namespace": "conditional_formatting",
"ruleType": "lineColor"
},
{
"type": "goalLine",
"title": "Goal Lines",
"description": "",
"namespace": "goal_line"
},
{
"type": "trends",
"title": "Trend lines",
"description": "Specify a trend type for the line chart.",
"namespace": "trends"
},
{
"type": "headline",
"title": "Headline",
"description": "",
"namespace": "headline"
}
]Line chart V2
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "chartStyles",
"title": "Chart Settings",
"description": "",
"subSectionDefinition": {
"curve": {
"type": "curve",
"title": "Line Style",
"description": "",
"namespace": "curve"
},
"legend": {
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
},
"namespace": "chart_styles",
"subSection": [
{
"type": "curve",
"title": "Line Style",
"description": "",
"namespace": "curve"
},
{
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
]
},
{
"type": "axisLabels",
"title": "Axis Preferences",
"description": "",
"subSectionDefinition": {
"x": {
"title": "X Axis",
"description": "",
"namespace": "x"
},
"x.prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"x.postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"x.format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"x.count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"x.axis_title": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
},
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y"
},
"y.prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"y.postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"y.format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"y.count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"y.axis_title": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"namespace": "axis_labels",
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"x": {
"title": "X Axis",
"description": "",
"namespace": "x",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
}
}
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"namespace": "conditional_formatting",
"ruleType": "lineColor"
},
{
"type": "goalLine",
"title": "Goal Lines",
"description": "",
"namespace": "goal_line"
}
]Scatter chart
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "chartStyles",
"title": "Chart Settings",
"description": "",
"subSectionDefinition": {
"legend": {
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
},
"namespace": "chart_styles",
"subSection": [
{
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
]
},
{
"type": "axisLabels",
"title": "Axis Preferences",
"description": "",
"subSectionDefinition": {
"x": {
"title": "X Axis",
"description": "",
"namespace": "x"
},
"x.prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"x.postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"x.format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"x.count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"x.axis_title": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
},
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y"
},
"y.prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"y.postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"y.format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"y.count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"y.axis_title": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"namespace": "axis_labels",
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"x": {
"title": "X Axis",
"description": "",
"namespace": "x",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
}
}
},
{
"type": "goalLine",
"title": "Goal Lines",
"description": "",
"namespace": "goal_line"
}
]Pie chart
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"namespace": "conditional_formatting",
"ruleType": "backgroundColor"
},
{
"type": "chartStyles",
"title": "Chart Settings",
"description": "",
"subSectionDefinition": {
"number_format": {
"type": "numberFormat",
"title": "Format",
"description": "",
"namespace": "number_format"
},
"legend": {
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
},
"labels": {
"type": "labels",
"title": "Show Labels",
"description": "",
"namespace": "labels"
}
},
"namespace": "chart_styles",
"subSection": [
{
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
},
{
"type": "labels",
"title": "Show Labels",
"description": "",
"namespace": "labels"
},
{
"type": "numberFormat",
"title": "Format",
"description": "",
"namespace": "number_format"
}
]
}
]Single stat
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "statsLabels",
"title": "Labels",
"description": "",
"subSectionDefinition": {
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "count"
}
},
"namespace": "stats_labels",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "count"
}
},
{
"type": "format",
"title": "Format",
"description": "",
"subSectionDefinition": {
"font_size": {
"title": "Font Size",
"type": "fontSize",
"description": "",
"namespace": "font_size"
},
"direction": {
"title": "Direction",
"type": "direction",
"description": "",
"namespace": "direction"
}
},
"namespace": "format",
"subSection": [
{
"title": "Font Size",
"type": "fontSize",
"description": "",
"namespace": "font_size"
},
{
"title": "Direction",
"type": "direction",
"description": "",
"namespace": "direction"
}
]
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"namespace": "conditional_formatting",
"ruleType": "fontColor"
}
]Pivot table
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "format",
"title": "Format",
"description": "",
"subSectionDefinition": {
"time": {
"type": "time",
"title": "Time",
"description": "",
"namespace": "time"
}
},
"namespace": "format",
"subSection": [
{
"type": "time",
"title": "Time",
"description": "",
"namespace": "time"
}
]
},
{
"type": "prefixes",
"title": "Prefixes",
"description": "",
"namespace": "prefixes"
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"namespace": "conditional_formatting",
"ruleType": "backgroundColor"
}
]Basic table
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"type": "subject",
"title": "Subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"type": "subject",
"title": "Subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "format",
"title": "Format",
"description": "",
"subSectionDefinition": {
"time": {
"type": "time",
"title": "Time",
"description": "",
"namespace": "time"
}
},
"namespace": "format",
"subSection": [
{
"type": "time",
"title": "Time",
"description": "",
"namespace": "time"
}
]
},
{
"type": "prefixes",
"title": "Prefixes",
"description": "",
"namespace": "prefixes"
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"namespace": "conditional_formatting",
"ruleType": "backgroundColor"
}
]Combo chart
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "chartStyles",
"title": "Chart Settings",
"description": "",
"subSectionDefinition": {
"stacked": {
"type": "stacked",
"title": "Layout",
"description": "",
"namespace": "stacked"
},
"legend": {
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
},
"namespace": "chart_styles",
"subSection": [
{
"type": "stacked",
"title": "Layout",
"description": "",
"namespace": "stacked"
},
{
"type": "legend",
"title": "Show Legend",
"description": "",
"namespace": "legend"
}
]
},
{
"type": "axisLabels",
"title": "Axis Preferences",
"description": "",
"subSectionDefinition": {
"x": {
"title": "X Axis",
"description": "",
"namespace": "x"
},
"x.prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"x.postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"x.format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"x.count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"x.axis_title": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
},
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y"
},
"y.prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"y.postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"y.format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"y.count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"y.axis_title": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"namespace": "axis_labels",
"y": {
"title": "Y Axis",
"description": "",
"namespace": "y",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "y.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "y.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "y.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "y.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "y.axis_title"
}
},
"x": {
"title": "X Axis",
"description": "",
"namespace": "x",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "x.prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "x.postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "x.format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "x.count"
},
"axisTitle": {
"title": "Title",
"description": "",
"namespace": "x.axis_title"
}
}
},
{
"type": "conditionalFormatting",
"title": "Conditional Formatting",
"description": "",
"subSectionDefinition": {
"bar": {
"title": "Bar",
"namespace": "bar"
},
"line": {
"title": "Line",
"namespace": "line"
}
},
"namespace": "conditional_formatting",
"ruleType": "backgroundColor",
"subSection": [
{
"title": "Bar",
"namespace": "bar",
"propKey": "bar"
},
{
"title": "Line",
"namespace": "line",
"propKey": "line"
}
]
},
{
"type": "goalLine",
"title": "Goal Lines",
"description": "",
"namespace": "goal_line"
}
]Country map
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "chartStyles",
"title": "Map Settings",
"description": "",
"subSectionDefinition": {
"number_format": {
"type": "numberFormat",
"title": "Value format",
"description": "",
"namespace": "number_format"
}
},
"namespace": "chart_styles",
"subSection": [
{
"type": "numberFormat",
"title": "Value format",
"description": "",
"namespace": "number_format"
}
]
},
{
"type": "mapColors",
"title": "Map colors",
"description": "",
"namespace": "map_colors"
}
]Progress
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "progressType",
"title": "Type",
"description": "",
"namespace": "progress_type"
},
{
"type": "statsLabels",
"title": "Labels",
"description": "",
"subSectionDefinition": {
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "count"
}
},
"namespace": "stats_labels",
"prefix": {
"title": "Prefix",
"description": "",
"namespace": "prefix"
},
"postfix": {
"title": "Postfix",
"description": "",
"namespace": "postfix"
},
"format": {
"title": "Format",
"description": "",
"namespace": "format"
},
"count": {
"title": "Label count",
"description": "",
"namespace": "count"
}
}
]Rich text
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
},
{
"type": "richText",
"title": "Text format",
"description": "",
"namespace": "rich_text"
}
]Progress
[
{
"type": "heading",
"title": "Heading",
"description": "",
"subSectionDefinition": {
"title": {
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
"subject": {
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
},
"namespace": "heading",
"subSection": [
{
"type": "title",
"title": "Title",
"description": "",
"namespace": "title"
},
{
"title": "Subject",
"type": "subject",
"description": "",
"namespace": "subject"
}
]
}
]Custom sections
To render your own section, you can provide a function in the config that renders a section of the panel.
We will call it with the following props;
attributes
View dependant properties that you can mutate using the setAttributes function.
dataSet
An object describing the currently chosen data set for the view.
dataSets
A list of all available data sets.
featureToggles
The currently active feature toggles.
setDataSet
A function that allows you to change the currently selected data set for the view.
setDataSet: (dataSetId: string) => void;setAttributes
A function that lets you update the attributes of the view.
setAttributes: (attributes: Partial<Attributes>) => void;setDataSets
A function that lets you mutate the data sets. This should only be used to set custom fields or if you have a custom Query Engine implementation that allows changes to the data set to be made in the editor.
setDataSets: (dataSets: Array<DataSet>) => void;queryEngineConfig
An object that defines the limitations of the query engine. For example, the available aggregate functions and time truncation functions.