chart

package
v1.34.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 5, 2024 License: Apache-2.0 Imports: 0 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AreaChartOptions 

type AreaChartOptions struct {
	// If the `options.type` property is `TimeSeriesChart` and the `options.defaultPlotType` property is `AreaChart`, then `showDataMarkers` determines if SignalFx shows data markers in the chart; otherwise, the property is ignored.
	ShowDataMarkers bool `json:"showDataMarkers,omitempty"`
}

type Axes 

type Axes struct {
	// A point on the Y axis at which the chart displays a horizontal line, indicating the max Y value of interest. Points with a Y value that exceeds the high water mark still appear.<br> **Notes:**   * SignalFx only uses this value for time series charts.   * Value must be less than or equal to `options.axes.max` and greater than     `options.axes.lowWaterMark` for the corresponding axis.
	HighWatermark *float64 `json:"highWatermark,omitempty"`
	// A label that's displayed beside the horizontal line indicating the high water mark.<br> **Notes:**   * SignalFx only uses this value for time series charts.   * If `options.axes.highWaterMark` isn't specified, this label is ignored.
	HighWatermarkLabel string `json:"highWatermarkLabel,omitempty"`
	// Label that's displayed for the Y axis of the chart. It appears to the left of axis values on the left axis and to the right of axis values on the right axis.<br> **Note:** SignalFx only uses this value for time series charts.
	Label string `json:"label,omitempty"`
	// A point on the Y axis at which the chart displays a horizontal line, indicating the minimum Y value of interest. Points with a Y value that is less than the low water mark still appear.<br> **Notes:**   * SignalFx only uses this value for time series charts.   * Value must be greater than or equal to `options.axes.min` and less than     `options.axes.highWaterMark` for the corresponding axis.
	LowWatermark *float64 `json:"lowWatermark,omitempty"`
	// A label that's displayed beside the horizontal line indicating the low water mark.<br> **Notes:**   * SignalFx only uses this value for time series charts.   * If `options.axes.lowWaterMark` isn't specified, this label is ignored.
	LowWatermarkLabel string `json:"lowWatermarkLabel,omitempty"`
	// Specifies the largest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values.<br> **Notes:**   * This value is only used if `options.type` is set to TimeSeriesChart.   * The value must be greater than the value of `options.axes.min` for the same `options.axes` element.
	Max *float64 `json:"max,omitempty"`
	// Specifies the smallest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values.<br> **Notes:**   * This value is only used if `options.type` is set to TimeSeriesChart.   * The value must be less than the value of `options.axes.max` for the same `options.axes` element.\"
	Min *float64 `json:"min,omitempty"`
}

type Chart 

type Chart struct {
	// The time the chart was created. The format is Unix time, UTC. This value is always set by the system.
	Created int64 `json:"created,omitempty"`
	// SignalFx user ID of the user that initially created the chart
	Creator string `json:"creator,omitempty"`
	// Description of the chart. This value appears underneath the chart name in the SignalFx web UI.
	Description string `json:"description,omitempty"`
	// System-defined identifier for the chart
	Id string `json:"id,omitempty"`
	// The last time the chart was updated, in Unix time UTC.
	LastUpdated int64 `json:"lastUpdated,omitempty"`
	// The SignalFx user ID of the last person who updated the chart. If the last update was done by the system, the value is the string literal \"AAAAAAAAAA\".
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// The displayed name of the chart in the dashboard
	Name    string   `json:"name,omitempty"`
	Options *Options `json:"options,omitempty"`
	// Specifies one or more SignalFlow packages to import for use with the SignalFlow program specified in the `programText` option. This option must be set to `signalfx`.
	PackageSpecifications string `json:"packageSpecifications,omitempty"`
	// The SignalFlow program that provides data for the chart.  If you use more than one line of SignalFlow, separate the lines with  semicolons (\";\") or newline characters (\"\\n\"). See the  [Charts Overview](https://developers.signalfx.com/v2/reference.html#charts-overview-1) for more information.\"
	ProgramText string `json:"programText,omitempty"`
	// An array that contains tag values. You can use tags to search for or filter charts. One use is to tag charts that are in production with the value `prod`.
	Tags []string `json:"tags,omitempty"`
}

type ColorScale 

