Skip to content

Latest commit

 

History

History
72 lines (68 loc) · 9.51 KB

ChartSettings.md

File metadata and controls

72 lines (68 loc) · 9.51 KB

ChartSettings

Properties

Name Type Description Notes
auto_column_tags bool deprecated [optional]
chart_default_color str Default color that will be used in any chart rendering. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format [optional]
column_tags str deprecated [optional]
custom_tags list[str] For the tabular view, a list of point tags to display when using the "custom" tag display mode [optional]
default_sort_column str For the tabular view, to select column for default sort [optional]
expected_data_spacing int Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid line in line plots. Default: 60s [optional]
fixed_legend_display_stats list[str] For a chart with a fixed legend, a list of statistics to display in the legend [optional]
fixed_legend_enabled bool Whether to enable a fixed tabular legend adjacent to the chart [optional]
fixed_legend_filter_field str Statistic to use for determining whether a series is displayed on the fixed legend [optional]
fixed_legend_filter_limit int Number of series to include in the fixed legend [optional]
fixed_legend_filter_sort str Whether to display "Top"- or "Bottom"-ranked series in the fixed legend [optional]
fixed_legend_hide_label bool deprecated [optional]
fixed_legend_position str Where the fixed legend should be displayed with respect to the chart [optional]
fixed_legend_show_metric_name bool Whether to display Metric Name fixed legend [optional]
fixed_legend_show_source_name bool Whether to display Source Name fixed legend [optional]
fixed_legend_use_raw_stats bool If true, the legend uses non-summarized stats instead of summarized [optional]
group_by_source bool For the tabular view, whether to group multi metrics into a single row by a common source. If false, each metric for each source is displayed in its own row. If true, multiple metrics for the same host will be displayed as different columns in the same row [optional]
invert_dynamic_legend_hover_control bool Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed) [optional]
line_type str Plot interpolation type. linear is default [optional]
logs_table LogsTable [optional]
max float Max value of Y-axis. Set to null or leave blank for auto [optional]
min float Min value of Y-axis. Set to null or leave blank for auto [optional]
num_tags int For the tabular view, how many point tags to display [optional]
plain_markdown_content str The Markdown content for a Markdown display, in plain text. Use this field instead of `markdownContent`. [optional]
show_hosts bool For the tabular view, whether to display sources. Default: true [optional]
show_labels bool For the tabular view, whether to display labels. Default: true [optional]
show_raw_values bool For the tabular view, whether to display raw values. Default: false [optional]
show_value_column bool For the tabular view, whether to display value column. Default: true [optional]
sort_values_descending bool For the tabular view, whether to display display values in descending order. Default: false [optional]
sparkline_decimal_precision int For the single stat view, the decimal precision of the displayed number [optional]
sparkline_display_color str For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format [optional]
sparkline_display_font_size str For the single stat view, the font size of the displayed text, in percent [optional]
sparkline_display_horizontal_position str For the single stat view, the horizontal position of the displayed text [optional]
sparkline_display_postfix str For the single stat view, a string to append to the displayed text [optional]
sparkline_display_prefix str For the single stat view, a string to add before the displayed text [optional]
sparkline_display_value_type str For the single stat view, whether to display the name of the query or the value of query [optional]
sparkline_display_vertical_position str deprecated [optional]
sparkline_fill_color str For the single stat view, the color of the background fill. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format [optional]
sparkline_line_color str For the single stat view, the color of the line. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format [optional]
sparkline_size str For the single stat view, a misleadingly named property. This determines whether the sparkline of the statistic is displayed in the chart BACKGROUND, BOTTOM, or NONE [optional]
sparkline_value_color_map_apply_to str For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND [optional]
sparkline_value_color_map_colors list[str] For the single stat view, a list of colors that differing query values map to. Must contain one more element than sparklineValueColorMapValuesV2. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format [optional]
sparkline_value_color_map_values list[int] deprecated [optional]
sparkline_value_color_map_values_v2 list[float] For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one less element than sparklineValueColorMapColors [optional]
sparkline_value_text_map_text list[str] For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparklineValueTextMapThresholds [optional]
sparkline_value_text_map_thresholds list[float] For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one less element than sparklineValueTextMapText [optional]
stack_type str Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means Normalized from 0 to 1. wiggle means Minimize weighted changes. silhouette means to Center the Stream [optional]
tag_mode str For the tabular view, which mode to use to determine which point tags to display [optional]
time_based_coloring bool For x-y scatterplots, whether to color more recent points as darker than older points. Default: false [optional]
type str Chart Type. 'line' refers to the Line Plot, 'scatter' to the Point Plot, 'stacked-area' to the Stacked Area plot, 'table' to the Tabular View, 'scatterploy-xy' to Scatter Plot, 'markdown-widget' to the Markdown display, and 'sparkline' to the Single Stat view
window_size int Width, in minutes, of the time window to use for "last" windowing [optional]
windowing str For the tabular view, whether to use the full time window for the query or the last X minutes [optional]
xmax float For x-y scatterplots, max value for X-axis. Set null for auto [optional]
xmin float For x-y scatterplots, min value for X-axis. Set null for auto [optional]
y0_scale_siby1024 bool Default: false. Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI) [optional]
y0_unit_autoscaling bool Default: false. Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units [optional]
y1_max float For plots with multiple Y-axes, max value for right-side Y-axis. Set null for auto [optional]
y1_min float For plots with multiple Y-axes, min value for right-side Y-axis. Set null for auto [optional]
y1_scale_siby1024 bool Default: false. Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI) [optional]
y1_unit_autoscaling bool Default: false. Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units [optional]
y1_units str For plots with multiple Y-axes, units for right-side Y-axis [optional]
ymax float For x-y scatterplots, max value for Y-axis. Set null for auto [optional]
ymin float For x-y scatterplots, min value for Y-axis. Set null for auto [optional]

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