VariableModel🔗
A variable is a placeholder for a value. You can use variables in metric queries and in panel titles.
Definition🔗
class VariableModel implements \JsonSerializable
{
/**
* Type of variable
*/
public \Grafana\Foundation\Dashboard\VariableType $type;
/**
* Name of variable
*/
public string $name;
/**
* Optional display name
*/
public ?string $label;
/**
* Visibility configuration for the variable
*/
public ?\Grafana\Foundation\Dashboard\VariableHide $hide;
/**
* Whether the variable value should be managed by URL query params or not
*/
public ?bool $skipUrlSync;
/**
* Description of variable. It can be defined but `null`.
*/
public ?string $description;
/**
* Query used to fetch values for a variable
* @var string|array<string, mixed>|null
*/
public $query;
/**
* Data source used to fetch values for a variable. It can be defined but `null`.
*/
public ?\Grafana\Foundation\Dashboard\DataSourceRef $datasource;
/**
* Shows current selected variable text/value on the dashboard
*/
public ?\Grafana\Foundation\Dashboard\VariableOption $current;
/**
* Whether multiple values can be selected or not from variable value list
*/
public ?bool $multi;
/**
* Options that can be selected for a variable.
* @var array<\Grafana\Foundation\Dashboard\VariableOption>|null
*/
public ?array $options;
/**
* Options to config when to refresh a variable
*/
public ?\Grafana\Foundation\Dashboard\VariableRefresh $refresh;
/**
* Options sort order
*/
public ?\Grafana\Foundation\Dashboard\VariableSort $sort;
/**
* Whether all value option is available or not
*/
public ?bool $includeAll;
/**
* Custom all value
*/
public ?string $allValue;
/**
* Optional field, if you want to extract part of a series name or metric node segment.
* Named capture groups can be used to separate the display text and value.
*/
public ?string $regex;
}
Methods🔗
fromArray🔗
Builds this object from an array.
This function is meant to be used with the return value of json_decode($json, true).
jsonSerialize🔗
Returns the data representing this object, preparing it for JSON serialization with json_encode().