type ColorScale struct {
	// Determines how to use colors specified in `options.colorRange`. If this property is set to `true` and `options.colorBy`  is set to `Range`, darker colors represent smaller data values. For chart types other than Heatmap, setting this property to `true` results in red representing lower values and green representing higher ones (if the default color scheme is in use).<br> Available when the chart type specified in `options.type` is set to Heatmap, SingleValue, or List.
	Inverted bool `json:"inverted,omitempty"`
	// Specifies data values that map to color gradient values. Specify the  values from lowest to highest. Data values that outside the specified partitions don't appear in color, so you should set the first array value to corresopnd to the lowest expected data value. Similarly, set the last array value to correspond to the highest expected data value.<br> **Note** SignalFx only uses the first six elements in the array.
	Thresholds []float64 `json:"thresholds,omitempty"`
}

An object containing properties that specify the the limits of the color ranges specified in `options.colorRange`. The properties also control how to order the colors in the color gradient. Settings you make in `options.colorScale2` override any settings you make here.

type Columns added in v1.23.0 

type Columns struct {
	Name string `json:"name,omitempty"`
}

type CreateUpdateChartRequest 

type CreateUpdateChartRequest struct {
	// User-defined JSON object containing metadata
	CustomProperties string `json:"customProperties,omitempty"`
	// Description of the chart. This value appears underneath the chart name in the SignalFx web UI.
	Description string `json:"description"`
	// The displayed name of the chart in the dashboard
	Name    string   `json:"name,omitempty"`
	Options *Options `json:"options,omitempty"`
	// Specifies one or more SignalFlow packages to import for use with the SignalFlow program specified in the `programText` option. This option must be set to `signalfx`.
	PackageSpecifications string `json:"packageSpecifications,omitempty"`
	// The SignalFlow program that provides data for the chart.  If you use more than one line of SignalFlow, separate the lines with  semicolons (\";\") or newline characters (\"\\n\"). See the  [Charts Overview](https://developers.signalfx.com/v2/reference.html#charts-overview-1) for more information.\"
	ProgramText string `json:"programText,omitempty"`
	// An array that contains tag values. You can use tags to search for or filter charts. One use is to tag charts that are in production with the value `prod`.
	Tags []string `json:"tags,omitempty"`
}

type DataTableOptions 

type DataTableOptions struct {
	// An array of data table settings for properties in the chart. Each element of the array is an object containing a  property key name and a flag. If the flag for the object is set to `true`, the property is displayed; otherwise, it's hidden.
	Fields []*DataTableOptionsFields `json:"fields,omitempty"`
}

Sets options for the data table, including which properties are omitted.

type DataTableOptionsFields 

type DataTableOptionsFields struct {
	// Determines if the property specified by `legendOptions.properties.property` for this element is displayed in the data table.<br> **Note** Only available if `options.type` is `TimeSeriesChart` or `List`.
	Enabled bool `json:"enabled,omitempty"`
	// The key name of a property to hide or show in the data table
	Property string `json:"property,omitempty"`
}

type EventPublishLabelOptions 

type EventPublishLabelOptions struct {
	DisplayName  string `json:"displayName,omitempty"`
	Label        string `json:"label,omitempty"`
	PaletteIndex *int32 `json:"paletteIndex,omitempty"`
}

type GeneralOptions 

type GeneralOptions struct {
	// Determines if the chart displays samples from the data or plots every datapoint. By default, SignalFx uses sampling to provide better performance for charts.<br> **Note** Available for *all* values of `options.type` except for `Text`.
	DisableSampling bool `json:"disableSampling,omitempty"`
	// Time in milliseconds to wait before charting the available data and ignoring points that arrive afterwards. By default, SignalFx automatically detects and applies a sensible value. You can also choose the automatic option by explicitly setting `maxDelay` to 0. The maximum value is 900,000 ms (15 minutes).<br> **Note** Available for *all* values of `options.type` except for `Text`.
	MaxDelay *int32 `json:"maxDelay,omitempty"`
	// The minimum resolution to use when computing the SignalFlow program, specified in milliseconds. By default, SignalFx computes and applies a sensible value. You can also choose the automatic option by explicitly setting `minimumResolution` to 0. The maximum value is 900,000 ms (15 minutes).<br> **Note** Available for *all* values of `options.type` except for `Text`.
	MinimumResolution *int32 `json:"minimumResolution,omitempty"`
	// Time zone that SignalFlow uses as the basis of calendar window transformation methods. For example, if you set "timezone": "Europe/Paris" and then use the transformation sum(cycle="week", cycle_start="Monday") in your chart's SignalFlow program, the calendar window starts on Monday, Paris time.
	Timezone string `json:"timezone,omitempty"`
}

