-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: add alertList panel * chore: generate code/docs for latest * chore: generate code/docs for all versions
- Loading branch information
Showing
52 changed files
with
12,031 additions
and
12 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
# link | ||
|
||
|
||
|
||
## Index | ||
|
||
* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) | ||
* [`fn withIcon(value)`](#fn-withicon) | ||
* [`fn withIncludeVars(value=true)`](#fn-withincludevars) | ||
* [`fn withKeepTime(value=true)`](#fn-withkeeptime) | ||
* [`fn withTags(value)`](#fn-withtags) | ||
* [`fn withTagsMixin(value)`](#fn-withtagsmixin) | ||
* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) | ||
* [`fn withTitle(value)`](#fn-withtitle) | ||
* [`fn withTooltip(value)`](#fn-withtooltip) | ||
* [`fn withType(value)`](#fn-withtype) | ||
* [`fn withUrl(value)`](#fn-withurl) | ||
|
||
## Fields | ||
|
||
### fn withAsDropdown | ||
|
||
```jsonnet | ||
withAsDropdown(value=true) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`boolean`) | ||
- default value: `true` | ||
|
||
If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards | ||
### fn withIcon | ||
|
||
```jsonnet | ||
withIcon(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`string`) | ||
|
||
Icon name to be displayed with the link | ||
### fn withIncludeVars | ||
|
||
```jsonnet | ||
withIncludeVars(value=true) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`boolean`) | ||
- default value: `true` | ||
|
||
If true, includes current template variables values in the link as query params | ||
### fn withKeepTime | ||
|
||
```jsonnet | ||
withKeepTime(value=true) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`boolean`) | ||
- default value: `true` | ||
|
||
If true, includes current time range in the link as query params | ||
### fn withTags | ||
|
||
```jsonnet | ||
withTags(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`array`) | ||
|
||
List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards | ||
### fn withTagsMixin | ||
|
||
```jsonnet | ||
withTagsMixin(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`array`) | ||
|
||
List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards | ||
### fn withTargetBlank | ||
|
||
```jsonnet | ||
withTargetBlank(value=true) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`boolean`) | ||
- default value: `true` | ||
|
||
If true, the link will be opened in a new tab | ||
### fn withTitle | ||
|
||
```jsonnet | ||
withTitle(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`string`) | ||
|
||
Title to display with the link | ||
### fn withTooltip | ||
|
||
```jsonnet | ||
withTooltip(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`string`) | ||
|
||
Tooltip to display when the user hovers their mouse over it | ||
### fn withType | ||
|
||
```jsonnet | ||
withType(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`string`) | ||
- valid values: `"link"`, `"dashboards"` | ||
|
||
Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) | ||
### fn withUrl | ||
|
||
```jsonnet | ||
withUrl(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`string`) | ||
|
||
Link URL. Only required/valid if the type is link |
102 changes: 102 additions & 0 deletions
102
docs/API/panel/alertList/queryOptions/transformation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# transformation | ||
|
||
|
||
|
||
## Index | ||
|
||
* [`fn withDisabled(value=true)`](#fn-withdisabled) | ||
* [`fn withFilter(value)`](#fn-withfilter) | ||
* [`fn withFilterMixin(value)`](#fn-withfiltermixin) | ||
* [`fn withId(value)`](#fn-withid) | ||
* [`fn withOptions(value)`](#fn-withoptions) | ||
* [`obj filter`](#obj-filter) | ||
* [`fn withId(value="")`](#fn-filterwithid) | ||
* [`fn withOptions(value)`](#fn-filterwithoptions) | ||
|
||
## Fields | ||
|
||
### fn withDisabled | ||
|
||
```jsonnet | ||
withDisabled(value=true) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`boolean`) | ||
- default value: `true` | ||
|
||
Disabled transformations are skipped | ||
### fn withFilter | ||
|
||
```jsonnet | ||
withFilter(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`object`) | ||
|
||
Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. | ||
It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. | ||
### fn withFilterMixin | ||
|
||
```jsonnet | ||
withFilterMixin(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`object`) | ||
|
||
Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. | ||
It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. | ||
### fn withId | ||
|
||
```jsonnet | ||
withId(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`string`) | ||
|
||
Unique identifier of transformer | ||
### fn withOptions | ||
|
||
```jsonnet | ||
withOptions(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`string`) | ||
|
||
Options to be passed to the transformer | ||
Valid options depend on the transformer id | ||
### obj filter | ||
|
||
|
||
#### fn filter.withId | ||
|
||
```jsonnet | ||
filter.withId(value="") | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`string`) | ||
- default value: `""` | ||
|
||
The matcher id. This is used to find the matcher implementation from registry. | ||
#### fn filter.withOptions | ||
|
||
```jsonnet | ||
filter.withOptions(value) | ||
``` | ||
|
||
PARAMETERS: | ||
|
||
* **value** (`string`) | ||
|
||
The matcher options. This is specific to the matcher implementation. |
Oops, something went wrong.