mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
51 lines
2.1 KiB
TypeScript
51 lines
2.1 KiB
TypeScript
import { VariableOption, UserProps, OrgProps, DashboardProps } from '@grafana/data';
|
|
import { TemplateSrv } from 'app/features/templating/template_srv';
|
|
|
|
/**
|
|
* @remarks
|
|
* Takes a string array of variables and non-variables and returns a string array with the raw values of the variable(s)
|
|
* A few examples:
|
|
* single-valued variable + non-variable item. ['$singleValuedVariable', 'log-group'] => ['value', 'log-group']
|
|
* multi-valued variable + non-variable item. ['$multiValuedVariable', 'log-group'] => ['value1', 'value2', 'log-group']
|
|
* @param templateSrv - The template service
|
|
* @param strings - The array of strings to interpolate. May contain variables and non-variables.
|
|
* @param key - Allows you to specify whether the variable MetricFindValue.text or MetricFindValue.value should be used when interpolating the variable. Optional, defaults to 'value'.
|
|
**/
|
|
export const interpolateStringArrayUsingSingleOrMultiValuedVariable = (
|
|
templateSrv: TemplateSrv,
|
|
strings: string[],
|
|
key?: 'value' | 'text'
|
|
) => {
|
|
key = key ?? 'value';
|
|
let result: string[] = [];
|
|
for (const string of strings) {
|
|
const variableName = templateSrv.getVariableName(string);
|
|
const valueVar = templateSrv.getVariables().find(({ name }) => name === variableName);
|
|
|
|
if (valueVar && 'current' in valueVar && isVariableOption(valueVar.current)) {
|
|
const rawValue = valueVar.current[key];
|
|
if (Array.isArray(rawValue)) {
|
|
result = [...result, ...rawValue];
|
|
} else if (typeof rawValue === 'string') {
|
|
result.push(rawValue);
|
|
}
|
|
} else {
|
|
// if it's not a variable, just add the raw value
|
|
result.push(string);
|
|
}
|
|
}
|
|
|
|
return result;
|
|
};
|
|
|
|
export const isTemplateVariable = (templateSrv: TemplateSrv, string: string) => {
|
|
const variableName = templateSrv.getVariableName(string);
|
|
return templateSrv.getVariables().some(({ name }) => name === variableName);
|
|
};
|
|
|
|
const isVariableOption = (
|
|
current: VariableOption | { value: UserProps } | { value: OrgProps } | { value: DashboardProps }
|
|
): current is VariableOption => {
|
|
return current.hasOwnProperty('value') && current.hasOwnProperty('text');
|
|
};
|