v1.PieChart
export interface PieChart
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) | |||
string | (Optional) An optional description of the visualisation. | ||
boolean | (Optional) | ||
Bucket[] | (Optional) A list of metrics in this visualisation. | ||
unknown[] | (Optional) Not used in this graph type. | ||
boolean | (Optional) Optional flag to indicate if the visualisation should be shown in AI results. When omitted, the visualisation is visible. | ||
(Optional) | |||
string | (Optional) An optional human readable title for the visualisation. Will be derived from id if not provided explicitly. | ||
“pie_chart” | Type of visualisation. | ||
Bucket[] | (Optional) A list of view by attributes in this visualisation. |
Property details
v1.PieChart.configproperty
config?: VisualisationConfig7;
v1.PieChart.descriptionproperty
An optional description of the visualisation.
description?: string;
v1.PieChart.idproperty
id: Id28;
v1.PieChart.is_hiddenpropertyDeprecated
Warning: This API is now obsolete.
Deprecated. Use ‘show_in_ai_results’ instead.
is_hidden?: boolean;
v1.PieChart.metricsproperty
A list of metrics in this visualisation.
metrics?: Bucket[];
v1.PieChart.queryproperty
query: Query7;
v1.PieChart.segment_byproperty
Not used in this graph type.
segment_by?: unknown[];
v1.PieChart.show_in_ai_resultsproperty
Optional flag to indicate if the visualisation should be shown in AI results. When omitted, the visualisation is visible.
show_in_ai_results?: boolean;
v1.PieChart.tagsproperty
tags?: Tags21;
v1.PieChart.titleproperty
An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
title?: string;
v1.PieChart.typeproperty
Type of visualisation.
type: "pie_chart";
v1.PieChart.view_byproperty
A list of view by attributes in this visualisation.
view_by?: Bucket[];