thousandeyes-sdk-python/thousandeyes-sdk-dashboards/docs/ApiColorGridWidget.md

ApiColorGridWidget

The Color Grid widget displays colored cards arranged in rows and columns.

Properties

Name	Type	Description	Notes
id	str	Identifier of the widget.	[optional] [readonly]
title	str	Title of the widget	[optional]
visual_mode	VisualMode		[optional]
embed_url	str	When `isEmbedded` is set to `true`, an `embedUrl` is provided.	[optional] [readonly]
is_embedded	bool	Set to `true` if widget is marked as embedded; otherwise, set to `false`.	[optional]
metric_group	MetricGroup		[optional]
direction	DashboardMetricDirection		[optional]
metric	DashboardMetric		[optional]
filters	Dict[str, List[object]]	(Optional) Specifies the filters applied to the widget. When present, the `filters` property displays. Each filter object has two properties: `filterProperty` and `filterValue`. The `filterProperty` can be values like `AGENT`, `ENDPOINT_MACHINE_ID`, `TEST`, `MONITOR`, etc. The `filterValue` represents an identifier array of the selected property.	[optional]
measure	ApiWidgetMeasure		[optional]
fixed_timespan	ApiDuration		[optional]
api_link	str		[optional] [readonly]
should_exclude_alert_suppression_windows	bool	Excludes alert suppression window data if set to `true`.	[optional]
links	SelfLinks		[optional]
min_scale	float	Minimum scale configured in the widget.	[optional]
max_scale	float	Maximum scale configured in the widget.	[optional]
unit	ApiWidgetFixedYScalePrefix		[optional]
type	str	Color Grid widget type.
cards	ApiAggregateProperty		[optional]
group_cards_by	ApiAggregateProperty		[optional]
columns	int	Number of columns: 1 or 2.	[optional]
limit	int	Limit configured in the widget.	[optional]
sort_by	LegacyWidgetSortProperty		[optional]
sort_direction	LegacyWidgetSortDirection		[optional]
sort_group_by	LegacyWidgetSortProperty		[optional]
sort_group_direction	LegacyWidgetSortDirection		[optional]
data_source	ColorGridDatasource		[optional]

Example

from thousandeyes_sdk.dashboards.models.api_color_grid_widget import ApiColorGridWidget

# TODO update the JSON string below
json = "{}"
# create an instance of ApiColorGridWidget from a JSON string
api_color_grid_widget_instance = ApiColorGridWidget.from_json(json)
# print the JSON string representation of the object
print(ApiColorGridWidget.to_json())

# convert the object into a dict
api_color_grid_widget_dict = api_color_grid_widget_instance.to_dict()
# create an instance of ApiColorGridWidget from a dict
api_color_grid_widget_from_dict = ApiColorGridWidget.from_dict(api_color_grid_widget_dict)

[Back to Model list] [Back to API list] [Back to README]