grafana/docs/sources/packages_api/data/registry.md

+++

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

Do not edit this file. It is automatically generated by API Documenter.

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

title = "Registry" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" +++

Registry class

Signature

export declare class Registry<T extends RegistryItem> 

Import

import { Registry } from '@grafana/data';

Constructors

Constructor	Modifiers	Description
constructor(init)		Constructs a new instance of the Registry class

Properties

Property	Modifiers	Type	Description
setInit		(init: () => T[]) => void

Methods

Method	Modifiers	Description
get(id)
getIfExists(id)
isEmpty()
list(ids)		Return a list of values by ID, or all values if not specified
register(ext)
selectOptions(current, filter)

constructor(init)

Constructs a new instance of the Registry class

Signature

constructor(init?: (() => T[]) | undefined);

Parameters

Parameter	Type	Description
init	(() => T[]) | undefined

setInit property

Signature

setInit: (init: () => T[]) => void;

get method

Signature

get(id: string): T;

Parameters

Parameter	Type	Description
id	string

Returns:

T

getIfExists method

Signature

getIfExists(id: string | undefined): T | undefined;

Parameters

Parameter	Type	Description
id	string | undefined

Returns:

T | undefined

isEmpty method

Signature

isEmpty(): boolean;

Returns:

boolean

list method

Return a list of values by ID, or all values if not specified

Signature

list(ids?: any[]): T[];

Parameters

Parameter	Type	Description
ids	any[]

Returns:

T[]

register method

Signature

register(ext: T): void;

Parameters

Parameter	Type	Description
ext	T

Returns:

void

selectOptions method

Signature

selectOptions(current?: string[], filter?: (ext: T) => boolean): RegistrySelectInfo;

Parameters

Parameter	Type	Description
current	string[]
filter	(ext: T) => boolean

Returns:

RegistrySelectInfo