@grafana/ui - UPlotConfigBuilder - 《Grafana v9.1 Documentation》

UPlotConfigBuilder class

UPlotConfigBuilder class

Signature

export declare class UPlotConfigBuilder

Import

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

Constructors

Constructor	Modifiers	Description
constructor(timeZone)		Constructs a new instance of the `UPlotConfigBuilder` class

Properties

Property	Modifiers	Type	Description
prepData		`PrepData \| undefined`
scaleKeys		`[string, string]`

Methods

Method	Modifiers	Description
addAxis(props)
addBand(band)
addHook(type, hook)
addScale(props)		Add or update the scale with the scale key
addSeries(props)
addThresholds(options)
getAxisPlacement(scaleKey)
getConfig()
getSeries()
getStackingGroups()
getTooltipInterpolator()
hasSync()
setCursor(cursor)
setMode(mode)
setPadding(padding)
setPrepData(prepData)
setSelect(select)
setStackingGroups(groups)
setSync()
setTooltipInterpolator(interpolator)

constructor(timeZone)

Constructs a new instance of the UPlotConfigBuilder class

Signature

constructor(timeZone?: TimeZone);

Parameters

Parameter	Type	Description
timeZone	`TimeZone`

prepData property

Signature

prepData: PrepData | undefined;

scaleKeys property

Signature

scaleKeys: [string, string];

addAxis method

Signature

addAxis(props: AxisProps): void;

Parameters

Parameter	Type	Description
props	`AxisProps`

Returns:

void

addBand method

Signature

addBand(band: Band): void;

Parameters

Parameter	Type	Description
band	`Band`

Returns:

void

addHook method

Signature

addHook<T extends keyof Hooks.Defs>(type: T, hook: Hooks.Defs[T]): void;

Parameters

Parameter	Type	Description
type	`T`
hook	`Hooks.Defs[T]`

Returns:

void

addScale method

Add or update the scale with the scale key

Signature

addScale(props: ScaleProps): void;

Parameters

Parameter	Type	Description
props	`ScaleProps`

Returns:

void

addSeries method

Signature

addSeries(props: SeriesProps): void;

Parameters

Parameter	Type	Description
props	`SeriesProps`

Returns:

void

addThresholds method

Signature

addThresholds(options: UPlotThresholdOptions): void;

Parameters

Parameter	Type	Description
options	`UPlotThresholdOptions`

Returns:

void

getAxisPlacement method

Signature

getAxisPlacement(scaleKey: string): AxisPlacement;

Parameters

Parameter	Type	Description
scaleKey	`string`

Returns:

AxisPlacement

getConfig method

Signature

getConfig(): PlotConfig;

Returns:

PlotConfig

getSeries method

Signature

getSeries(): UPlotSeriesBuilder[];

Returns:

UPlotSeriesBuilder[]

getStackingGroups method

Signature

getStackingGroups(): StackingGroup[];

Returns:

StackingGroup[]

getTooltipInterpolator method

Signature

getTooltipInterpolator(): PlotTooltipInterpolator | undefined;

Returns:

PlotTooltipInterpolator | undefined

hasSync method

Signature

hasSync(): boolean;

Returns:

boolean

setCursor method

Signature

setCursor(cursor?: Cursor): void;

Parameters

Parameter	Type	Description
cursor	`Cursor`

Returns:

void

setMode method

Signature

setMode(mode: uPlot.Mode): void;

Parameters

Parameter	Type	Description
mode	`uPlot.Mode`

Returns:

void

setPadding method

Signature

setPadding(padding: Padding): void;

Parameters

Parameter	Type	Description
padding	`Padding`

Returns:

void

setPrepData method

Signature

setPrepData(prepData: PreDataStacked): void;

Parameters

Parameter	Type	Description
prepData	`PreDataStacked`

Returns:

void

setSelect method

Signature

setSelect(select: Select): void;

Parameters

Parameter	Type	Description
select	`Select`

Returns:

void

setStackingGroups method

Signature

setStackingGroups(groups: StackingGroup[]): void;

Parameters

Parameter	Type	Description
groups	`StackingGroup[]`

Returns:

void

setSync method

Signature

setSync(): void;

Returns:

void

setTooltipInterpolator method

Signature

setTooltipInterpolator(interpolator: PlotTooltipInterpolator): void;

Parameters

Parameter	Type	Description
interpolator	`PlotTooltipInterpolator`

Returns:

void