Grafonnet

https://grafana.github.io/grafonnet/
Admin
Grafonnet is a library that provides a programmatic API for defining and managing Grafana...
Tokens:146,397
Snippets:1,283
Trust Score:8.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Import Grafonnet Latest Version (Grafonnet)

Source: https://grafana.github.io/grafonnet/examples/simple

Shows how to import the latest version of Grafonnet using a direct import path. This ensures portability by referencing a specific version of the Grafonnet library, such as `grafonnet-latest`.

```jsonnet
import 'github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet'


```

--------------------------------

### Install Grafonnet with jsonnet-bundler

Source: https://grafana.github.io/grafonnet/index

This command installs the latest version of the Grafonnet library into your jsonnet project using jsonnet-bundler. This makes the Grafonnet library available for import in your Jsonnet files.

```bash
jb install github.com/grafana/grafonnet/gen/grafonnet-latest@main

```

--------------------------------

### standardOptions.thresholds.withSteps

Source: https://grafana.github.io/grafonnet/API/panel/logs/index

Configures thresholds using a series of steps, where each step is defined by a value. The steps must be sorted by value, starting with -Infinity.

```APIDOC
## standardOptions.thresholds.withSteps

### Description
Configures thresholds using a series of steps. The 'value' parameter is an array of steps, which must be sorted by their 'value' property. The first value is always considered -Infinity.

### Method
Function (within Grafonnet)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```grafonnet
standardOptions.thresholds.withSteps([
  { value: -Infinity },
  { value: 10 },
  { value: 20 },
  { value: 30 },
])
```

### Response
#### Success Response (200)
N/A (This is a function configuration, not an API endpoint)

#### Response Example
N/A
```

--------------------------------

### Create Grafonnet Dashboard with Time Series Panel (Grafonnet)

Source: https://grafana.github.io/grafonnet/examples/simple

Defines a simple Grafana dashboard using Grafonnet. It includes a single time series panel that queries Prometheus metrics for requests per second, categorized by status code. The dashboard is configured with a UID, description, and shared crosshair tooltip.

```jsonnet
local g = import 'g.libsonnet';

g.dashboard.new('Faro dashboard')
+ g.dashboard.withUid('faro-grafonnet-demo')
+ g.dashboard.withDescription('Dashboard for Faro')
+ g.dashboard.graphTooltip.withSharedCrosshair()
+ g.dashboard.withPanels([
  g.panel.timeSeries.new('Requests / sec')
  + g.panel.timeSeries.queryOptions.withTargets([
    g.query.prometheus.new(
      'mimir',
      'sum by (status_code) (rate(request_duration_seconds_count{job=~".*/faro-api"}[$__rate_interval]))',
    ),
  ])
  + g.panel.timeSeries.standardOptions.withUnit('reqps')
  + g.panel.timeSeries.gridPos.withW(24)
  + g.panel.timeSeries.gridPos.withH(8),
])


```

--------------------------------

### Grafonnet: Configure Threshold Steps

Source: https://grafana.github.io/grafonnet/API/librarypanel/index

Configures thresholds using a series of steps. The steps must be sorted by value, starting with -Infinity.

```jsonnet
model.fieldConfig.defaults.thresholds.withSteps(value)
```

--------------------------------

### Create a new dashboard

Source: https://grafana.github.io/grafonnet/API/dashboard/index

Initializes a new dashboard with a specified title. This is the starting point for defining a dashboard structure.

```jsonnet
grafonnet.dashboard.new(title)
```

--------------------------------

### Generate a Grafana Dashboard using Grafonnet

Source: https://grafana.github.io/grafonnet/index

This Jsonnet code snippet demonstrates how to import the Grafonnet library and create a new Grafana dashboard with a specified title. It serves as a basic example of Grafonnet's dashboard generation capabilities.

```jsonnet
// dashboard.jsonnet
local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet';

grafonnet.dashboard.new('My Dashboard')

```

--------------------------------

### Set fiscal year start month

Source: https://grafana.github.io/grafonnet/API/dashboard/index

Specifies the starting month of the fiscal year for the dashboard. 0 represents January, and 11 represents December.

```jsonnet
grafonnet.dashboard.withFiscalYearStartMonth(value=0)
```

--------------------------------

### Threshold Configuration

Source: https://grafana.github.io/grafonnet/API/panel/xyChart/standardOptions/threshold/step

This section details the functions for configuring threshold properties, specifically setting a color and a value.