A set of options that control the general appearance and operation of the chart.<br> **Note** Available for *all* values of `options.type` except for `Text`.

type HeatmapColorRangeOptions 

type HeatmapColorRangeOptions struct {
	// The starting hex color value for data values in a heatmap chart. The `options.colorScale` property controls how SignalFx creates a range of colors to represent different data values; `options.colorRange.color` is the starting point of the range, and `options.colorScale` controls the number of different colors.<br> For best results, set `options.colorRange.color` to one of the 21 colors in the official SignalFx color palette.<br> Specify the value as a 6-character hexadecimal value preceded by the '#' character, for example \"#00b9ff\" (light blue)
	Color string  `json:"color,omitempty"`
	Max   float64 `json:"max,omitempty"`
	Min   float64 `json:"min,omitempty"`
}

An object containing properties that specify the range of color values to use in a Heatmap chart, including the lowest and highest color to use. The `options.colorScale` property controls how SignalFx sets each intermediate chart color within the range.

type HistogramChartOptions 

type HistogramChartOptions struct {
	// Color value to use as the theme of a histogram chart. The value is the index of the color in the standard SignalFx color palette, as shown in the following table. SignalFx displays all the datapoints using this color, but the chart shows smaller values with less color opacity and larger values with more opacity.<br> <table> <thead> <th style=\"text-align:center;\">Index</th><th>RGB hex value</th> </thead> <tbody> <tr><td>0</td><td>#999999</td></tr> <tr><td>1</td><td>#0077c2</td></tr> <tr><td>2</td><td>#00b9ff</td></tr> <tr><td>3</td><td>#6ca2b7</td></tr> <tr><td>4</td><td>#b04600</td></tr> <tr><td>5</td><td>#f47e00</td></tr> <tr><td>6</td><td>#e5b312</td></tr> <tr><td>7</td><td>#bd468d</td></tr> <tr><td>8</td><td>#e9008a</td></tr> <tr><td>9</td><td>#ff8dd1</td></tr> <tr><td>10</td><td>#876ff3</td></tr> <tr><td>11</td><td>#a747ff</td></tr> <tr><td>12</td><td>#ab99bc</td></tr> <tr><td>13</td><td>#007c1d</td></tr> <tr><td>14</td><td>#05ce00</td></tr> <tr><td>15</td><td>#0dba8f</td></tr> <tr><td>16</td><td>#ea1849</td></tr> <tr><td>17</td><td>#eac24b</td></tr> <tr><td>18</td><td>#e5e517</td></tr> <tr><td>19</td><td>#acef7f</td></tr> <tr><td>20</td><td>#6bd37e</td></tr> </tbody> </table> **Notes**   * Available if `options.type property` is `TimeSeriesChart`   * Available if `options.defaultPlotType` is `Histogram`   * Users may see colors other than those shown in the table, depending on the settings they select for color     blindness. To see sample swatches of the alternate colors and the mappings used for     color-blind users, see the color palette documentation at the end of the     [Charts Overview](https://developers.signalfx.com/reference#charts-overview-1).
	ColorThemeIndex *int32 `json:"colorThemeIndex,omitempty"`
}

type LegendOptions 

type LegendOptions struct {
	// Specifies the dimension to show in the legend. You should ensure the dimension exists and has different values for each set of datapoints in the chart.<br> **Note** Only available if `options.type` is `TimeSeriesChart`.
	DimensionInLegend string `json:"dimensionInLegend,omitempty"`
	// Determines if SignalFx should display a legend with the chart. If `true`, a legend is displayed below the chart.  This legend lists the each value of the dimension specified in the `options.onChartLegendsOptions.dimensionInLegend` property. Next to each value is the color of the data point that has that dimension value in the chart.<br> **Note** Only available if `options.type` is `TimeSeriesChart'.
	ShowLegend bool `json:"showLegend,omitempty"`
}

Determines if a legend should be displayed, and if so which dimension to show in the legend.<br> **Note** Only available if the options.type property is set to TimeSeriesChart.

type LineChartOptions 

type LineChartOptions struct {
	// Determines how to represent individual data points in the chart. If `true`, the chart is displayed with filled circles for each datapoint; otherwise, the chart is displayed as a smooth line.
	ShowDataMarkers bool `json:"showDataMarkers,omitempty"`
}

Specifies line chart options for a chart.<br> **Notes** * Only available if `options.type` is `TimeSeriesChart`. * Only available if `options.defaultPlotType` is `LineChart`.

type Options 

