stz-chart-maker Documentation - v2.3.7
Preparing search index...
ChartBuilder
Interface ChartBuilder<TType>
interface
ChartBuilder
<
TType
extends
ChartType
>
{
build
(
id
?:
string
)
:
ChartConfig
;
clearData
(
datasetUidOrIndex
?:
string
|
number
)
:
this
;
clone
()
:
this
;
copy
()
:
this
;
getChartData
(
uid
:
string
)
:
CustomChartDatasets
<
TType
>
;
hasPlugin
(
pluginId
:
string
)
:
boolean
;
makeConfig
(
id
?:
string
)
:
ChartConfig
;
mergeOptions
(
options
:
DeepPartial
<
CustomChartOptions
<
TType
>
>
)
:
this
;
onResize
(
callback
:
(
chart
:
Chart
<
any
>
,
size
:
{
height
:
number
;
width
:
number
}
,
)
=>
void
,
)
:
this
;
removeData
(
datasetUidOrIndex
:
string
|
number
,
dataUidOrIndex
?:
string
|
number
,
)
:
this
;
removeDataset
(
uidOrIndex
:
string
|
number
)
:
this
;
removePlugin
(
pluginId
:
string
)
:
this
;
setAllDatasetStyle
(
style
:
DeepPartial
<
CustomChartDatasets
<
TType
>
>
)
:
this
;
setChartData
(
uid
:
string
,
data
:
CustomChartDatasets
<
TType
>
)
:
void
;
setDatasetGroup
(
uidOrIndex
:
string
|
number
,
group
:
string
|
number
)
:
this
;
setDatasetStyle
(
uidOrIndex
:
string
|
number
,
style
:
DeepPartial
<
CustomChartDatasets
<
TType
>
>
,
)
:
this
;
setDatasetVisible
(
uidOrIndex
:
string
|
number
,
visible
:
boolean
,
syncGroup
?:
boolean
,
)
:
this
;
setLegend
(
legendOptions
:
DeepPartial
<
LegendOptions
<
any
>
>
)
:
this
;
setPlugin
(
plugins
:
any
)
:
this
;
setSpinnerOverlay
(
spinnerOverlay
:
SpinnerOverlayOption
)
:
this
;
setTitle
(
titleOptions
:
CommonCartesianTitleConfig
)
:
this
;
setTooltip
(
tooltipOptions
:
DeepPartial
<
TooltipOptions
<
any
>
>
)
:
this
;
toggleDataset
(
uidOrIndex
:
string
|
number
,
syncGroup
?:
boolean
)
:
this
;
}
Type Parameters
TType
extends
ChartType
Hierarchy (
View Summary
)
ChartBuilder
CartesianChartBuilder
ArcChartBuilder
RadarChartBuilder
TreemapChartBuilder
Implemented by
Chart
Index
Methods
build
clear
Data
clone
copy
get
Chart
Data
has
Plugin
make
Config
merge
Options
on
Resize
remove
Data
remove
Dataset
remove
Plugin
set
All
Dataset
Style
set
Chart
Data
set
Dataset
Group
set
Dataset
Style
set
Dataset
Visible
set
Legend
set
Plugin
set
Spinner
Overlay
set
Title
set
Tooltip
toggle
Dataset
Methods
build
build
(
id
?:
string
)
:
ChartConfig
Parameters
Optional
id
:
string
Returns
ChartConfig
clear
Data
clearData
(
datasetUidOrIndex
?:
string
|
number
)
:
this
Parameters
Optional
datasetUidOrIndex
:
string
|
number
Returns
this
clone
clone
()
:
this
Returns
this
copy
copy
()
:
this
Returns
this
get
Chart
Data
getChartData
(
uid
:
string
)
:
CustomChartDatasets
<
TType
>
Parameters
uid
:
string
Returns
CustomChartDatasets
<
TType
>
has
Plugin
hasPlugin
(
pluginId
:
string
)
:
boolean
Parameters
pluginId
:
string
Returns
boolean
make
Config
makeConfig
(
id
?:
string
)
:
ChartConfig
Parameters
Optional
id
:
string
Returns
ChartConfig
merge
Options
mergeOptions
(
options
:
DeepPartial
<
CustomChartOptions
<
TType
>
>
)
:
this
Parameters
options
:
DeepPartial
<
CustomChartOptions
<
TType
>
>
Returns
this
on
Resize
onResize
(
callback
:
(
chart
:
Chart
<
any
>
,
size
:
{
height
:
number
;
width
:
number
}
,
)
=>
void
,
)
:
this
Parameters
callback
:
(
chart
:
Chart
<
any
>
,
size
:
{
height
:
number
;
width
:
number
}
)
=>
void
Returns
this
remove
Data
removeData
(
datasetUidOrIndex
:
string
|
number
,
dataUidOrIndex
?:
string
|
number
,
)
:
this
Parameters
datasetUidOrIndex
:
string
|
number
Optional
dataUidOrIndex
:
string
|
number
Returns
this
remove
Dataset
removeDataset
(
uidOrIndex
:
string
|
number
)
:
this
Parameters
uidOrIndex
:
string
|
number
Returns
this
remove
Plugin
removePlugin
(
pluginId
:
string
)
:
this
Parameters
pluginId
:
string
Returns
this
set
All
Dataset
Style
setAllDatasetStyle
(
style
:
DeepPartial
<
CustomChartDatasets
<
TType
>
>
)
:
this
Parameters
style
:
DeepPartial
<
CustomChartDatasets
<
TType
>
>
Returns
this
set
Chart
Data
setChartData
(
uid
:
string
,
data
:
CustomChartDatasets
<
TType
>
)
:
void
Parameters
uid
:
string
data
:
CustomChartDatasets
<
TType
>
Returns
void
set
Dataset
Group
setDatasetGroup
(
uidOrIndex
:
string
|
number
,
group
:
string
|
number
)
:
this
Parameters
uidOrIndex
:
string
|
number
group
:
string
|
number
Returns
this
set
Dataset
Style
setDatasetStyle
(
uidOrIndex
:
string
|
number
,
style
:
DeepPartial
<
CustomChartDatasets
<
TType
>
>
,
)
:
this
Parameters
uidOrIndex
:
string
|
number
style
:
DeepPartial
<
CustomChartDatasets
<
TType
>
>
Returns
this
set
Dataset
Visible
setDatasetVisible
(
uidOrIndex
:
string
|
number
,
visible
:
boolean
,
syncGroup
?:
boolean
,
)
:
this
Parameters
uidOrIndex
:
string
|
number
visible
:
boolean
Optional
syncGroup
:
boolean
Returns
this
set
Legend
setLegend
(
legendOptions
:
DeepPartial
<
LegendOptions
<
any
>
>
)
:
this
Parameters
legendOptions
:
DeepPartial
<
LegendOptions
<
any
>
>
Returns
this
set
Plugin
setPlugin
(
plugins
:
any
)
:
this
Parameters
plugins
:
any
Returns
this
set
Spinner
Overlay
setSpinnerOverlay
(
spinnerOverlay
:
SpinnerOverlayOption
)
:
this
Parameters
spinnerOverlay
:
SpinnerOverlayOption
Returns
this
set
Title
setTitle
(
titleOptions
:
CommonCartesianTitleConfig
)
:
this
Parameters
titleOptions
:
CommonCartesianTitleConfig
Returns
this
set
Tooltip
setTooltip
(
tooltipOptions
:
DeepPartial
<
TooltipOptions
<
any
>
>
)
:
this
Parameters
tooltipOptions
:
DeepPartial
<
TooltipOptions
<
any
>
>
Returns
this
toggle
Dataset
toggleDataset
(
uidOrIndex
:
string
|
number
,
syncGroup
?:
boolean
)
:
this
Parameters
uidOrIndex
:
string
|
number
Optional
syncGroup
:
boolean
Returns
this
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
build
clear
Data
clone
copy
get
Chart
Data
has
Plugin
make
Config
merge
Options
on
Resize
remove
Data
remove
Dataset
remove
Plugin
set
All
Dataset
Style
set
Chart
Data
set
Dataset
Group
set
Dataset
Style
set
Dataset
Visible
set
Legend
set
Plugin
set
Spinner
Overlay
set
Title
set
Tooltip
toggle
Dataset
stz-chart-maker Documentation - v2.3.7
Loading...