model_publish_label_options.go

package detector

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"`
	// 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"`
}