type Options struct {
	AreaChartOptions *AreaChartOptions `json:"areaChartOptions,omitempty"`
	// *These options are only used for time series charts.*<br> Axis options for the left and right side of a time series chart. The object in the first element specifies options for the left side of the chart, and the object in the second element corresponds to the right side of the chart. Other elements are ignored.
	Axes []*Axes `json:"axes,omitempty"`
	// Specifies the digits SignalFx displays for values plotted on the chart. Choose a value that is sensible for the data; that is, ensure that the variations in the data are discernible using the specified precision. For example, if the data values usually fluctuate between 100000 and 100010, using a precision of 3 would result in a value of 100000 for every data point. Setting the precision to 6 would distinguish between 100001 and 100002.<br>**Note:** SignalFx only uses this value for time series charts.
	AxisPrecision *int32 `json:"axisPrecision,omitempty"`
	// Specifies how to apply a color scheme to the values in the chart. If you want to apply color in a text chart, use HTML within the `markdown` property. The values you can use depend on the type of chart you specify in `options.type` -- <br>   * \"Text\" -- The property is ignored.   * \"Heatmap\" -- The `Range` and `Scale` enumerated types are allowed; the default is `Range`.   * \"List\" -- The `Dimension`, `Metric`, and `Scale` enumerated types are allowed; the default is `Metric`.   * \"SingleValue\" -- The `Dimension`, `Metric`, and `Scale` enumerated types are allowed; the default is `Metric`.   * \"TimeSeriesChart\" -- The `Dimension` and `Metric` enumerated types are allowed; the default is `Dimension`.
	ColorBy    string                    `json:"colorBy,omitempty"`
	ColorRange *HeatmapColorRangeOptions `json:"colorRange,omitempty"`
	ColorScale *ColorScale               `json:"colorScale,omitempty"`
	// An array that contains the information about a single color range, including both the color to display for that range and the borders of the range. The array specifies the entire range displayed in the secondary visualization or heatmap chart. You don't need to insert the elements in a specific order; they're automatically ordered by value in the display. The lowest value becomes the left border of the secondary visualization, and the highest value becomes the right border of the secondary visualization.
	ColorScale2 []*SecondaryVisualization `json:"colorScale2,omitempty"`
	// Specifies the plot type to use for this chart --   * **LineChart** -- A plot with datapoints connected by a series of straight lines.   * **AreaChart** -- Similar to a LineChart, with the area between the plot line and the x-axis filled with the line color.   * **Column** -- Shaded vertical bars with their bottom on the x-axis and their top at the datapoint value. The bars aren't     connected.   * **Histogram** -- Colored rectangular bins, with the color representing the number of datapoints for a value. Depending on how you set up your histogram, a green bar can indicate a higher number of datapoints for a particular value than a red     bar.
	DefaultPlotType          string                      `json:"defaultPlotType,omitempty"`
	EventPublishLabelOptions []*EventPublishLabelOptions `json:"eventPublishLabelOptions,omitempty"`
	// Specifies an array of properties that should be grouped together in a histogram chart. Each array element must contain a key specified in `customProperties` or a valid default custom property. The first array element is a property that determines the top-level grouping; the property in the second element determines the grouping within each first-level grouping. All other elements in the array are ignored. The [Charts Overview](https://developers.signalfx.com/v2/reference.html#charts-overview-1) section shows  a heatmap that groups CPU utilization by AWS availability zone as the primary grouping and number of host CPU cores as the secondary grouping.<br> **Note** This options is only available if `options.type` is `HeatMap`.
	GroupBy               []string               `json:"groupBy,omitempty"`
	HistogramChartOptions *HistogramChartOptions `json:"histogramChartOptions,omitempty"`
	// Determines how 0 is treated when dynamically calculating Y-axis values. If `true` 0 is included in the calculation; otherwise, SignalFx ignores datapoints containinig 0. This is a chart-wide setting applied to all the axes. However, if `options.axes.min` or `options.axes.max` exclude 0 from the displayed range for an axis, 0 isn't displayed on that axis even if `includeZero` is `true`.<br> **Note** Only available if the `options.type` is `TimeSeriesChart`
	IncludeZero      bool              `json:"includeZero,omitempty"`
	LegendOptions    *DataTableOptions `json:"legendOptions,omitempty"`
	LineChartOptions *LineChartOptions `json:"lineChartOptions,omitempty"`
	// Determines whether to hide missing data points in the chart. If `true`, missing data points in the chart would be hidden.
	HideMissingValues bool `json:"hideMissingValues,omitempty"`
	// The contents of a text chart, using GitHub-Flavored Markdown (**GFM**) or HTML.<br> **Note** Only available if `options.type` is set to `Text`.
	Markdown string `json:"markdown,omitempty"`
	// Indicates the number of significant digits to the right of the decimal point to use for plotted datapoints. The integer part of the datapoint is used, regardless of the specified precision. Choose a value so that variations in the data are visible for the specified precision. For example, if data values are in the range 0.001 to 0.01, set `maximumPrecision` to 4. If you don't specify a value, SignalFx adjusts the precision to fit the available display area.<br> **Note** Only available if `options.type` is `List` or `SingleValue`.
	MaximumPrecision     *int32          `json:"maximumPrecision,omitempty"`
	OnChartLegendOptions *LegendOptions  `json:"onChartLegendOptions,omitempty"`
	ProgramOptions       *GeneralOptions `json:"programOptions,omitempty"`
	// An array of objects that contain general options for a specific SignalFlow statement applied to the chart. The order of elements in the list is retained, but has no effect. SignalFx uses label values to  map options to specific `publish() statements` in the SignalFlow statement. Heatmaps do not support full `publishLabelOptions` elements; the description of each property shows its supported chart types.<br> **Note** Available if `options.type` is one of `TimeSeriesChart`, `List`, `SingleValue`, or `Heatmap`.
	PublishLabelOptions []*PublishLabelOptions `json:"publishLabelOptions,omitempty"`
	// Specifies how often, in milliseconds, SignalFx should refresh the chart with data. If SignalFx can detect the resolution of the data, the default is 10,000 (10 seconds); otherwise, the default is 3,600,000 (1 hour).<br> **Note** This option is only available if `options.type` is `List` or `SingleValue`.
	RefreshInterval *int32 `json:"refreshInterval,omitempty"`
	// Specifies the secondary visualization to use with `List` or `SingleValue` charts. See the [Charts Overview](https://developers.signalfx.com/reference#charts-overview-1) section for examples of the available visualizations.<br> **Note** This option is only available if `option.type` is `List` or `SingleValue`.
	SecondaryVisualization string `json:"secondaryVisualization,omitempty"`
	// If `true`, SignalFx displays a vertical line on the chart at the point that an event occurs.<br> **Note** This option is only available if `options.type` is `TimeSeriesChart`.
	ShowEventLines bool `json:"showEventLines,omitempty"`
	// If `true`, SignalFx displays a sparkline for the value shown in a SingleValue chart. For example, the following chart contains a sparkline<br> ![SingleValue chart with sparkline]()<br> **Notes**   * This option is only available if `options.type` is `SingleValue`.   * The value specified for `options.secondaryVisualization` overrides `options.showSparkLine`.
	ShowSparkLine bool `json:"showSparkLine,omitempty"`
	// Specifies how to sort the entries in a list chart. The first character of the value must be either   * A minus sign (`-`) sets descending order for the data.   * A plus sign (`+`) sets ascending order for the data. The rest of the value specifies the sort criteria --   * A keyword that represents a datapoint value, a metric, or the `publish()` label of the SignalFlow statement that     generates the data   * A dimension that's available to the cart. <br> The default is to sort on the `publish()` label in ascending order; this corresponds to the **Auto** option in the SignalFx web UI. <br> Values that don't map to a keyword or valid dimension are sorted with the default specification. <br> Data that contains `null` sorts to the start of the list for ascending order and to the end of the list for descending order.<br> **Note** This option is only available if `option.type` is `List`.
	SortBy string `json:"sortBy,omitempty"`
	// If set to `Ascending`, the chart displays values from low to high; otherwise, the chart displays values from high to low.<br> **Note** This option is only available if `options.type` is `HeatMap`.
	SortDirection string `json:"sortDirection,omitempty"`
	// The custom property to use as the sorting criteria for the heatmap chart. The value should map to a valid key name specified in the customProperties property or to a valid custom property available by default. If no value is specified, the values are displayed without an obvious order. The name of a custom property to use as the sort criteria for a heatmap chart. The value  must be a valid key specified by the `customProperty` property or a valid default custom property. If you don't specify a value, the chart displays the values without any obvious order.<br> **Note** This option is only available if `options.type` is `HeatMap`.
	SortProperty string `json:"sortProperty,omitempty"`
	// Controls the display of stacked plots in a TimeSeriesChart. If `true`, SignalFx stacks charts and adds datapoints together to create the values indicated by the axis labels. You can still see individual values when you highlight them within the colored area representing a single plot. You can also view individual values in the data table.<br> **Note** This option is only available if `options.type` is `TimeSeriesChart` **and** `options.defaultPlotType` is `AreaChart` or `ColumnChart`.
	Stacked bool                `json:"stacked,omitempty"`
	Time    *TimeDisplayOptions `json:"time,omitempty"`
	// Determines if the timestamp displays below displayed values. If `true`, the timestamp for a value appears below the value in the chart.<br> **Note** This option is only available if `options.type` is `Heatmap` or `SingleValue`.
	TimestampHidden bool `json:"timestampHidden,omitempty"`
	// The type of chart or visualization to use for the data\\:<br>   * **Heatmap** -- Displays values in an ordered set of colored boxes. The color indicates the \"health\" of the       value.   * **List** -- Display each value in its own row within a plot that shows recent changes   * **SingleValue** -- Displays a single value with a color that indicates the health of the value.   * **Text** -- Displays pre-defined text, optionally formatted with Markdown markup   * **TimeSeriesChart** -- Displays multiple data points, retaining historical data, in one of four modes\\:       * **Line** -- Displays datapoints as chart points connected by straight lines. Each set of chart points and           lines has a color specific to that set.       * **Area** -- Similar to a Line chart, but the area between a line and the           X-axis is filled with the line color.       * **Bar Chart** -- Displays each datapoint as a colored vertical bar. Each datapoint has its own bar. The base of the bar is the X-axis, and its top is the datapoint value. Datapoints are closely packed around the X-axis time         value associated with the datapoint. This is also known as a **Column** chart.         <br>         You can optionally display datapoints in a **stacked** bar chart. In this type of chart, different datapoint         values are vertical bars stacked above their associated time. Colors differentiat different datapoints.
	Type string `json:"type"`
	// Specifies the type of unit to use when displaying or labeling values     - Metric\\: Values represent decimal multiples. For example, if `unitPrefix` is Metric, 1K represents 1 kilobyte or 1000       bytes.     - Binary\\: Values represent binary multiples. For example, if `unitPrefix` is Binary, 1K represents 1 kibibyte or 1024       bytes.<br> **Note** This option is available for all values of `option.type` except `Text`
	UnitPrefix string `json:"unitPrefix,omitempty"`
	// The column configuration on logs chart
	Columns []*Columns `json:"columns,omitempty"`
	// The sort option configuration for a logs chart
	SortOptions []*SortOptions `json:"sortOptions,omitempty"`
	// The default connection configuration for a logs chart
	DefaultConnection string `json:"defaultConnection,omitempty"`
}