```APIDOC
## Threshold Configuration API

### Description
This API allows for the configuration of threshold properties, including setting a specific color and a numerical value.

### Method
Various methods depending on the underlying implementation (likely POST or PUT when part of a larger configuration).

### Endpoint
`/threshold` (example, actual endpoint may vary based on context)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
##### `withColor(value)`
- **value** (string) - Required - Color to be applied when the threshold is met or exceeded. This represents the visual change in the dashboard.

##### `withValue(value)`
- **value** (number) - Required - The numerical metric value that triggers a visual change in the dashboard when met or exceeded. Nulls may appear when serializing -Infinity to JSON.

### Request Example
```json
{
  "threshold": {
    "color": "red",
    "value": 100
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - Provides details about the result of the configuration.

#### Response Example
```json
{
  "status": "success",
  "message": "Threshold configured successfully."
}
```
```

--------------------------------

### Dashboard Creation and Basic Configuration

Source: https://grafana.github.io/grafonnet/API/dashboard/index

Functions for initializing a new dashboard and setting fundamental properties like title, description, and refresh rate.

```APIDOC
## Dashboard Creation and Basic Configuration

### `fn new(title)`

- **title** (string) - Required - The title of the dashboard.

Creates a new dashboard with the specified title.

### `fn withTitle(value)`

- **value** (string) - Required - The title to set for the dashboard.

Sets or updates the title of the dashboard.

### `fn withDescription(value)`

- **value** (string) - Optional - The description for the dashboard.

Adds a description to the dashboard.

### `fn withEditable(value)`

- **value** (boolean) - Optional - Defaults to `true`. Set to `false` to make the dashboard read-only.

Configures whether the dashboard is editable.

### `fn withRefresh(value)`

- **value** (string) - Required - A string representing the refresh interval (e.g., "5s", "1m", "1h").

Sets the automatic refresh interval for the dashboard.

### `fn withSchemaVersion(value)`

- **value** (number) - Optional - Defaults to `39`.

Sets the schema version for the dashboard. This is typically managed internally by Grafana.

### `fn withLiveNow(value)`

- **value** (boolean) - Optional - Defaults to `true`.

Enables or disables the live update behavior for the dashboard, where panels redraw based on pixel width to keep data moving.

### `fn withFiscalYearStartMonth(value)`

- **value** (integer) - Optional - Defaults to `0` (January).

Specifies the starting month of the fiscal year for the dashboard's time calculations.

### `fn withTimezone(value)`

- **value** (string) - Optional - Defaults to `"browser"`.

Sets the timezone for the dashboard. Can be `"browser"` or a specific timezone identifier.
```

--------------------------------

### timeRange.withFrom

Source: https://grafana.github.io/grafonnet/API/query/expr/TypeMath

Sets the start time for a time range query. Defaults to 'now-6h'.

```APIDOC
## fn timeRange.withFrom

### Description
Sets the start time for a time range query. Defaults to 'now-6h'.

### Method
N/A (Function)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **value** (string) - Optional - The start time of the query. Defaults to "now-6h".

### Request Example
```json
{
  "example": "timeRange.withFrom(\"now-1h\")"
}
```

### Response
#### Success Response (200)
N/A (Function return value)

#### Response Example
```json
{
  "example": ""
}
```
```

--------------------------------

### Threshold Configuration API

Source: https://grafana.github.io/grafonnet/API/panel/alertList/standardOptions/threshold/step

API endpoints for configuring threshold properties like value and color.

```APIDOC
## Threshold Configuration

### `withColor(value)`

#### Description
Sets the color associated with a threshold. This color will be applied visually when the threshold value is met or exceeded.

#### Method
Not applicable (function within configuration)

#### Endpoint
Not applicable (function within configuration)

#### Parameters

##### Function Parameters
- **value** (string) - Required - The color to be applied to the threshold.

### `withValue(value)`

#### Description
Sets the numeric value for a threshold. A visual change will occur on the dashboard when this value is met or exceeded.

#### Method
Not applicable (function within configuration)

#### Endpoint
Not applicable (function within configuration)

#### Parameters

##### Function Parameters
- **value** (number) - Required - The numeric threshold value.

### Request Example
```json
{
  "threshold": {
    "value": 100,
    "color": "red"
  }
}
```

### Response
#### Success Response (200)
- **threshold** (object) - Contains the configured threshold value and color.
  - **value** (number) - The set threshold value.
  - **color** (string) - The set threshold color.

#### Response Example
```json
{
  "threshold": {
    "value": 100,
    "color": "red"
  }
}
```
```

--------------------------------

### Panel Options

Source: https://grafana.github.io/grafonnet/API/panel/datagrid/index

Configuration options for the Datagrid panel, including description, grid position, links, repeat settings, title, and transparency.

```APIDOC
## Panel Options

### Description
Configure various display and layout options for the Datagrid panel.

#### `withDescription(value: string)`
- **value** (string) - Optional - Panel description.

#### `withGridPos(h: number, w: number, x: number, y: number)`
- **h** (number) - Optional - Height of the panel. Defaults to null.
- **w** (number) - Optional - Width of the panel. Defaults to null.
- **x** (number) - Optional - X-coordinate of the panel. Defaults to null.
- **y** (number) - Optional - Y-coordinate of the panel. Defaults to null.

#### `withLinks(value: array)`
- **value** (array) - Optional - Panel links.

#### `withLinksMixin(value: array)`
- **value** (array) - Optional - Panel links (mixin).

#### `withMaxPerRow(value: number)`
- **value** (number) - Optional - Maximum items per row for repeated panels.

#### `withRepeat(value: string)`
- **value** (string) - Optional - Name of template variable to repeat for.

#### `withRepeatDirection(value: string)`
- **value** (string) - Optional - Direction to repeat in (`h` for horizontal, `v` for vertical). Defaults to 'h'.

#### `withTitle(value: string)`
- **value** (string) - Optional - Panel title.

#### `withTransparent(value: boolean)`
- **value** (boolean) - Optional - Whether to display the panel without a background. Defaults to true.

### Example
```python
grafonnet.panel.datagrid.new(title="My Datagrid")
  .panelOptions.withDescription("A detailed datagrid view")
  .panelOptions.withGridPos(h=5, w=10, x=0, y=0)
  .panelOptions.withTitle("Custom Datagrid")
  .panelOptions.withTransparent(false)
```
```

--------------------------------

### Initialize Grafana Dashboard Configuration

Source: https://grafana.github.io/grafonnet/examples/runtimeDashboard

Initializes a new Grafana dashboard with a specified title and description. It also configures the graph tooltip to share crosshair and tooltip information across all panels for a unified viewing experience.

```jsonnet
g.dashboard.new('Controller Runtime')
+ g.dashboard.withDescription(|||
  Generic dashboard for controller-runtime based processes
  (https://github.com/kubernetes-sigs/controller-runtime)
|||)
+ g.dashboard.graphTooltip.withSharedCrosshair()

```

--------------------------------

### standardOptions.thresholds.withStepsMixin

Source: https://grafana.github.io/grafonnet/API/panel/stateTimeline/index

A mixin function to set threshold steps. Similar to `withSteps`, the array must be sorted by value, starting with -Infinity.

```APIDOC
## standardOptions.thresholds.withStepsMixin

### Description
A mixin function to set threshold steps. Similar to `withSteps`, the array must be sorted by value, starting with -Infinity.

### Method
```
standardOptions.thresholds.withStepsMixin(value)
```

### Parameters
#### Query Parameters
- **value** (array) - Required - An array of threshold values, sorted in ascending order. The first value must be -Infinity.
```

--------------------------------

### Library Panel Configuration

Source: https://grafana.github.io/grafonnet/API/panel/datagrid/index

Configure library panel properties such as name and UID.

```APIDOC
## Library Panel Configuration

### Description
Methods to configure library panel properties.

#### `withName(value: string)`
- **value** (string) - Required - Library panel name.

#### `withUid(value: string)`
- **value** (string) - Required - Library panel UID.

### Example
```python
grafonnet.panel.datagrid.new(title="My Datagrid").libraryPanel.withName("my-library-panel").libraryPanel.withUid("my-panel-uid")
```
```

--------------------------------

### Create a new Pie Chart panel

Source: https://grafana.github.io/grafonnet/API/panel/pieChart/index

Initializes a new pie chart panel with a specified title. This is the entry point for creating any pie chart visualization.

```grafonnet
grafonnet.panel.pieChart.new(title)
```

--------------------------------

### standardOptions.withMappings

Source: https://grafana.github.io/grafonnet/API/panel/datagrid/index

Configures mappings for standard options. Accepts an array of values.

```APIDOC
## standardOptions.withMappings

### Description
Configures mappings for standard options. This function converts input values into a display string.

### Method
`standardOptions.withMappings(value)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*   **value** (array) - Required - The array of values to be mapped.
```

--------------------------------

### Panel Options Configuration

Source: https://grafana.github.io/grafonnet/API/panel/trend/index

Configure general panel options including description, legend, tooltips, and repeat behavior.

```APIDOC
## options.withLegend

### Description
Configures the legend for the panel.

### Method
options.withLegend(value)

### Parameters
#### Path Parameters
* **value** (object) - Required - Legend configuration object.

### Request Example
```json
{
  "code": "options.withLegend({\"show\": true})"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "options.withLegend({\"show\": true})"
}
```

## options.withLegendMixin

### Description
Applies a mixin configuration to the panel legend.

### Method
options.withLegendMixin(value)

### Parameters
#### Path Parameters
* **value** (object) - Required - Legend mixin configuration object.

### Request Example
```json
{
  "code": "options.withLegendMixin({\"placement\": \"right\"})"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "options.withLegendMixin({\"placement\": \"right\"})"
}
```

## options.withTooltip

### Description
Configures the tooltip for the panel.

### Method
options.withTooltip(value)

### Parameters
#### Path Parameters
* **value** (object) - Required - Tooltip configuration object.

### Request Example
```json
{
  "code": "options.withTooltip({\"mode\": \"multi\"})"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "options.withTooltip({\"mode\": \"multi\"})"
}
```

## options.withTooltipMixin

### Description
Applies a mixin configuration to the panel tooltip.

### Method
options.withTooltipMixin(value)

### Parameters
#### Path Parameters
* **value** (object) - Required - Tooltip mixin configuration object.

### Request Example
```json
{
  "code": "options.withTooltipMixin({\"maxHeight\": 300})"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "options.withTooltipMixin({\"maxHeight\": 300})"
}
```

## options.withXField

### Description
Specifies the name of the field to be used as the x-axis.

### Method
options.withXField(value)

### Parameters
#### Path Parameters
* **value** (string) - Required - The name of the x-field. Defaults to the first number field.

### Request Example
```json
{
  "code": "options.withXField(\"time\")"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "options.withXField(\"time\")"
}
```

## panelOptions.withDescription

### Description
Sets a description for the panel.

### Method
panelOptions.withDescription(value)

### Parameters
#### Path Parameters
* **value** (string) - Required - The panel description.

### Request Example
```json
{
  "code": "panelOptions.withDescription(\"This is a detailed panel description\")"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "panelOptions.withDescription(\"This is a detailed panel description\")"
}
```

## panelOptions.withGridPos

### Description
Configures the position and size of the panel within the grid.

### Method
panelOptions.withGridPos(h, w, x, y)

### Parameters
#### Path Parameters
* **h** (number) - Optional - The height of the panel. Defaults to `null`.
* **w** (number) - Optional - The width of the panel. Defaults to `null`.
* **x** (number) - Optional - The x-coordinate of the panel. Defaults to `null`.
* **y** (number) - Optional - The y-coordinate of the panel. Defaults to `null`.

### Request Example
```json
{
  "code": "panelOptions.withGridPos(h=6, w=12, x=0, y=0)"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "panelOptions.withGridPos(h=6, w=12, x=0, y=0)"
}
```

## panelOptions.withLinks

### Description
Sets the links for the panel.

### Method
panelOptions.withLinks(value)

### Parameters
#### Path Parameters
* **value** (array) - Required - An array of link objects for the panel.

### Request Example
```json
{
  "code": "panelOptions.withLinks([{ \"title\": \"Go to Dashboard\", \"url\": \"/d/my-dashboard\" }])"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "panelOptions.withLinks([{ \"title\": \"Go to Dashboard\", \"url\": \"/d/my-dashboard\" }])"
}
```

## panelOptions.withLinksMixin

### Description
Applies a mixin configuration to the panel links.

### Method
panelOptions.withLinksMixin(value)

### Parameters
#### Path Parameters
* **value** (array) - Required - An array of link objects for the panel.

### Request Example
```json
{
  "code": "panelOptions.withLinksMixin([{ \"title\": \"Go to Dashboard\", \"url\": \"/d/my-dashboard\" }])"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "panelOptions.withLinksMixin([{ \"title\": \"Go to Dashboard\", \"url\": \"/d/my-dashboard\" }])"
}
```

## panelOptions.withMaxPerRow

### Description
Sets the maximum number of items per row for repeated panels.

### Method
panelOptions.withMaxPerRow(value)

### Parameters
#### Path Parameters
* **value** (number) - Required - The maximum number of items per row.

### Request Example
```json
{
  "code": "panelOptions.withMaxPerRow(5)"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "panelOptions.withMaxPerRow(5)"
}
```

## panelOptions.withRepeat

### Description
Specifies a template variable to repeat the panel for.

### Method
panelOptions.withRepeat(value)

### Parameters
#### Path Parameters
* **value** (string) - Required - The name of the template variable to repeat for.

### Request Example
```json
{
  "code": "panelOptions.withRepeat(\"myTemplateVar\")"
}
```

### Response
#### Success Response (200)
- **string**: The updated configuration string.

#### Response Example
```json
{
  "code": "panelOptions.withRepeat(\"myTemplateVar\")"
}
```
```

--------------------------------

### Threshold Configuration API

Source: https://grafana.github.io/grafonnet/API/panel/heatmap/standardOptions/threshold/step

This section describes the configuration options for threshold steps, including setting the color and value for a threshold.

```APIDOC
## Threshold Configuration

This API provides methods to configure threshold steps for visual indicators in dashboards.

### `withColor(value)`

**Description**: Sets the color for a threshold step. This color will be applied to the dashboard when the threshold value is met or exceeded.

**Method**: N/A (Function Signature)

**Parameters**:
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

**Function Signature**:
```
withColor(value: string)
```

**Parameters**:
* **value** (string) - Required - The color to be associated with the threshold.

### `withValue(value)`

**Description**: Sets the numerical value for a threshold step. When the metric value meets or exceeds this threshold, a visual change will occur in the dashboard.

**Method**: N/A (Function Signature)

**Parameters**:
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

**Function Signature**:
```
withValue(value: number)
```

**Parameters**:
* **value** (number) - Required - The numerical value that triggers the threshold.

**Note**: Nulls may appear when serializing -Infinity to JSON.
```

--------------------------------

### Heatmap Panel Creation and Basic Options

Source: https://grafana.github.io/grafonnet/API/panel/heatmap/index

This section covers the creation of a heatmap panel and basic configuration options like title, calculation, cell gap, cell radius, and cell values.

```APIDOC
## Heatmap Panel Configuration

### Description
This section details the creation and configuration of heatmap panels.

### Methods

#### `new(title)`

- **Description**: Creates a new heatmap panel with a specified title.
- **Parameters**:
  - `title` (string) - Required - The title for the heatmap panel.

#### `options.withCalculate(value)`

- **Description**: Controls whether the heatmap should be calculated from the data.
- **Parameters**:
  - `value` (boolean) - Optional - Default: `true`. Set to `true` to enable calculation from data.

#### `options.withCalculation(value)`

- **Description**: Sets the calculation options for the heatmap.
- **Parameters**:
  - `value` (object) - Required - An object containing calculation options.

#### `options.withCalculationMixin(value)`

- **Description**: Mixes in calculation options for the heatmap.
- **Parameters**:
  - `value` (object) - Required - An object containing calculation options to be mixed in.

#### `options.withCellGap(value)`

- **Description**: Controls the gap between cells in the heatmap.
- **Parameters**:
  - `value` (integer) - Optional - Default: `1`. The gap size between cells.

#### `options.withCellRadius(value)`

- **Description**: Controls the radius of the cells in the heatmap.
- **Parameters**:
  - `value` (number) - Required - The radius of the cells.

#### `options.withCellValues(value)`

- **Description**: Controls options for displaying cell values.
- **Parameters**:
  - `value` (object) - Required - An object containing cell value display options.

#### `options.withCellValuesMixin(value)`

- **Description**: Mixes in options for displaying cell values.
- **Parameters**:
  - `value` (object) - Required - An object containing cell value display options to be mixed in.

### Request Example
```json
{
  "title": "My Heatmap Panel",
  "calculation": {
    "enabled": true
  },
  "cellGap": 2,
  "cellRadius": 5,
  "cellValues": {
    "show": true
  }
}
```

### Response Example
```json
{
  "panel": {
    "type": "heatmap",
    "title": "My Heatmap Panel",
    "options": {
      "calculation": {
        "enabled": true
      },
      "cellGap": 2,
      "cellRadius": 5,
      "cellValues": {
        "show": true
      }
    }
  }
}
```
```

--------------------------------

### standardOptions.thresholds.withStepsMixin

Source: https://grafana.github.io/grafonnet/API/panel/trend/index

Configures steps for thresholds using a mixin, requiring a sorted array of values.

```APIDOC
## standardOptions.thresholds.withStepsMixin

### Description
Configures steps for thresholds using a mixin. The value must be a sorted array of numbers, where the first value is always -Infinity.

### Method
`standardOptions.thresholds.withStepsMixin(value)`

### Parameters
#### Query Parameters
- **value** (array) - Required - An array of numbers representing the threshold steps, sorted in ascending order. The first element must be -Infinity.

### Request Example
```json
{
  "value": [-Infinity, 25, 75]
}
```

### Response
#### Success Response (200)
- **array** - The configured threshold steps.

#### Response Example
```json
{
  "configuredThresholdStepsMixin": [-Infinity, 25, 75]
}
```
```

--------------------------------

### Standard Options: Links Mixin

Source: https://grafana.github.io/grafonnet/API/panel/heatmap/index

Applies link configurations from a mixin. Accepts an array of link configurations.

```APIDOC
## POST /websites/grafana_github_io_grafonnet/standardOptions/withLinksMixin

### Description
The behavior when clicking on a result.

### Method
POST

### Endpoint
/websites/grafana_github_io_grafonnet/standardOptions/withLinksMixin

#### Parameters

##### Request Body

- **value** (array) - Required - An array of link configurations to be mixed in.

### Request Example
```json
{
  "value": [
    {
      "title": "View Details",
      "url": "/explore?orgId=1&left=<",
      "openInNewTab": true
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation of the setting update.

#### Response Example
```json
{
  "message": "Links mixin applied successfully"
}
```
```

--------------------------------

### standardOptions.withMappingsMixin

Source: https://grafana.github.io/grafonnet/API/panel/datagrid/index

Applies mapping mixins to standard options. Accepts an array of values.

```APIDOC
## standardOptions.withMappingsMixin

### Description
Applies mapping mixins to standard options. This function converts input values into a display string.

### Method
`standardOptions.withMappingsMixin(value)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*   **value** (array) - Required - The array of values for the mapping mixin.
```

--------------------------------

### Panel Options

Source: https://grafana.github.io/grafonnet/API/panel/statusHistory/index

This section covers functions for configuring general panel options such as description, grid positioning, and links.

```APIDOC
## Panel Options

### Description
Configuration options for panel-level settings.

### Endpoints
- `panelOptions.withDescription(value)`
- `panelOptions.withGridPos(h, w, x, y)`
- `panelOptions.withLinks(value)`
- `panelOptions.withLinksMixin(value)`
- `panelOptions.withMaxPerRow(value)`
- `panelOptions.withRepeat(value)`

### `panelOptions.withDescription`

#### Description
Sets the description for the panel.

#### Method
N/A (Function within a library)

#### Parameters
- **value** (`string`) - Required - Panel description.

### `panelOptions.withGridPos`

#### Description
Configures the height, width, and xy coordinates of the panel. Use `grafonnet.util.grid` for helper functions.

#### Method
N/A (Function within a library)

#### Parameters
- **h** (`number`) - Optional - Default: `null`. Height of the panel.
- **w** (`number`) - Optional - Default: `null`. Width of the panel.
- **x** (`number`) - Optional - Default: `null`. X-coordinate of the panel.
- **y** (`number`) - Optional - Default: `null`. Y-coordinate of the panel.

### `panelOptions.withLinks`

#### Description
Sets the panel links.

#### Method
N/A (Function within a library)

#### Parameters
- **value** (`array`) - Required - Panel links.

### `panelOptions.withLinksMixin`

#### Description
A mixin for setting panel links.

#### Method
N/A (Function within a library)

#### Parameters
- **value** (`array`) - Required - Panel links.

### `panelOptions.withMaxPerRow`

#### Description
Controls the maximum number of items per row for repeated panels. Only relevant for horizontally repeated panels.

#### Method
N/A (Function within a library)

#### Parameters
- **value** (`number`) - Required - Maximum items per row.

### `panelOptions.withRepeat`

#### Description
Specifies the name of the template variable to repeat for.

#### Method
N/A (Function within a library)

#### Parameters
- **value** (`string`) - Required - Name of template variable to repeat for.
```

--------------------------------

### Link Configuration Functions

Source: https://grafana.github.io/grafonnet/API/panel/barChart/panelOptions/link

This section outlines the functions used to configure the properties of links, such as display format, included information, and target behavior.

```APIDOC
## Link Configuration Functions

### `withAsDropdown(value)`

Controls whether dashboard links are displayed in a dropdown.

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`boolean`) - Optional. Default: `true`. If `true`, links are in a dropdown. If `false`, links are side-by-side. Only applies when type is 'dashboards'.

### `withIcon(value)`

Sets an icon to be displayed with the link.

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`string`) - Required. The name of the icon to display.

### `withIncludeVars(value)`

Determines if current template variables should be included in the link.

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`boolean`) - Optional. Default: `true`. If `true`, variables are included as query parameters.

### `withKeepTime(value)`

Determines if the current time range should be included in the link.

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`boolean`) - Optional. Default: `true`. If `true`, the time range is included as query parameters.

### `withTags(value)`

Filters linked dashboards by tags.

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`array`) - Optional. A list of tags to filter by. If empty, all dashboards are displayed. Only valid when type is 'dashboards'.

### `withTagsMixin(value)`

Filters linked dashboards by tags (similar to `withTags`).

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`array`) - Optional. A list of tags to filter by. If empty, all dashboards are displayed. Only valid when type is 'dashboards'.

### `withTargetBlank(value)`

Specifies whether the link should open in a new tab.

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`boolean`) - Optional. Default: `true`. If `true`, the link opens in a new tab.

### `withTitle(value)`

Sets the title to be displayed for the link.

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`string`) - Required. The title for the link.

### `withTooltip(value)`

Sets the tooltip text that appears on hover.

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`string`) - Required. The tooltip text.

### `withType(value)`

Specifies the type of the link.

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`string`) - Required. Accepted values: `"link"` (external resource) or `"dashboards"` (another dashboard).

### `withUrl(value)`

Sets the URL for an external link.

- **Method**: N/A (Configuration function)
- **Endpoint**: N/A
- **Parameters**:
  - **value** (`string`) - Required. The URL for the link. Only valid if type is 'link'.

```

--------------------------------

### Configure Exemplar Options

Source: https://grafana.github.io/grafonnet/API/panel/heatmap/index

Controls exemplar display options for panels. Accepts an object with color configuration. This function and its mixin variant provide identical functionality.

```grafonnet
options.withExemplars(value={\"color\": \"rgba(255,0,255,0.7)\"})
```

```grafonnet
options.withExemplarsMixin(value={\"color\": \"rgba(255,0,255,0.7)\"})
```

--------------------------------

### Panel Options

Source: https://grafana.github.io/grafonnet/API/panel/text/index

Functions for configuring the display and behavior of Grafana panels.

```APIDOC
## Panel Options

### `withMaxPerRow`

Configures the maximum number of items to display per row for horizontally repeated panels.

- **Method**: Not Applicable (Function call)
- **Endpoint**: Not Applicable
- **Parameters**:
  - **value** (`number`) - Required - The maximum number of items per row.

### `withRepeat`

Sets a template variable to repeat the panel for.

- **Method**: Not Applicable (Function call)
- **Endpoint**: Not Applicable
- **Parameters**:
  - **value** (`string`) - Required - The name of the template variable to repeat for.

### `withRepeatDirection`

Specifies the direction for repeating panels (horizontal or vertical).

- **Method**: Not Applicable (Function call)
- **Endpoint**: Not Applicable
- **Parameters**:
  - **value** (`string`) - Optional - Defaults to 'h'. Valid values: 'h' (horizontal), 'v' (vertical).

### `withTitle`

Sets the title of the panel.

- **Method**: Not Applicable (Function call)
- **Endpoint**: Not Applicable
- **Parameters**:
  - **value** (`string`) - Required - The title for the panel.

### `withTransparent`

Determines whether the panel should be displayed without a background.

- **Method**: Not Applicable (Function call)
- **Endpoint**: Not Applicable
- **Parameters**:
  - **value** (`boolean`) - Optional - Defaults to `true`. If `true`, the panel has no background.
```

--------------------------------

### Tempo Query Initialization (Grafonnet)

Source: https://grafana.github.io/grafonnet/API/query/tempo/index

Initializes a new Tempo query target for Grafana panels. It requires a datasource, a query string, and an array of filters as parameters.

```grafonnet
grafonnet.query.tempo.new(datasource, query, filters)
```

--------------------------------

### ValueMap API

Source: https://grafana.github.io/grafonnet/API/panel/news/standardOptions/mapping

Enables configuration of value mappings with options and type settings.

```APIDOC
## ValueMap Functions

### ValueMap.withOptions

#### Description
Configures a map with specific value-to-result mappings.

#### Parameters
- **value** (object) - Required - A map where keys are values and values are `ValueMappingResult` objects (e.g., `{ "10": { text: "Perfection!", color: "green" } }`).

### ValueMap.withOptionsMixin

#### Description
Applies value-to-result mappings as a mixin.

#### Parameters
- **value** (object) - Required - A map where keys are values and values are `ValueMappingResult` objects (e.g., `{ "10": { text: "Perfection!", color: "green" } }`).

### ValueMap.withType

#### Description
Sets the type for ValueMap. This function takes no arguments.
```

--------------------------------

### ValueMap Configuration

Source: https://grafana.github.io/grafonnet/API/panel/annotationsList/standardOptions/mapping

Configure ValueMap for direct value mapping.

```APIDOC
## ValueMap Configuration

### Description
Configure ValueMap for direct value mapping. This allows you to map specific input values to specific output values, often used for renaming or categorizing data points.

### Methods
#### `ValueMap.withOptions(value)`
Sets the options for a ValueMap.

- **value** (`object`) - The mapping configuration, typically an array of value-to-result mappings.

#### `ValueMap.withOptionsMixin(value)`
Similar to `withOptions`, but can be mixed with other configurations.

- **value** (`object`) - The mapping configuration.

#### `ValueMap.withType()`
Specifies the type of mapping as ValueMap.
```

--------------------------------

### Configure Pie Chart query options

Source: https://grafana.github.io/grafonnet/API/panel/pieChart/index

Manages data retrieval for the pie chart, including setting the data source, interval, maximum data points, query caching, and transformations. Supports mixin for advanced configurations.

```grafonnet
queryOptions.withDatasource(type, uid)
queryOptions.withDatasourceMixin(value)
queryOptions.withHideTimeOverride(value=true)
queryOptions.withInterval(value)
queryOptions.withMaxDataPoints(value)
queryOptions.withQueryCachingTTL(value)
queryOptions.withTargets(value)
queryOptions.withTargetsMixin(value)
queryOptions.withTimeFrom(value)
queryOptions.withTimeShift(value)
queryOptions.withTransformations(value)
queryOptions.withTransformationsMixin(value)
```

--------------------------------

### Datagrid Panel Creation

Source: https://grafana.github.io/grafonnet/API/panel/datagrid/index

Provides methods to create a new Datagrid panel with a specified title.

```APIDOC
## Datagrid Panel Creation

### Description
Creates a new datagrid panel with a title.

### Method
`new(title: string)

### Parameters
- **title** (string) - Required - The title for the datagrid panel.

### Example
```python
grafonnet.panel.datagrid.new(title="My Datagrid")
```
```

--------------------------------

### Import Grafonnet Libraries and Components

Source: https://grafana.github.io/grafonnet/examples/runtimeDashboard

Imports the main Grafonnet library, a shortcut for row panels, and separate definitions for panels, variables, and queries. These imports are essential for composing the dashboard.

```jsonnet
local g = import 'g.libsonnet';

local row = g.panel.row;

local panels = import './panels.libsonnet';
local variables = import './variables.libsonnet';
local queries = import './queries.libsonnet';

```

--------------------------------

### standardOptions.withOverridesMixin

Source: https://grafana.github.io/grafonnet/API/panel/datagrid/index

Applies override mixins to standard options. Accepts an array of override configurations.

```APIDOC
## standardOptions.withOverridesMixin

### Description
Applies override mixins to standard options. Overrides are options applied to specific fields overriding the defaults.

### Method
`standardOptions.withOverridesMixin(value)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*   **value** (array) - Required - An array of override mixin configurations.
```

--------------------------------

### Standard Options: Mappings Mixin

Source: https://grafana.github.io/grafonnet/API/panel/heatmap/index

Applies mapping configurations from a mixin. Accepts an array of mapping configurations.

```APIDOC
## POST /websites/grafana_github_io_grafonnet/standardOptions/withMappingsMixin

### Description
Convert input values into a display string.

### Method
POST

### Endpoint
/websites/grafana_github_io_grafonnet/standardOptions/withMappingsMixin

#### Parameters

##### Request Body

- **value** (array) - Required - An array of mapping configurations to be mixed in.

### Request Example
```json
{
  "value": [
    {
      "from": 0,
      "to": 10,
      "text": "Low"
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation of the setting update.

#### Response Example
```json
{
  "message": "Mappings mixin applied successfully"
}
```
```

--------------------------------

### RegexMap Configuration

Source: https://grafana.github.io/grafonnet/API/panel/annotationsList/standardOptions/mapping

Configure RegexMap to match values against a regular expression and apply a corresponding result.

```APIDOC
## RegexMap Configuration

### Description
Configure RegexMap to match values against a regular expression and apply a corresponding result.

### Methods
#### `RegexMap.withOptions(value)`
Sets the options for a RegexMap.

- **value** (`object`) - The regex pattern and result configuration.

#### `RegexMap.withOptionsMixin(value)`
Similar to `withOptions`, but can be mixed with other configurations.

- **value** (`object`) - The regex pattern and result configuration.

#### `RegexMap.withType()`
Specifies the type of mapping as RegexMap.

### Nested Options
#### `RegexMap.options.withPattern(value)`
Sets the regular expression pattern for matching.

- **value** (`string`) - The regular expression string.

#### `RegexMap.options.withResult(value)`
Defines the result to be applied when the value matches the regex.

- **value** (`object`) - The result configuration (text, color, icon, etc.).

#### `RegexMap.options.withResultMixin(value)`
Similar to `withResult`, but can be mixed with other configurations.

- **value** (`object`) - The result configuration.

### Nested Result Options
#### `RegexMap.options.result.withColor(value)`
Sets the display color for the result.

- **value** (`string`) - The color value.

#### `RegexMap.options.result.withIcon(value)`
Sets the display icon for the result.

- **value** (`string`) - The icon name.

#### `RegexMap.options.result.withIndex(value)`
Sets the internal index for the result mapping.

- **value** (`integer`) - The index value.

#### `RegexMap.options.result.withText(value)`
Sets the display text for the result.

- **value** (`string`) - The text value.
```

--------------------------------

### ValueMap.withOptionsMixin

Source: https://grafana.github.io/grafonnet/API/panel/gauge/standardOptions/mapping

Applies options to ValueMap using a mixin pattern, allowing for flexible updates to value mappings.

```APIDOC
## ValueMap.withOptionsMixin

### Description
Applies options to ValueMap using a mixin pattern.

### Method
N/A (This appears to be a constructor or static method)

### Endpoint
N/A

### Parameters
#### Request Body
- **value** (object) - Required - An object containing value mappings to mix into the ValueMap (e.g., `{ "10": { text: "Perfection!", color: "green" } }`).
```

--------------------------------

### Create statusHistory Panel

Source: https://grafana.github.io/grafonnet/API/panel/statusHistory/index

Initializes a new statusHistory panel with a specified title. This is the fundamental step to creating a statusHistory panel instance.

```jsonnet
grafonnet.panel.statusHistory.new(title)
```

--------------------------------

### ValueMap API

Source: https://grafana.github.io/grafonnet/API/panel/table/standardOptions/mapping

The ValueMap API provides a basic mapping functionality, allowing configuration of options for value mapping.

```APIDOC
## ValueMap API

### Description
Provides a basic mapping functionality, allowing configuration of options for value mapping.

### Methods

#### `ValueMap.withOptions(value: object)`

Configures options for the ValueMap.

- **value** (`object`) - The options object.

#### `ValueMap.withOptionsMixin(value: object)`

Configures options for the ValueMap using a mixin.

- **value** (`object`) - The options object.

#### `ValueMap.withType()`

Sets the type of the mapping to ValueMap.
```

--------------------------------

### Configure Panel Links

Source: https://grafana.github.io/grafonnet/API/panel/trend/index

Adds or mixes in links for a panel. Accepts an array of link objects.

```json
panelOptions.withLinks(value)
```

```json
panelOptions.withLinksMixin(value)
```

--------------------------------

### Panel Options

Source: https://grafana.github.io/grafonnet/API/panel/table/index

Configure general options for a panel, including cell height and footer settings.

```APIDOC
## Panel Options

### Description
General options for panel configuration, such as setting the cell height and customizing the panel footer, including row count display and reducers.

### Method
N/A (This describes a configuration object, not an API endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Query Options

Source: https://grafana.github.io/grafonnet/API/panel/datagrid/index

Configure query-related settings for the Datagrid panel, including datasource, interval, data points, time settings, and transformations.

```APIDOC
## Query Options

### Description
Configure data source and query execution settings for the Datagrid panel.

#### `withDatasource(type: string, uid: string)`
- **type** (string) - Required - The type of the data source.
- **uid** (string) - Required - The unique identifier of the data source.

#### `withDatasourceMixin(value: any)`
- **value** (any) - Optional - Mixin for datasource configuration.

#### `withHideTimeOverride(value: boolean)`
- **value** (boolean) - Optional - Whether to hide time override. Defaults to true.

#### `withInterval(value: string)`
- **value** (string) - Optional - The interval for data queries.

#### `withMaxDataPoints(value: number)`
- **value** (number) - Optional - Maximum data points to fetch.

#### `withQueryCachingTTL(value: number)`
- **value** (number) - Optional - Time-to-live for query caching.

#### `withTargets(value: array)`
- **value** (array) - Optional - The data query targets.

#### `withTargetsMixin(value: array)`
- **value** (array) - Optional - Mixin for query targets.

#### `withTimeFrom(value: string)`
- **value** (string) - Optional - Start time for the query.

#### `withTimeShift(value: string)`
- **value** (string) - Optional - Time shift for the query.

#### `withTransformations(value: array)`
- **value** (array) - Optional - Transformations to apply to the query results.

#### `withTransformationsMixin(value: array)`
- **value** (array) - Optional - Mixin for transformations.

### Example
```python
grafonnet.panel.datagrid.new(title="My Datagrid")
  .queryOptions.withDatasource(type="prometheus", uid="my-prometheus-ds")
  .queryOptions.withTargets([
    {
      "expr": "up",
      "legendFormat": "{{job}}"
    }
  ])
  .queryOptions.withInterval("30s")
```
```
Tokens:
Raw