v1.VisualisationConfig8
Configuration of visualisation of defined type.
export interface VisualisationConfig8
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) | |||
boolean | (Optional) | ||
“low” | “medium” | “high” | (Optional) | ||
“small” | “medium” | “big” | (Optional) | ||
string | (Optional) | ||
“fit” | “fill” | (Optional) | ||
“clip” | “wrap” | (Optional) | ||
“top” | “middle” | “bottom” | (Optional) | ||
number | (Optional) | ||
number | (Optional) | ||
{ type?: “solid” | “pattern” | “outline”; pattern_name_mapping?: { [k: string]: “diagonal_grid_small” | “vertical_lines_small” | “grid_small” | “horizontal_lines_small” | “circle_small” | “flag_small” | “waffle_small” | “dot_small” | “pyramid_small” | “needle_small” | “diamond_small” | “pizza_small” | “diagonal_grid_medium” | “vertical_lines_medium” | “grid_large” | “horizontal_lines_medium” | “circle_medium” | “flag_medium” | “waffle_medium” | “dot_medium” | “pyramid_medium” | “needle_medium” | “diamond_medium” | “pizza_medium”; }; [k: string]: unknown; } | (Optional) | ||
number | (Optional) | ||
boolean | (Optional) | ||
number | (Optional) | ||
(Optional) | |||
(Optional) | |||
string | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
{ version?: string; enabled?: boolean; rules?: { id: string; target: { measure: string; } | { attribute: string; }; conditions: { id: string; operator: “all” | “equal_to” | “not_equal_to” | “less_than” | “less_than_or_equal_to” | “greater_than” | “greater_than_or_equal_to” | “between” | “not_between” | “contains” | “not_contains” | “starts_with” | “not_starts_with” | “ends_with” | “not_ends_with” | “is_empty” | “is_not_empty”; value?: number | string | { from: number; to: number; } | { absolute: { from: string; to: string; }; } | { relative: { granularity: “minute” | “hour” | “day” | “week” | “month” | “quarter” | “year”; from: number; to: number; }; }; format: { text?: string; fill?: string; scope: “cell” | “row”; }; }[]; }[]; suppressed_targets?: ({ measure: string; } | { attribute: string; })[]; } | (Optional) Conditional formatting rules that color cells or rows based on their values. | ||
boolean | (Optional) | ||
{ enabled?: boolean; content?: string; placement?: “above” | “below” | “replace”; } | (Optional) Custom tooltip section rendered in the visualization tooltip, authored in Markdown with metric/attribute references that resolve per hovered data point. | ||
“auto” | “backplate” | (Optional) | ||
boolean | “auto” | (Optional) | ||
boolean | “auto” | (Optional) | ||
boolean | “auto” | (Optional) | ||
boolean | (Optional) | ||
boolean | (Optional) | ||
boolean | (Optional) | ||
{ [k: string]: boolean; } | (Optional) | ||
boolean | (Optional) | ||
{ enabled?: boolean; point_shape_mapping?: { [k: string]: “circle” | “square” | “diamond” | “triangle” | “triangle-down”; }; [k: string]: unknown; } | (Optional) | ||
boolean | (Optional) Enable accessibility features for tables. | ||
number | (Optional) | ||
boolean | (Optional) | ||
number | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
“pinnedBottom” | “pinnedTop” | “bottom” | “top” | (Optional) Position of grand totals in the table. | ||
boolean | (Optional) | ||
“polygon” | “circle” | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
(Optional) | |||
(Optional) | |||
(Optional) | |||
boolean | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
string | (Optional) | ||
string | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
“linear” | “spline” | “stepped” | (Optional) Line shape with regards to data points (i.e. line interpolation). | ||
string[] | (Optional) | ||
string[] | (Optional) | ||
(Optional) | |||
“0.5x” | “0.75x” | “normal” | “1.25x” | “1.5x” | “default” | (Optional) | ||
string | (Optional) | ||
“0.5x” | “0.75x” | “normal” | “1.25x” | “1.5x” | “default” | (Optional) | ||
string | (Optional) | ||
number | (Optional) Number of rows per page when pagination is enabled. | ||
boolean | (Optional) Enable pagination for tables. | ||
string | (Optional) | ||
“filled” | “outline” | (Optional) | ||
“small” | “medium” | “large” | (Optional) | ||
“circle” | “iconByValue” | “oneIcon” | (Optional) | ||
boolean | (Optional) | ||
boolean | (Optional) | ||
{ wrap_text?: boolean; wrap_header_text?: boolean; column_overrides?: { locators?: { [k: string]: unknown; }[]; wrap_text?: boolean; wrap_header_text?: boolean; match_type?: “column” | “pivotGroup”; [k: string]: unknown; }[]; [k: string]: unknown; } | (Optional) Text wrapping settings for table cells and headers. | ||
string | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
number | (Optional) | ||
number | (Optional) | ||
number | (Optional) | ||
number | (Optional) | ||
boolean | (Optional) | ||
boolean | (Optional) | ||
“auto” | “continent_af” | “continent_as” | “continent_au” | “continent_eu” | “continent_na” | “continent_sa” | “world” | “custom” | (Optional) | ||
Width[] | (Optional) A list of widths in this visualisation. | ||
string | (Optional) | ||
boolean | (Optional) | ||
number | (Optional) | ||
number | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
number | (Optional) | ||
number | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
number | (Optional) | ||
number | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
“column” | “area” | “line” | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
number | (Optional) | ||
number | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
string | (Optional) | ||
boolean | (Optional) | ||
“column” | “area” | “line” | (Optional) | ||
boolean | (Optional) | ||
boolean | (Optional) | ||
number | (Optional) |
Property details
v1.VisualisationConfig8.anomaly_detection_colorproperty
anomaly_detection_color?: Color3;
v1.VisualisationConfig8.anomaly_detection_enabledproperty
anomaly_detection_enabled?: boolean;
v1.VisualisationConfig8.anomaly_detection_sensitivityproperty
anomaly_detection_sensitivity?: "low" | "medium" | "high";
v1.VisualisationConfig8.anomaly_detection_sizeproperty
anomaly_detection_size?: "small" | "medium" | "big";
v1.VisualisationConfig8.basemapproperty
basemap?: string;
v1.VisualisationConfig8.cell_image_sizingproperty
cell_image_sizing?: "fit" | "fill";
v1.VisualisationConfig8.cell_text_wrappingproperty
cell_text_wrapping?: "clip" | "wrap";
v1.VisualisationConfig8.cell_vertical_alignproperty
cell_vertical_align?: "top" | "middle" | "bottom";
v1.VisualisationConfig8.center_latproperty
center_lat?: number;
v1.VisualisationConfig8.center_lngproperty
center_lng?: number;
v1.VisualisationConfig8.chart_fillproperty
chart_fill?: {
type?: "solid" | "pattern" | "outline";
pattern_name_mapping?: {
[k: string]: "diagonal_grid_small" | "vertical_lines_small" | "grid_small" | "horizontal_lines_small" | "circle_small" | "flag_small" | "waffle_small" | "dot_small" | "pyramid_small" | "needle_small" | "diamond_small" | "pizza_small" | "diagonal_grid_medium" | "vertical_lines_medium" | "grid_large" | "horizontal_lines_medium" | "circle_medium" | "flag_medium" | "waffle_medium" | "dot_medium" | "pyramid_medium" | "needle_medium" | "diamond_medium" | "pizza_medium";
};
[k: string]: unknown;
};
v1.VisualisationConfig8.clustering_amountproperty
clustering_amount?: number;
v1.VisualisationConfig8.clustering_enabledproperty
clustering_enabled?: boolean;
v1.VisualisationConfig8.clustering_thresholdproperty
clustering_threshold?: number;
v1.VisualisationConfig8.colorproperty
color?: ColorDefinition;
v1.VisualisationConfig8.colorsproperty
colors?: ListOfColors;
v1.VisualisationConfig8.column_headerproperty
column_header?: string;
v1.VisualisationConfig8.comparison_enabledproperty
comparison_enabled?: boolean;
v1.VisualisationConfig8.comparison_typeproperty
comparison_type?: string;
v1.VisualisationConfig8.conditional_formattingproperty
Conditional formatting rules that color cells or rows based on their values.
conditional_formatting?: {
version?: string;
enabled?: boolean;
rules?: {
id: string;
target: {
measure: string;
} | {
attribute: string;
};
conditions: {
id: string;
operator: "all" | "equal_to" | "not_equal_to" | "less_than" | "less_than_or_equal_to" | "greater_than" | "greater_than_or_equal_to" | "between" | "not_between" | "contains" | "not_contains" | "starts_with" | "not_starts_with" | "ends_with" | "not_ends_with" | "is_empty" | "is_not_empty";
value?: number | string | {
from: number;
to: number;
} | {
absolute: {
from: string;
to: string;
};
} | {
relative: {
granularity: "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year";
from: number;
to: number;
};
};
format: {
text?: string;
fill?: string;
scope: "cell" | "row";
};
}[];
}[];
suppressed_targets?: ({
measure: string;
} | {
attribute: string;
})[];
};
v1.VisualisationConfig8.continuous_lineproperty
continuous_line?: boolean;
v1.VisualisationConfig8.custom_tooltipproperty
Custom tooltip section rendered in the visualization tooltip, authored in Markdown with metric/attribute references that resolve per hovered data point.
custom_tooltip?: {
enabled?: boolean;
content?: string;
placement?: "above" | "below" | "replace";
};
v1.VisualisationConfig8.data_labelsproperty
data_labels?: boolean | "auto";
v1.VisualisationConfig8.data_labels_styleproperty
data_labels_style?: "auto" | "backplate";
v1.VisualisationConfig8.data_pointsproperty
data_points?: boolean | "auto";
v1.VisualisationConfig8.data_totalsproperty
data_totals?: boolean | "auto";
v1.VisualisationConfig8.disable_alertsproperty
disable_alerts?: boolean;
v1.VisualisationConfig8.disable_drill_downproperty
disable_drill_down?: boolean;
v1.VisualisationConfig8.disable_drill_into_urlproperty
disable_drill_into_url?: boolean;
v1.VisualisationConfig8.disable_key_drive_analysisproperty
disable_key_drive_analysis?: {
[k: string]: boolean;
};
v1.VisualisationConfig8.disable_scheduled_exportsproperty
disable_scheduled_exports?: boolean;
v1.VisualisationConfig8.distinct_point_shapesproperty
distinct_point_shapes?: {
enabled?: boolean;
point_shape_mapping?: {
[k: string]: "circle" | "square" | "diamond" | "triangle" | "triangle-down";
};
[k: string]: unknown;
};
v1.VisualisationConfig8.enable_accessibilityproperty
Enable accessibility features for tables.
enable_accessibility?: boolean;
v1.VisualisationConfig8.forecast_confidenceproperty
forecast_confidence?: number;
v1.VisualisationConfig8.forecast_enabledproperty
forecast_enabled?: boolean;
v1.VisualisationConfig8.forecast_periodproperty
forecast_period?: number;
v1.VisualisationConfig8.forecast_seasonalproperty
forecast_seasonal?: boolean;
v1.VisualisationConfig8.formatproperty
format?: string;
v1.VisualisationConfig8.grand_totals_positionproperty
Position of grand totals in the table.
grand_totals_position?: "pinnedBottom" | "pinnedTop" | "bottom" | "top";
v1.VisualisationConfig8.grid_enabledproperty
grid_enabled?: boolean;
v1.VisualisationConfig8.grid_line_shapeproperty
grid_line_shape?: "polygon" | "circle";
v1.VisualisationConfig8.group_nearby_pointsproperty
group_nearby_points?: boolean;
v1.VisualisationConfig8.iconproperty
icon?: string;
v1.VisualisationConfig8.indicator_arrowproperty
indicator_arrow?: boolean;
v1.VisualisationConfig8.indicator_color_equalsproperty
indicator_color_equals?: Color3;
v1.VisualisationConfig8.indicator_color_negativeproperty
indicator_color_negative?: Color3;
v1.VisualisationConfig8.indicator_color_positiveproperty
indicator_color_positive?: Color3;
v1.VisualisationConfig8.indicator_colorsproperty
indicator_colors?: boolean;
v1.VisualisationConfig8.label_conditionalproperty
label_conditional?: boolean;
v1.VisualisationConfig8.label_defaultproperty
label_default?: string;
v1.VisualisationConfig8.label_equalsproperty
label_equals?: string;
v1.VisualisationConfig8.label_negativeproperty
label_negative?: string;
v1.VisualisationConfig8.label_positiveproperty
label_positive?: string;
v1.VisualisationConfig8.legend_enabledproperty
legend_enabled?: boolean;
v1.VisualisationConfig8.legend_positionproperty
legend_position?: string;
v1.VisualisationConfig8.line_shapeproperty
Line shape with regards to data points (i.e. line interpolation).
line_shape?: "linear" | "spline" | "stepped";
v1.VisualisationConfig8.line_style_control_metricsproperty
line_style_control_metrics?: string[];
v1.VisualisationConfig8.line_style_excluded_metricsproperty
line_style_excluded_metrics?: string[];
v1.VisualisationConfig8.line_style_mappingproperty
line_style_mapping?: LineStyleMapping;
v1.VisualisationConfig8.max_sizeproperty
max_size?: "0.5x" | "0.75x" | "normal" | "1.25x" | "1.5x" | "default";
v1.VisualisationConfig8.metrics_inproperty
metrics_in?: string;
v1.VisualisationConfig8.min_sizeproperty
min_size?: "0.5x" | "0.75x" | "normal" | "1.25x" | "1.5x" | "default";
v1.VisualisationConfig8.orientationproperty
orientation?: string;
v1.VisualisationConfig8.page_sizeproperty
Number of rows per page when pagination is enabled.
page_size?: number;
v1.VisualisationConfig8.paginationproperty
Enable pagination for tables.
pagination?: boolean;
v1.VisualisationConfig8.positionproperty
position?: string;
v1.VisualisationConfig8.render_asproperty
render_as?: "filled" | "outline";
v1.VisualisationConfig8.row_heightproperty
row_height?: "small" | "medium" | "large";
v1.VisualisationConfig8.shape_typeproperty
shape_type?: "circle" | "iconByValue" | "oneIcon";
v1.VisualisationConfig8.stack_measuresproperty
stack_measures?: boolean;
v1.VisualisationConfig8.stack_measures_to_100property
stack_measures_to_100?: boolean;
v1.VisualisationConfig8.text_wrappingproperty
Text wrapping settings for table cells and headers.
text_wrapping?: {
wrap_text?: boolean;
wrap_header_text?: boolean;
column_overrides?: {
locators?: {
[k: string]: unknown;
}[];
wrap_text?: boolean;
wrap_header_text?: boolean;
match_type?: "column" | "pivotGroup";
[k: string]: unknown;
}[];
[k: string]: unknown;
};
v1.VisualisationConfig8.tooltip_textproperty
tooltip_text?: string;
v1.VisualisationConfig8.total_enabledproperty
total_enabled?: boolean;
v1.VisualisationConfig8.total_nameproperty
total_name?: string;
v1.VisualisationConfig8.viewportproperty
viewport?: "auto" | "continent_af" | "continent_as" | "continent_au" | "continent_eu" | "continent_na" | "continent_sa" | "world" | "custom";
v1.VisualisationConfig8.viewport_bounds_ne_latproperty
viewport_bounds_ne_lat?: number;
v1.VisualisationConfig8.viewport_bounds_ne_lngproperty
viewport_bounds_ne_lng?: number;
v1.VisualisationConfig8.viewport_bounds_sw_latproperty
viewport_bounds_sw_lat?: number;
v1.VisualisationConfig8.viewport_bounds_sw_lngproperty
viewport_bounds_sw_lng?: number;
v1.VisualisationConfig8.viewport_panproperty
viewport_pan?: boolean;
v1.VisualisationConfig8.viewport_zoomproperty
viewport_zoom?: boolean;
v1.VisualisationConfig8.widthsproperty
A list of widths in this visualisation.
widths?: Width[];
v1.VisualisationConfig8.xaxis_formatproperty
xaxis_format?: string;
v1.VisualisationConfig8.xaxis_labelsproperty
xaxis_labels?: boolean;
v1.VisualisationConfig8.xaxis_maxproperty
xaxis_max?: number;
v1.VisualisationConfig8.xaxis_minproperty
xaxis_min?: number;
v1.VisualisationConfig8.xaxis_name_positionproperty
xaxis_name_position?: string;
v1.VisualisationConfig8.xaxis_name_visibleproperty
xaxis_name_visible?: boolean;
v1.VisualisationConfig8.xaxis_rotationproperty
xaxis_rotation?: string;
v1.VisualisationConfig8.xaxis_visibleproperty
xaxis_visible?: boolean;
v1.VisualisationConfig8.yaxis_formatproperty
yaxis_format?: string;
v1.VisualisationConfig8.yaxis_labelsproperty
yaxis_labels?: boolean;
v1.VisualisationConfig8.yaxis_maxproperty
yaxis_max?: number;
v1.VisualisationConfig8.yaxis_minproperty
yaxis_min?: number;
v1.VisualisationConfig8.yaxis_name_positionproperty
yaxis_name_position?: string;
v1.VisualisationConfig8.yaxis_name_visibleproperty
yaxis_name_visible?: boolean;
v1.VisualisationConfig8.yaxis_primary_formatproperty
yaxis_primary_format?: string;
v1.VisualisationConfig8.yaxis_primary_labelsproperty
yaxis_primary_labels?: boolean;
v1.VisualisationConfig8.yaxis_primary_maxproperty
yaxis_primary_max?: number;
v1.VisualisationConfig8.yaxis_primary_minproperty
yaxis_primary_min?: number;
v1.VisualisationConfig8.yaxis_primary_name_positionproperty
yaxis_primary_name_position?: string;
v1.VisualisationConfig8.yaxis_primary_name_visibleproperty
yaxis_primary_name_visible?: boolean;
v1.VisualisationConfig8.yaxis_primary_rotationproperty
yaxis_primary_rotation?: string;
v1.VisualisationConfig8.yaxis_primary_typeproperty
yaxis_primary_type?: "column" | "area" | "line";
v1.VisualisationConfig8.yaxis_primary_visibleproperty
yaxis_primary_visible?: boolean;
v1.VisualisationConfig8.yaxis_rotationproperty
yaxis_rotation?: string;
v1.VisualisationConfig8.yaxis_secondary_formatproperty
yaxis_secondary_format?: string;
v1.VisualisationConfig8.yaxis_secondary_labelsproperty
yaxis_secondary_labels?: boolean;
v1.VisualisationConfig8.yaxis_secondary_maxproperty
yaxis_secondary_max?: number;
v1.VisualisationConfig8.yaxis_secondary_minproperty
yaxis_secondary_min?: number;
v1.VisualisationConfig8.yaxis_secondary_name_positionproperty
yaxis_secondary_name_position?: string;
v1.VisualisationConfig8.yaxis_secondary_name_visibleproperty
yaxis_secondary_name_visible?: boolean;
v1.VisualisationConfig8.yaxis_secondary_rotationproperty
yaxis_secondary_rotation?: string;
v1.VisualisationConfig8.yaxis_secondary_show_on_rightproperty
yaxis_secondary_show_on_right?: boolean;
v1.VisualisationConfig8.yaxis_secondary_typeproperty
yaxis_secondary_type?: "column" | "area" | "line";
v1.VisualisationConfig8.yaxis_secondary_visibleproperty
yaxis_secondary_visible?: boolean;
v1.VisualisationConfig8.yaxis_visibleproperty
yaxis_visible?: boolean;
v1.VisualisationConfig8.zoom_levelproperty
zoom_level?: number;