Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/uibreadcrumb arrow RefreshPicker
Enterprise Open source

RefreshPicker class

Signature

typescript 
export declare class RefreshPicker extends PureComponent<Props>

Import

typescript 
import { RefreshPicker } from '@grafana/ui';

Constructors

ConstructorModifiersDescription
constructor(props)Constructs a new instance of the RefreshPicker class

Properties

PropertyModifiersTypeDescription
isLivestatic(refreshInterval?: string | undefined) => boolean
liveOptionstatic{
label: string;
value: string;
ariaLabel: string;
}
offOptionstatic{
label: string;
value: string;
ariaLabel: string;
}
onChangeSelect(item: SelectableValue<string>) => void

Methods

MethodModifiersDescription
getVariant()
render()

constructor(props)

Constructs a new instance of the RefreshPicker class

Signature

typescript 
constructor(props: Props);

Parameters

ParameterTypeDescription
propsProps

isLive property

Signature

typescript 
static isLive: (refreshInterval?: string | undefined) => boolean;

liveOption property

Signature

typescript 
static liveOption: {
        label: string;
        value: string;
        ariaLabel: string;
    };

offOption property

Signature

typescript 
static offOption: {
        label: string;
        value: string;
        ariaLabel: string;
    };

onChangeSelect property

Signature

typescript 
onChangeSelect: (item: SelectableValue<string>) => void;

getVariant method

Signature

typescript 
getVariant(): ToolbarButtonVariant;

Returns:

ToolbarButtonVariant

render method

Signature

typescript 
render(): JSX.Element;

Returns:

JSX.Element