type PublishLabelOptions 

type PublishLabelOptions struct {
	// Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.<br> **Note:** Only available if `options.type` is `TimeSeriesChart`, `List`, or `SingleValue`.
	DisplayName string `json:"displayName,omitempty"`
	// A label in a SignalFlow `publish()` function that gets associated with the other properties of this SignalFlow options object.<br> **Note:** Only available if `options.type` is `TimeSeriesChart`, `List`, `SingleValue`, or `Heatmap`.
	Label string `json:"label"`
	// Color value to use for plots associated with this SignalFlow statement. The value is the index of the color in the standard SignalFx color palette, as shown in the following table.<br> **Notes:**   * Only available if `options.type` is `TimeSeriesChart`, `List`, or `SingleValue`.   * Users may see colors other than those shown in the table, depending on the settings they select for color     blindness. To see sample swatches of the alternate colors and the mappings used for     color-blind users, see the first 16 colors in the color palette documentation at the end of the     [Charts Overview](https://developers.signalfx.com/reference#charts-overview-1). <table> <thead> <th style=\"text-align:center;\">Index</th><th>RGB value (in hex)</th> </thead> <tbody> <tr><td>0:</td><td>#999999</td></tr> <tr><td>1:</td><td>#0077c2</td></tr> <tr><td>2:</td><td>#00b9ff</td></tr> <tr><td>3:</td><td>#6ca2b7</td></tr> <tr><td>4:</td><td>#b04600</td></tr> <tr><td>5:</td><td>#f47e00</td></tr> <tr><td>6:</td><td>#e5b312</td></tr> <tr><td>7:</td><td>#bd468d</td></tr> <tr><td>8:</td><td>#e9008a</td></tr> <tr><td>9:</td><td>#ff8dd1</td></tr> <tr><td>10:</td><td>#876ff3</td></tr> <tr><td>11:</td><td>#a747ff</td></tr> <tr><td>12:</td><td>#ab99bc</td></tr> <tr><td>13:</td><td>#007c1d</td></tr> <tr><td>14:</td><td>#05ce00</td></tr> <tr><td>15:</td><td>#0dba8f</td></tr> </tbody> </table>
	PaletteIndex *int32 `json:"paletteIndex,omitempty"`
	// Enumerated types that you can use to override the value of `options.defaultPlotType` for the output of the SignalFlow statement referred to by `options.publishLabelOptions.label`.<br> **Notes:** Only available if `options.type` is `TimeSeriesChart`, `List`, or `SingleValue`.
	PlotType string `json:"plotType,omitempty"`
	// Specifies a string to prepend to values displayed in a single value or list chart, the data table for a chart, and the tooltip shown when you hover over a point on a chart. To learn more, see  the visualization examples in the  [Charts Overview](https://developers.signalfx.com/reference#charts-overview-1) section.  SignalFx overrides `valuePrefix` if `options.publishLabelOptions.valueUnit` is set for the same plot.<br> **Note:** Only available if `options.type` is `TimeSeriesChart`, `List`, `SingleValue`, or `Heatmap`.
	ValuePrefix string `json:"valuePrefix,omitempty"`
	// Specifies a string to append to values displayed in a single value or list chart, the data table for a chart, and the tooltip shown when you hover over a point on a chart. To learn more, see  the visualization examples in the [Charts Overview](https://developers.signalfx.com/reference#charts-overview-1) section. SignalFx overrides `valueSuffix` if `options.publishLabelOptions.valueUnit` is set for the same plot.<br> **Note:** Only available if `options.type` is `TimeSeriesChart`, `List`, `SingleValue`, or `Heatmap`.
	ValueSuffix string `json:"valueSuffix,omitempty"`
	// Specifies the units of measure for values displayed in the chart. SignalFx displays chart values based on the assumption that the raw data is unit of measure you select. For example, the value 1000 in a plot where `options.publishLabelOption .valueUnit` is set to `bits` is displayed as 1 Kilobit, and the value 1024 in a plot set to `Bytes` is presented as 1 Kebibyte. Units are scaled or and within there own unit type. See the  [Charts Overview](https://developers.signalfx.com/reference#charts-overview-1) section for a full specification. The `options.publishLabelOptions.valueUnit` option applies to scaling and labeling in chart tooltips, axes, and data tables. If `options.publishLabelOptions.valueUnit` affects the  chart presentation, it overrides `options.publishLabelOptions.valuePrefix`, `options.publishLabelOptions.valueSuffix`, and `options.unitPrefix`.<br> **Note:** Available for *all* values of `options.type` except for `Text`.
	ValueUnit string `json:"valueUnit,omitempty"`
	// Specifies the position of the Y-axis for the plot associated with the SignalFlow statement. If `yAxis` is set to 0, the axis is on the left side; otherwise it's on the right. The default is 0 (left side).<br> **Note** -- This option is only available if 'options.type` is `TimeSeriesChart`, `List`, or `SingleValue`.
	YAxis int32 `json:"yAxis,omitempty"`
}

