stz-util Documentation - v1.5.2
Preparing search index...
BubbleChartBuilder
Interface BubbleChartBuilder
interface
BubbleChartBuilder
{
addDataLabels
(
defultDataLabels
?:
boolean
,
dataLabelsOptions
?:
Partial
<
DataLabels
>
,
)
:
this
;
addZoom
(
defaultZoom
?:
boolean
,
zoomOption
?:
object
)
:
this
;
build
(
id
?:
string
)
:
ChartConfig
;
customLegend
(
obj
:
HtmlLegendOptions
)
:
this
;
getChartData
(
uid
:
string
)
:
object
;
hasPlugin
(
pluginId
:
string
)
:
boolean
;
makeConfig
(
id
?:
string
)
:
ChartConfig
;
onResize
(
callback
:
(
chart
:
Chart
<
any
>
,
size
:
{
height
:
number
;
width
:
number
}
,
)
=>
void
,
)
:
this
;
removePlugin
(
pluginId
:
string
)
:
this
;
setAllBorderWidth
(
borderWidth
:
number
)
:
this
;
setAllBubbleDataRadius
(
datasetIndex
:
number
,
radius
:
number
)
:
this
;
setAllBubbleRadius
(
radius
:
number
)
:
this
;
setAllDatasetsParsing
(
xAxisKey
:
string
|
false
,
yAxisKey
:
string
|
false
,
)
:
this
;
setAllHoverRadius
(
hoverRadius
:
number
)
:
this
;
setAllRotation
(
rotation
:
number
)
:
this
;
setAxisPosition
(
axis
:
string
,
position
:
"left"
|
"right"
)
:
this
;
setAxisRange
(
axis
:
"x"
|
"y"
,
min
?:
number
,
max
?:
number
)
:
this
;
setAxisTitle
(
axis
:
"x"
|
"y"
,
titleConfig
:
CommonCartesianTitleConfig
,
)
:
this
;
setBackgroundAlpha
(
alpha
:
number
)
:
this
;
setBackgroundColor
(
color
:
Color
)
:
this
;
setBorderWidth
(
datasetIndex
:
number
,
borderWidth
:
number
)
:
this
;
setBubbleDataRadius
(
datasetIndex
:
number
,
dataIndex
:
number
,
radius
:
number
,
)
:
this
;
setBubbleDataRadiusByName
(
datasetIndex
:
number
,
dataName
:
string
|
number
,
radius
:
number
,
)
:
this
;
setBubbleDataRadiusWhere
(
datasetIndex
:
number
,
filterFn
:
(
dataPoint
:
any
)
=>
boolean
,
radius
:
number
,
)
:
this
;
setBubbleRadius
(
datasetIndex
:
number
,
radius
:
number
)
:
this
;
setChartData
(
uid
:
string
,
data
:
any
)
:
void
;
setDatasetParsing
(
datasetIndex
:
number
,
xAxisKey
:
string
|
false
,
yAxisKey
:
string
|
false
,
)
:
this
;
setGrid
(
axis
:
string
,
gridOptions
:
GridLineOptions
)
:
this
;
setGridOptions
(
axis
:
"x"
|
"y"
,
gridOptions
:
{
color
?:
string
;
display
?:
boolean
;
lineWidth
?:
number
}
,
)
:
this
;
setHoverRadius
(
datasetIndex
:
number
,
hoverRadius
:
number
)
:
this
;
setLegend
(
legendOptions
:
DeepPartial
<
LegendOptions
<
any
>
>
)
:
this
;
setPadding
(
padding
:
any
)
:
this
;
setParsingKey
(
xAxisKey
:
string
|
false
,
yAxisKey
:
string
|
false
)
:
this
;
setPlugin
(
plugins
:
any
)
:
this
;
setRotation
(
datasetIndex
:
number
,
rotation
:
number
)
:
this
;
setScales
(
scales
:
CommonAxesSacels
)
:
this
;
setTitle
(
titleOptions
:
CommonCartesianTitleConfig
)
:
this
;
setYAxisForDataset
(
datasetIndex
:
number
,
axisId
?:
string
)
:
this
;
setYAxisID
(
datasetIndex
:
number
,
axisID
:
string
)
:
this
;
sparkBubbleChart
()
:
this
;
updateBubbleDataRadius
(
datasetIndex
:
number
,
updateFn
:
(
dataPoint
:
any
,
index
:
number
)
=>
number
,
)
:
this
;
}
Hierarchy (
View Summary
)
CartesianChartBuilder
<
"bubble"
>
BubbleChartBuilder
Implemented by
BubbleChartWrapper
Index
Methods
add
Data
Labels
add
Zoom
build
custom
Legend
get
Chart
Data
has
Plugin
make
Config
on
Resize
remove
Plugin
set
All
Border
Width
set
All
Bubble
Data
Radius
set
All
Bubble
Radius
set
All
Datasets
Parsing
set
All
Hover
Radius
set
All
Rotation
set
Axis
Position
set
Axis
Range
set
Axis
Title
set
Background
Alpha
set
Background
Color
set
Border
Width
set
Bubble
Data
Radius
set
Bubble
Data
Radius
By
Name
set
Bubble
Data
Radius
Where
set
Bubble
Radius
set
Chart
Data
set
Dataset
Parsing
set
Grid
set
Grid
Options
set
Hover
Radius
set
Legend
set
Padding
set
Parsing
Key
set
Plugin
set
Rotation
set
Scales
set
Title
set
Y
Axis
For
Dataset
set
Y
Axis
ID
spark
Bubble
Chart
update
Bubble
Data
Radius
Methods
add
Data
Labels
addDataLabels
(
defultDataLabels
?:
boolean
,
dataLabelsOptions
?:
Partial
<
DataLabels
>
,
)
:
this
Parameters
Optional
defultDataLabels
:
boolean
Optional
dataLabelsOptions
:
Partial
<
DataLabels
>
Returns
this
add
Zoom
addZoom
(
defaultZoom
?:
boolean
,
zoomOption
?:
object
)
:
this
Parameters
Optional
defaultZoom
:
boolean
Optional
zoomOption
:
object
Returns
this
build
build
(
id
?:
string
)
:
ChartConfig
Parameters
Optional
id
:
string
Returns
ChartConfig
custom
Legend
customLegend
(
obj
:
HtmlLegendOptions
)
:
this
Parameters
obj
:
HtmlLegendOptions
Returns
this
get
Chart
Data
getChartData
(
uid
:
string
)
:
object
Parameters
uid
:
string
Returns
object
has
Plugin
hasPlugin
(
pluginId
:
string
)
:
boolean
Parameters
pluginId
:
string
Returns
boolean
make
Config
makeConfig
(
id
?:
string
)
:
ChartConfig
Parameters
Optional
id
:
string
Returns
ChartConfig
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
Plugin
removePlugin
(
pluginId
:
string
)
:
this
Parameters
pluginId
:
string
Returns
this
set
All
Border
Width
setAllBorderWidth
(
borderWidth
:
number
)
:
this
Parameters
borderWidth
:
number
Returns
this
set
All
Bubble
Data
Radius
setAllBubbleDataRadius
(
datasetIndex
:
number
,
radius
:
number
)
:
this
Parameters
datasetIndex
:
number
radius
:
number
Returns
this
set
All
Bubble
Radius
setAllBubbleRadius
(
radius
:
number
)
:
this
Parameters
radius
:
number
Returns
this
set
All
Datasets
Parsing
setAllDatasetsParsing
(
xAxisKey
:
string
|
false
,
yAxisKey
:
string
|
false
)
:
this
Parameters
xAxisKey
:
string
|
false
yAxisKey
:
string
|
false
Returns
this
set
All
Hover
Radius
setAllHoverRadius
(
hoverRadius
:
number
)
:
this
Parameters
hoverRadius
:
number
Returns
this
set
All
Rotation
setAllRotation
(
rotation
:
number
)
:
this
Parameters
rotation
:
number
Returns
this
set
Axis
Position
setAxisPosition
(
axis
:
string
,
position
:
"left"
|
"right"
)
:
this
Parameters
axis
:
string
position
:
"left"
|
"right"
Returns
this
set
Axis
Range
setAxisRange
(
axis
:
"x"
|
"y"
,
min
?:
number
,
max
?:
number
)
:
this
Parameters
axis
:
"x"
|
"y"
Optional
min
:
number
Optional
max
:
number
Returns
this
set
Axis
Title
setAxisTitle
(
axis
:
"x"
|
"y"
,
titleConfig
:
CommonCartesianTitleConfig
)
:
this
Parameters
axis
:
"x"
|
"y"
titleConfig
:
CommonCartesianTitleConfig
Returns
this
set
Background
Alpha
setBackgroundAlpha
(
alpha
:
number
)
:
this
Parameters
alpha
:
number
Returns
this
set
Background
Color
setBackgroundColor
(
color
:
Color
)
:
this
Parameters
color
:
Color
Returns
this
set
Border
Width
setBorderWidth
(
datasetIndex
:
number
,
borderWidth
:
number
)
:
this
Parameters
datasetIndex
:
number
borderWidth
:
number
Returns
this
set
Bubble
Data
Radius
setBubbleDataRadius
(
datasetIndex
:
number
,
dataIndex
:
number
,
radius
:
number
,
)
:
this
Parameters
datasetIndex
:
number
dataIndex
:
number
radius
:
number
Returns
this
set
Bubble
Data
Radius
By
Name
setBubbleDataRadiusByName
(
datasetIndex
:
number
,
dataName
:
string
|
number
,
radius
:
number
,
)
:
this
Parameters
datasetIndex
:
number
dataName
:
string
|
number
radius
:
number
Returns
this
set
Bubble
Data
Radius
Where
setBubbleDataRadiusWhere
(
datasetIndex
:
number
,
filterFn
:
(
dataPoint
:
any
)
=>
boolean
,
radius
:
number
,
)
:
this
Parameters
datasetIndex
:
number
filterFn
:
(
dataPoint
:
any
)
=>
boolean
radius
:
number
Returns
this
set
Bubble
Radius
setBubbleRadius
(
datasetIndex
:
number
,
radius
:
number
)
:
this
Parameters
datasetIndex
:
number
radius
:
number
Returns
this
set
Chart
Data
setChartData
(
uid
:
string
,
data
:
any
)
:
void
Parameters
uid
:
string
data
:
any
Returns
void
set
Dataset
Parsing
setDatasetParsing
(
datasetIndex
:
number
,
xAxisKey
:
string
|
false
,
yAxisKey
:
string
|
false
,
)
:
this
Parameters
datasetIndex
:
number
xAxisKey
:
string
|
false
yAxisKey
:
string
|
false
Returns
this
set
Grid
setGrid
(
axis
:
string
,
gridOptions
:
GridLineOptions
)
:
this
Parameters
axis
:
string
gridOptions
:
GridLineOptions
Returns
this
set
Grid
Options
setGridOptions
(
axis
:
"x"
|
"y"
,
gridOptions
:
{
color
?:
string
;
display
?:
boolean
;
lineWidth
?:
number
}
,
)
:
this
Parameters
axis
:
"x"
|
"y"
gridOptions
:
{
color
?:
string
;
display
?:
boolean
;
lineWidth
?:
number
}
Returns
this
set
Hover
Radius
setHoverRadius
(
datasetIndex
:
number
,
hoverRadius
:
number
)
:
this
Parameters
datasetIndex
:
number
hoverRadius
:
number
Returns
this
set
Legend
setLegend
(
legendOptions
:
DeepPartial
<
LegendOptions
<
any
>
>
)
:
this
Parameters
legendOptions
:
DeepPartial
<
LegendOptions
<
any
>
>
Returns
this
set
Padding
setPadding
(
padding
:
any
)
:
this
Parameters
padding
:
any
Returns
this
set
Parsing
Key
setParsingKey
(
xAxisKey
:
string
|
false
,
yAxisKey
:
string
|
false
)
:
this
Parameters
xAxisKey
:
string
|
false
yAxisKey
:
string
|
false
Returns
this
set
Plugin
setPlugin
(
plugins
:
any
)
:
this
Parameters
plugins
:
any
Returns
this
set
Rotation
setRotation
(
datasetIndex
:
number
,
rotation
:
number
)
:
this
Parameters
datasetIndex
:
number
rotation
:
number
Returns
this
set
Scales
setScales
(
scales
:
CommonAxesSacels
)
:
this
Parameters
scales
:
CommonAxesSacels
Returns
this
set
Title
setTitle
(
titleOptions
:
CommonCartesianTitleConfig
)
:
this
Parameters
titleOptions
:
CommonCartesianTitleConfig
Returns
this
set
Y
Axis
For
Dataset
setYAxisForDataset
(
datasetIndex
:
number
,
axisId
?:
string
)
:
this
Parameters
datasetIndex
:
number
Optional
axisId
:
string
Returns
this
set
Y
Axis
ID
setYAxisID
(
datasetIndex
:
number
,
axisID
:
string
)
:
this
Parameters
datasetIndex
:
number
axisID
:
string
Returns
this
spark
Bubble
Chart
sparkBubbleChart
()
:
this
Returns
this
update
Bubble
Data
Radius
updateBubbleDataRadius
(
datasetIndex
:
number
,
updateFn
:
(
dataPoint
:
any
,
index
:
number
)
=>
number
,
)
:
this
Parameters
datasetIndex
:
number
updateFn
:
(
dataPoint
:
any
,
index
:
number
)
=>
number
Returns
this
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
add
Data
Labels
add
Zoom
build
custom
Legend
get
Chart
Data
has
Plugin
make
Config
on
Resize
remove
Plugin
set
All
Border
Width
set
All
Bubble
Data
Radius
set
All
Bubble
Radius
set
All
Datasets
Parsing
set
All
Hover
Radius
set
All
Rotation
set
Axis
Position
set
Axis
Range
set
Axis
Title
set
Background
Alpha
set
Background
Color
set
Border
Width
set
Bubble
Data
Radius
set
Bubble
Data
Radius
By
Name
set
Bubble
Data
Radius
Where
set
Bubble
Radius
set
Chart
Data
set
Dataset
Parsing
set
Grid
set
Grid
Options
set
Hover
Radius
set
Legend
set
Padding
set
Parsing
Key
set
Plugin
set
Rotation
set
Scales
set
Title
set
Y
Axis
For
Dataset
set
Y
Axis
ID
spark
Bubble
Chart
update
Bubble
Data
Radius
stz-util Documentation - v1.5.2
Loading...