v1.GeoChart
export interface GeoChart
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) | |||
string | (Optional) An optional description of the visualisation. | ||
boolean | (Optional) | ||
(Optional) A list of data layers in this visualisation. Layer buckets reuse the root-level query definition. | |||
(Bucket | EmptyBucket)[] | (Optional) A list of metrics in this visualisation. | ||
Bucket[] | (Optional) A list of segment by attributes in this visualisation. | ||
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. | ||
“geo_chart” | Type of visualisation. | ||
(Optional) A list of view by locations in this visualisation. |
Property details
v1.GeoChart.configproperty
config?: VisualisationConfig19;
v1.GeoChart.descriptionproperty
An optional description of the visualisation.
description?: string;
v1.GeoChart.idproperty
id: Id40;
v1.GeoChart.is_hiddenpropertyDeprecated
Warning: This API is now obsolete.
Deprecated. Use ‘show_in_ai_results’ instead.
is_hidden?: boolean;
v1.GeoChart.layersproperty
A list of data layers in this visualisation. Layer buckets reuse the root-level query definition.
layers?: LayerItem[];
v1.GeoChart.metricsproperty
A list of metrics in this visualisation.
metrics?: (Bucket | EmptyBucket)[];
v1.GeoChart.queryproperty
query: Query19;
v1.GeoChart.segment_byproperty
A list of segment by attributes in this visualisation.
segment_by?: Bucket[];
v1.GeoChart.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.GeoChart.tagsproperty
tags?: Tags33;
v1.GeoChart.titleproperty
An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
title?: string;
v1.GeoChart.typeproperty
Type of visualisation.
type: "geo_chart";
v1.GeoChart.view_byproperty
A list of view by locations in this visualisation.
view_by?: PushpinLocationBucket[];