type SearchResult 

type SearchResult struct {
	// The number of charts that match the specified query. This value may be different from the number of  objects in the `results` array property. The `limit` query parameter controls  the number of objects that the request actually returns, and the `offset` query parameter determines the position at which the request starts returning parameters.  These two factors can affect the actual number of returned objects.
	Count int32 `json:"count,omitempty"`
	// An array of chart objects returned by the request. The objects match the search criteria specified in the query parameters of the request.
	Results []*Chart `json:"results,omitempty"`
}

type SecondaryVisualization 

type SecondaryVisualization struct {
	// The lower threshold of a color range, not including the specified value itself.<br> **Notes:**   * Available if the options.type property is set to List, SingleValue, or Heatmap   * The value must be less than the value of `options.colorScale2.lt` or `options.colorScale2.lte` of the same element.   * `options.colorScale2.gt` and `options.colorScale2.gte` are mutually exclusive
	Gt *float64 `json:"gt,omitempty"`
	// The lower threshold of a color range, including the specified value itself.<br> **Notes:**   * Available if the options.type property is set to List, SingleValue, or Heatmap   * The value must be less than the value of `options.colorScale2.lt` or `options.colorScale2.lte` of the same element.   * `options.colorScale2.gt` and `options.colorScale2.gte` are mutually exclusive
	Gte *float64 `json:"gte,omitempty"`
	// The upper threshold of a color range, not including the specified value itself.<br> **Notes:**   * Available if the options.type property is set to List, SingleValue, or Heatmap   * The value must be less than the value of `options.colorScale2.gt` or `options.colorScale2.gte` of the same element.   * `options.colorScale2.lt` and `options.colorScale2.lte` are mutually exclusive
	Lt *float64 `json:"lt,omitempty"`
	// The upper threshold of a color range, including the specified value itself.<br> **Notes:**   * Available if `options.type` property is `List`, `SingleValue`, or `Heatmap`   * The value must be less than the value of `options.colorScale2.gt` or `options.colorScale2.gte` of the same     element.   * `options.colorScale2.lt` and `options.colorScale2.lte` are mutually exclusive
	Lte *float64 `json:"lte,omitempty"`
	// Color value to use for points in the specified range. The value is the index of the color in the standard SignalFx color palette, as shown in the following table: <table> <thead> <th >Index</th><th>RGB hex value</th> </thead> <tbody> <tr><td>0</td><td>#999999</td></tr> <tr><td>1</td><td>#0077c2</td></tr> <tr><td>2</td><td>#00b9ff</td></tr> <tr><td>3</td><td>#6ca2b7</td></tr> <tr><td>4</td><td>#b04600</td></tr> <tr><td>5</td><td>#f47e00</td></tr> <tr><td>6</td><td>#e5b312</td></tr> <tr><td>7</td><td>#bd468d</td></tr> <tr><td>8</td><td>#e9008a</td></tr> <tr><td>9</td><td>#ff8dd1</td></tr> <tr><td>10</td><td>#876ff3</td></tr> <tr><td>11</td><td>#a747ff</td></tr> <tr><td>12</td><td>#ab99bc</td></tr> <tr><td>13</td><td>#007c1d</td></tr> <tr><td>14</td><td>#05ce00</td></tr> <tr><td>15</td><td>#0dba8f</td></tr> <tr><td>16</td><td>#ea1849</td></tr> <tr><td>17</td><td>#eac24b</td></tr> <tr><td>18</td><td>#e5e517</td></tr> <tr><td>19</td><td>#acef7f</td></tr> <tr><td>20</td><td>#6bd37e</td></tr> </tbody> </table> **Notes:**  * Available if the options.type property is set to List, SingleValue, or Heatmap. * Users may see colors other than those shown in the table, depending on the settings they select for color   blindness. To see sample swatches of the alternate colors and the mappings used for   color-blind users, see the color palette documentation at the end of the   [Charts Overview](https://developers.signalfx.com/reference#charts-overview-1).
	PaletteIndex *int32 `json:"paletteIndex"`
}

