VisualisationConfig

Home > @gooddata/sdk-code-schemas > v1 > VisualisationConfig

v1.VisualisationConfig interface

Configuration of visualisation of defined type.

Signature:

export interface VisualisationConfig 

Properties

Property	Modifiers	Type	Description
anomaly_detection_color?		Color3	(Optional)
anomaly_detection_enabled?		boolean	(Optional)
anomaly_detection_sensitivity?		"low" | "medium" | "high"	(Optional)
anomaly_detection_size?		"small" | "medium" | "big"	(Optional)
basemap?		string	(Optional)
cell_image_sizing?		"fit" | "fill"	(Optional)
cell_text_wrapping?		"clip" | "wrap"	(Optional)
cell_vertical_align?		"top" | "middle" | "bottom"	(Optional)
center_lat?		number	(Optional)
center_lng?		number	(Optional)
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; }	(Optional)
clustering_amount?		number	(Optional)
clustering_enabled?		boolean	(Optional)
clustering_threshold?		number	(Optional)
color?		ColorDefinition	(Optional)
colors?		ListOfColors	(Optional)
column_header?		string	(Optional)
comparison_enabled?		boolean	(Optional)
comparison_type?		string	(Optional)
continuous_line?		boolean	(Optional)
data_labels_style?		"auto" | "backplate"	(Optional)
data_labels?		boolean | "auto"	(Optional)
data_points?		boolean | "auto"	(Optional)
data_totals?		boolean | "auto"	(Optional)
disable_alerts?		boolean	(Optional)
disable_drill_down?		boolean	(Optional)
disable_drill_into_url?		boolean	(Optional)
disable_scheduled_exports?		boolean	(Optional)
distinct_point_shapes?		{ enabled?: boolean; point_shape_mapping?: { [k: string]: "circle" | "square" | "diamond" | "triangle" | "triangle-down"; }; [k: string]: unknown; }	(Optional)
enable_accessibility?		boolean	(Optional) Enable accessibility features for tables.
forecast_confidence?		number	(Optional)
forecast_enabled?		boolean	(Optional)
forecast_period?		number	(Optional)
forecast_seasonal?		boolean	(Optional)
format?		string	(Optional)
grand_totals_position?		"pinnedBottom" | "pinnedTop" | "bottom" | "top"	(Optional) Position of grand totals in the table.
grid_enabled?		boolean	(Optional)
group_nearby_points?		boolean	(Optional)
icon?		string	(Optional)
indicator_arrow?		boolean	(Optional)
indicator_color_equals?		Color3	(Optional)
indicator_color_negative?		Color3	(Optional)
indicator_color_positive?		Color3	(Optional)
indicator_colors?		boolean	(Optional)
label_conditional?		boolean	(Optional)
label_default?		string	(Optional)
label_equals?		string	(Optional)
label_negative?		string	(Optional)
label_positive?		string	(Optional)
legend_enabled?		boolean	(Optional)
legend_position?		string	(Optional)
line_style_control_metrics?		string[]	(Optional)
line_style_excluded_metrics?		string[]	(Optional)
max_size?		"0.5x" | "0.75x" | "normal" | "1.25x" | "1.5x" | "default"	(Optional)
metrics_in?		string	(Optional)
min_size?		"0.5x" | "0.75x" | "normal" | "1.25x" | "1.5x" | "default"	(Optional)
orientation?		string	(Optional)
page_size?		number	(Optional) Number of rows per page when pagination is enabled.
pagination?		boolean	(Optional) Enable pagination for tables.
position?		string	(Optional)
row_height?		"small" | "medium" | "large"	(Optional)
shape_type?		"circle" | "iconByValue" | "oneIcon"	(Optional)
stack_measures_to_100?		boolean	(Optional)
stack_measures?		boolean	(Optional)
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; }	(Optional) Text wrapping settings for table cells and headers.
tooltip_text?		string	(Optional)
total_enabled?		boolean	(Optional)
total_name?		string	(Optional)
viewport_bounds_ne_lat?		number	(Optional)
viewport_bounds_ne_lng?		number	(Optional)
viewport_bounds_sw_lat?		number	(Optional)
viewport_bounds_sw_lng?		number	(Optional)
viewport_pan?		boolean	(Optional)
viewport_zoom?		boolean	(Optional)
viewport?		"auto" | "continent_af" | "continent_as" | "continent_au" | "continent_eu" | "continent_na" | "continent_sa" | "world" | "custom"	(Optional)
widths?		Width[]	(Optional) A list of widths in this visualisation.
xaxis_format?		string	(Optional)
xaxis_labels?		boolean	(Optional)
xaxis_max?		number	(Optional)
xaxis_min?		number	(Optional)
xaxis_name_position?		string	(Optional)
xaxis_name_visible?		boolean	(Optional)
xaxis_rotation?		string	(Optional)
xaxis_visible?		boolean	(Optional)
yaxis_format?		string	(Optional)
yaxis_labels?		boolean	(Optional)
yaxis_max?		number	(Optional)
yaxis_min?		number	(Optional)
yaxis_name_position?		string	(Optional)
yaxis_name_visible?		boolean	(Optional)
yaxis_primary_format?		string	(Optional)
yaxis_primary_labels?		boolean	(Optional)
yaxis_primary_max?		number	(Optional)
yaxis_primary_min?		number	(Optional)
yaxis_primary_name_position?		string	(Optional)
yaxis_primary_name_visible?		boolean	(Optional)
yaxis_primary_rotation?		string	(Optional)
yaxis_primary_type?		"column" | "area" | "line"	(Optional)
yaxis_primary_visible?		boolean	(Optional)
yaxis_rotation?		string	(Optional)
yaxis_secondary_format?		string	(Optional)
yaxis_secondary_labels?		boolean	(Optional)
yaxis_secondary_max?		number	(Optional)
yaxis_secondary_min?		number	(Optional)
yaxis_secondary_name_position?		string	(Optional)
yaxis_secondary_name_visible?		boolean	(Optional)
yaxis_secondary_rotation?		string	(Optional)
yaxis_secondary_show_on_right?		boolean	(Optional)
yaxis_secondary_type?		"column" | "area" | "line"	(Optional)
yaxis_secondary_visible?		boolean	(Optional)
yaxis_visible?		boolean	(Optional)
zoom_level?		number	(Optional)