The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
grafana/docs/sources/packages_api/ui/graphseriestoggler.md

2.2 KiB

+++

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

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

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

title = "GraphSeriesToggler" keywords = ["grafana","documentation","sdk","@grafana/ui"] type = "docs" +++

GraphSeriesToggler class

Signature

export declare class GraphSeriesToggler extends React.Component<GraphSeriesTogglerProps, GraphSeriesTogglerState> 

Import

import { GraphSeriesToggler } from '@grafana/ui';

Constructors

Constructor Modifiers Description
constructor(props) Constructs a new instance of the GraphSeriesToggler class

Methods

Method Modifiers Description
componentDidUpdate(prevProps)
onSeriesToggle(label, event)
render()

constructor(props)

Constructs a new instance of the GraphSeriesToggler class

Signature

constructor(props: GraphSeriesTogglerProps);

Parameters

Parameter Type Description
props GraphSeriesTogglerProps

componentDidUpdate method

Signature

componentDidUpdate(prevProps: Readonly<GraphSeriesTogglerProps>): void;

Parameters

Parameter Type Description
prevProps Readonly<GraphSeriesTogglerProps>

Returns:

void

onSeriesToggle method

Signature

onSeriesToggle(label: string, event: React.MouseEvent<HTMLElement>): void;

Parameters

Parameter Type Description
label string
event React.MouseEvent<HTMLElement>

Returns:

void

render method

Signature

render(): JSX.Element;

Returns:

JSX.Element