type SortOptions added in v1.23.0 

type SortOptions struct {
	Field      string `json:"field,omitempty"`
	Descending bool   `json:"descending,omitempty"`
}

type TimeDisplayOptions 

type TimeDisplayOptions struct {
	// The timestamp of the last time to display in the chart, in Unix time UTC<br> **Note** This option is only available if `options.type` is `TimeSeriesChart` and `options.time.type` is `absolute`.
	End *int64 `json:"end,omitempty"`
	// The number of milliseconds to display in the chart. From this value, SignalFx calculates a rolling range with the current time at the right edge of the chart. Use 0 to use the default behavior, which is -15m except for the following metrics --   * **AWS** -- See the metrics listed in the help topic     [Monitor Amazon Web Services](https://docs.signalfx.com/en/latest/integrations/aws-info.htm)   * **GCP** --  See the metrics listed in the help topic     [Monitor Google Cloud Platform (GCP)](https://docs.signalfx.com/en/latest/integrations/google-cloud-platform.html)   * **Microsoft Azure** -- See the metrics listed in the help topic     [Monitor Microsoft Azure](https://docs.signalfx.com/en/latest/integrations/azure-info.html) <br> **Note** This option is only available if `options.type` is `TimeSeriesChart` and `options.time.type` is `relative`.
	Range *int64 `json:"range,omitempty"`
	// The timestamp of the first time to display in the chart, in Unix time UTC<br> **Note** This option is only available if `options.type` is `TimeSeriesChart` and `options.time.type` is `absolute`.
	Start *int64 `json:"start,omitempty"`
	// Determines whether to use an explicit time range or to show a range of the last *n* milliseconds.<br> **Note** This option is only available if `options.type` is `TimeSeriesChart`.
	Type string `json:"type,omitempty"`
}

Object that contains time-related properties for a chart.<br> **Note** These properties are only available if `options.type` is `TimeSeriesChart`.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.