grafana/docs/sources/packages_api/ui/graphseriestoggler.md
Marcus Andersson cc3fc18076
Docs: enable packages reference docs for 7-beta (#23953)
* added packages reference menu item.

* removed the draft flag.

* Updated docs by running script.
2020-04-28 09:53:58 +02:00

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