mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 07:55:31 +00:00
3.4 KiB
3.4 KiB
ApiStackedAreaChartWidget
Displays line plots over time, stacking quantities vertically to showcase cumulative data trends, similar to stacked bar charts. Ideal for visualizing changes in response times, error counts, and other metrics, revealing the progression of values across a timeline. Use this chart to replace stacked bar charts for temporal data analysis.
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 | SelfLinksLinks | [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 | Time Series: Stacked Area widget type | |
| group_by | ApiAggregateProperty | [optional] | |
| data_source | StackedAreaChartDatasource | [optional] |
Example
from dashboards.models.api_stacked_area_chart_widget import ApiStackedAreaChartWidget
# TODO update the JSON string below
json = "{}"
# create an instance of ApiStackedAreaChartWidget from a JSON string
api_stacked_area_chart_widget_instance = ApiStackedAreaChartWidget.from_json(json)
# print the JSON string representation of the object
print(ApiStackedAreaChartWidget.to_json())
# convert the object into a dict
api_stacked_area_chart_widget_dict = api_stacked_area_chart_widget_instance.to_dict()
# create an instance of ApiStackedAreaChartWidget from a dict
api_stacked_area_chart_widget_from_dict = ApiStackedAreaChartWidget.from_dict(api_stacked_area_chart_widget_dict)