mirror of
https://github.com/grafana/grafana.git
synced 2025-07-28 11:22:20 +08:00

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
66 lines
1.7 KiB
Markdown
66 lines
1.7 KiB
Markdown
---
|
|
description: A reference for the JSON library panel schema used with Observability as Code.
|
|
keywords:
|
|
- configuration
|
|
- as code
|
|
- as-code
|
|
- dashboards
|
|
- git integration
|
|
- git sync
|
|
- github
|
|
- library panel
|
|
labels:
|
|
products:
|
|
- cloud
|
|
- enterprise
|
|
- oss
|
|
menuTitle: LibraryPanelKind schema
|
|
title: LibraryPanelKind
|
|
weight: 300
|
|
---
|
|
|
|
# `LibraryPanelKind`
|
|
|
|
A library panel is a reusable panel that you can use in any dashboard.
|
|
When you make a change to a library panel, that change propagates to all instances of where the panel is used.
|
|
Library panels streamline reuse of panels across multiple dashboards.
|
|
|
|
Following is the default library panel element JSON:
|
|
|
|
```json
|
|
"kind": "LibraryPanel",
|
|
"spec": {
|
|
"id": 0,
|
|
"libraryPanel": {
|
|
name: "",
|
|
uid: "",
|
|
}
|
|
"title": ""
|
|
}
|
|
```
|
|
|
|
The `LibraryPanelKind` consists of:
|
|
|
|
- kind: "LibraryPanel"
|
|
- spec: [LibraryPanelKindSpec](#librarypanelkindspec)
|
|
- libraryPanel: [LibraryPanelRef](#librarypanelref)
|
|
|
|
## `LibraryPanelKindSpec`
|
|
|
|
The following table explains the usage of the library panel element JSON fields:
|
|
|
|
| Name | Usage |
|
|
| ------------ | ------------------------------------------------ |
|
|
| id | Panel ID for the library panel in the dashboard. |
|
|
| libraryPanel | [`LibraryPanelRef`](#librarypanelref) |
|
|
| title | Title for the library panel in the dashboard. |
|
|
|
|
### `LibraryPanelRef`
|
|
|
|
The following table explains the usage of the library panel reference JSON fields:
|
|
|
|
| Name | Usage |
|
|
| ---- | ------------------ |
|
|
| name | Library panel name |
|
|
| uid | Library panel uid |
|