mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 07:22:17 +08:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
98 lines
2.2 KiB
Markdown
98 lines
2.2 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "GraphSeriesToggler"
|
|
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## GraphSeriesToggler class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare class GraphSeriesToggler extends React.Component<GraphSeriesTogglerProps, GraphSeriesTogglerState>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { GraphSeriesToggler } from '@grafana/ui';
|
|
```
|
|
<b>Constructors</b>
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [constructor(props)](#constructor-props) | | Constructs a new instance of the <code>GraphSeriesToggler</code> class |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [componentDidUpdate(prevProps)](#componentdidupdate-method) | | |
|
|
| [onSeriesToggle(label, event)](#onseriestoggle-method) | | |
|
|
| [render()](#render-method) | | |
|
|
|
|
### constructor(props)
|
|
|
|
Constructs a new instance of the `GraphSeriesToggler` class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
constructor(props: GraphSeriesTogglerProps);
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| props | <code>GraphSeriesTogglerProps</code> | |
|
|
|
|
### componentDidUpdate method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
componentDidUpdate(prevProps: Readonly<GraphSeriesTogglerProps>): void;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| prevProps | <code>Readonly<GraphSeriesTogglerProps></code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### onSeriesToggle method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onSeriesToggle(label: string, event: React.MouseEvent<HTMLElement>): void;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| label | <code>string</code> | |
|
|
| event | <code>React.MouseEvent<HTMLElement></code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### render method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
render(): JSX.Element;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`JSX.Element`
|
|
|