v1.SankeyChart
export interface SankeyChart
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) | |||
string | (Optional) An optional description of the visualisation. | ||
(Optional) | |||
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. | ||
(Optional) | |||
“sankey_chart” | Type of visualisation. | ||
(Bucket | EmptyBucket)[] | (Optional) A list of view by attributes in this visualisation. |
Property details
v1.SankeyChart.configproperty
config?: VisualisationConfig16;
v1.SankeyChart.descriptionproperty
An optional description of the visualisation.
description?: string;
v1.SankeyChart.fromproperty
from?: Bucket3;
v1.SankeyChart.idproperty
id: Id37;
v1.SankeyChart.is_hiddenpropertyDeprecated
Warning: This API is now obsolete.
Deprecated. Use ‘show_in_ai_results’ instead.
is_hidden?: boolean;
v1.SankeyChart.metricsproperty
A list of metrics in this visualisation.
metrics?: Bucket[];
v1.SankeyChart.queryproperty
query: Query16;
v1.SankeyChart.segment_byproperty
Not used in this graph type.
segment_by?: unknown[];
v1.SankeyChart.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.SankeyChart.tagsproperty
tags?: Tags30;
v1.SankeyChart.titleproperty
An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
title?: string;
v1.SankeyChart.toproperty
to?: Bucket4;
v1.SankeyChart.typeproperty
Type of visualisation.
type: "sankey_chart";
v1.SankeyChart.view_byproperty
A list of view by attributes in this visualisation.
view_by?: (Bucket | EmptyBucket)[];