IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2026-07-30 08:18:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

grafana-data: improved field-config docs (#67696)

Browse Source
This commit is contained in:
Gábor Farkas
2023-05-03 08:34:29 +00:00
committed by GitHub
parent 21d28c1cb5
commit b10d415569
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/grafana-data/src/types/dataFrame.ts
+4 -2
View File
@@ -29,12 +29,14 @@ export enum FieldType {
*/
export interface FieldConfig<TOptions = any> {
/**
* The display value for this field. This supports template variables blank is auto
* The display value for this field. This supports template variables blank is auto.
* If you are a datasource plugin, do not set this. Use `field.value` and if that
* is not enough, use `field.config.displayNameFromDS`.
*/
displayName?: string;
/**
* This can be used by data sources that return and explicit naming structure for values and labels
* This can be used by data sources that need to customize how values are named.
* When this property is configured, this value is used rather than the default naming strategy.
*/
displayNameFromDS?: string;