-
Notifications
You must be signed in to change notification settings - Fork 47
/
model_charts_web_ui_filter.go
31 lines (28 loc) · 4.13 KB
/
model_charts_web_ui_filter.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/*
* Dashboards API
*
* API for creating, retrieving, updating, and deleting dashboards and dashboard groups. <br> Dashboards are groups of charts. In a dashboard, all the charts that belong to the dashboard appear at the same time and follow the same filtering options. ## Dashboard layout The system lays out dashboards and the charts they contain with these dimensions: <br> * The web UI reserves a 12x100 grid for each dashboard and assigns one or more charts to specific locations within the grid. * A chart associated with the dashboard can be any size from 1x1 to 12x3. * If you assign overlapping dashboard locations for charts, the system attempts to resize or reorganize the layout. This ensures that all of the charts fit within the space alloted to the dashboard. ## Dashboard access By default, all users in an organization can edit and delete dashboards and dashboard groups. If SignalFx has enabled the \"write permissions\" feature for your organization, you can limit editing or deleting of specific dashboards to specific individuals or teams, or both. Use this feature to prevent unauthorized or accidental modifications to dashboards and the charts they contain. ## Cloning dashboards Users who don't have permission to edit a dashboard can still clone it and modify the clone. ## View dashboards You can view dashboards you create using the API in the web UI by specifying their \"id\" property in a web UI URL, by following this syntax: <br> <code>https://app.signalfx.com/#/dashboard/<DASHBOARD_ID></code> <br> Dashboards you create using the API also appear by name in the web UI catalog and in their dashboard group.
*
* API version: 3.0.0
* Generated by: OpenAPI Generator (https://openapi-generator.tech)
*/
package dashboard
import "github.com/signalfx/signalfx-go/util"
// The specification for a filter that appears in the web UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter:<br> * A default value * A list of suggested values to display in the web UI * A flag that controls user input; if set to `true`, users are limited to the default and suggested values. <br> You can also force users to choose this filter in order to see data in the dashboard's charts.
type ChartsWebUiFilter struct {
// A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the web UI. <br> **Note:** A good way to indicate that the string is a label is to append a space and a colon (\":\") to it.
Alias string `json:"alias,omitempty"`
ApplyIfExists bool `json:"applyIfExists,omitempty"`
Description string `json:"description,omitempty"`
// Array of strings containing values to place at the top of the **Suggested Values** dropdown in web UI for the dashboard. If `ChartsWebUIFilter.restricted` is `true`, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.
PreferredSuggestions []string `json:"preferredSuggestions,omitempty"`
// Name of a custom property or dimension to filter against.<br> **Note:** If the dimension or custom property doesn't exist in any of the charts for the dashboard, the system doesn't display any data in the charts.
Property string `json:"property"`
// Flag that controls the display of chart data. If `true`, users must use this filter in order to see data; otherwise, users can delete the filter.
Required bool `json:"required,omitempty"`
ReplaceOnly bool `json:"replaceOnly,omitempty"`
// Flag that controls the values allowed in the filter. If `true`, the only allowable values are those specified in the `ChartsWebUIFilter.preferredSuggestsions` array; otherwise, any value is allowed.
Restricted bool `json:"restricted,omitempty"`
// A list of values to compare to the value of the dimension or custom property specified in `ChartsWebUIFilter.property`. If the list contains more than one value, the filter becomes a set of queries between the value of `property` and each element of `value`. The system joins these queries with an implicit OR.
Value util.StringOrSlice `json:"value"`
}