stz-util Documentation - v1.5.2
Preparing search index...
PieChartBuilder
Interface PieChartBuilder
interface
PieChartBuilder
{
build
(
id
?:
string
)
:
ChartConfig
;
getChartData
(
uid
:
string
)
:
object
;
hasPlugin
(
pluginId
:
string
)
:
boolean
;
highlightMaxSegment
(
offset
?:
number
)
:
this
;
highlightMinSegment
(
offset
?:
number
)
:
this
;
makeConfig
(
id
?:
string
)
:
ChartConfig
;
onResize
(
callback
:
(
chart
:
Chart
<
any
>
,
size
:
{
height
:
number
;
width
:
number
}
,
)
=>
void
,
)
:
this
;
removePlugin
(
pluginId
:
string
)
:
this
;
setAllBorderColor
(
borderColor
:
string
|
string
[]
)
:
this
;
setAllBorderWidth
(
borderWidth
:
number
)
:
this
;
setAllSegmentOffsets
(
offsets
:
number
|
number
[]
)
:
this
;
setBorderColor
(
datasetIndex
:
number
,
borderColor
:
string
|
string
[]
)
:
this
;
setBorderWidth
(
datasetIndex
:
number
,
borderWidth
:
number
)
:
this
;
setChartData
(
uid
:
string
,
data
:
any
)
:
void
;
setCircumference
(
circumference
:
number
)
:
this
;
setCutout
(
cutout
:
string
|
number
)
:
this
;
setGradientColors
(
startColor
:
string
,
endColor
:
string
)
:
this
;
setHalfPieBottom
()
:
this
;
setHalfPieLeft
()
:
this
;
setHalfPieRight
()
:
this
;
setHalfPieTop
()
:
this
;
setLegend
(
legendOptions
:
DeepPartial
<
LegendOptions
<
any
>
>
)
:
this
;
setPlugin
(
plugins
:
any
)
:
this
;
setRadius
(
radius
:
string
|
number
)
:
this
;
setRotation
(
rotation
:
number
)
:
this
;
setSegmentColors
(
colors
:
string
[]
)
:
this
;
setSegmentColorWhere
(
filterFn
:
(
value
:
number
,
index
:
number
)
=>
boolean
,
color
:
string
,
)
:
this
;
setSegmentOffset
(
dataIndex
:
number
,
offset
:
number
)
:
this
;
setTitle
(
titleOptions
:
CommonCartesianTitleConfig
)
:
this
;
}
Hierarchy (
View Summary
)
ArcChartBuilder
<
"pie"
>
PieChartBuilder
Implemented by
PieChartWrapper
Index
Methods
build
get
Chart
Data
has
Plugin
highlight
Max
Segment
highlight
Min
Segment
make
Config
on
Resize
remove
Plugin
set
All
Border
Color
set
All
Border
Width
set
All
Segment
Offsets
set
Border
Color
set
Border
Width
set
Chart
Data
set
Circumference
set
Cutout
set
Gradient
Colors
set
Half
Pie
Bottom
set
Half
Pie
Left
set
Half
Pie
Right
set
Half
Pie
Top
set
Legend
set
Plugin
set
Radius
set
Rotation
set
Segment
Colors
set
Segment
Color
Where
set
Segment
Offset
set
Title
Methods
build
build
(
id
?:
string
)
:
ChartConfig
Parameters
Optional
id
:
string
Returns
ChartConfig
get
Chart
Data
getChartData
(
uid
:
string
)
:
object
Parameters
uid
:
string
Returns
object
has
Plugin
hasPlugin
(
pluginId
:
string
)
:
boolean
Parameters
pluginId
:
string
Returns
boolean
highlight
Max
Segment
highlightMaxSegment
(
offset
?:
number
)
:
this
Parameters
Optional
offset
:
number
Returns
this
highlight
Min
Segment
highlightMinSegment
(
offset
?:
number
)
:
this
Parameters
Optional
offset
:
number
Returns
this
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
Color
setAllBorderColor
(
borderColor
:
string
|
string
[]
)
:
this
Parameters
borderColor
:
string
|
string
[]
Returns
this
set
All
Border
Width
setAllBorderWidth
(
borderWidth
:
number
)
:
this
Parameters
borderWidth
:
number
Returns
this
set
All
Segment
Offsets
setAllSegmentOffsets
(
offsets
:
number
|
number
[]
)
:
this
Parameters
offsets
:
number
|
number
[]
Returns
this
set
Border
Color
setBorderColor
(
datasetIndex
:
number
,
borderColor
:
string
|
string
[]
)
:
this
Parameters
datasetIndex
:
number
borderColor
:
string
|
string
[]
Returns
this
set
Border
Width
setBorderWidth
(
datasetIndex
:
number
,
borderWidth
:
number
)
:
this
Parameters
datasetIndex
:
number
borderWidth
:
number
Returns
this
set
Chart
Data
setChartData
(
uid
:
string
,
data
:
any
)
:
void
Parameters
uid
:
string
data
:
any
Returns
void
set
Circumference
setCircumference
(
circumference
:
number
)
:
this
Parameters
circumference
:
number
Returns
this
set
Cutout
setCutout
(
cutout
:
string
|
number
)
:
this
Parameters
cutout
:
string
|
number
Returns
this
set
Gradient
Colors
setGradientColors
(
startColor
:
string
,
endColor
:
string
)
:
this
Parameters
startColor
:
string
endColor
:
string
Returns
this
set
Half
Pie
Bottom
setHalfPieBottom
()
:
this
Returns
this
set
Half
Pie
Left
setHalfPieLeft
()
:
this
Returns
this
set
Half
Pie
Right
setHalfPieRight
()
:
this
Returns
this
set
Half
Pie
Top
setHalfPieTop
()
:
this
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
Radius
setRadius
(
radius
:
string
|
number
)
:
this
Parameters
radius
:
string
|
number
Returns
this
set
Rotation
setRotation
(
rotation
:
number
)
:
this
Parameters
rotation
:
number
Returns
this
set
Segment
Colors
setSegmentColors
(
colors
:
string
[]
)
:
this
Parameters
colors
:
string
[]
Returns
this
set
Segment
Color
Where
setSegmentColorWhere
(
filterFn
:
(
value
:
number
,
index
:
number
)
=>
boolean
,
color
:
string
,
)
:
this
Parameters
filterFn
:
(
value
:
number
,
index
:
number
)
=>
boolean
color
:
string
Returns
this
set
Segment
Offset
setSegmentOffset
(
dataIndex
:
number
,
offset
:
number
)
:
this
Parameters
dataIndex
:
number
offset
:
number
Returns
this
set
Title
setTitle
(
titleOptions
:
CommonCartesianTitleConfig
)
:
this
Parameters
titleOptions
:
CommonCartesianTitleConfig
Returns
this
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
build
get
Chart
Data
has
Plugin
highlight
Max
Segment
highlight
Min
Segment
make
Config
on
Resize
remove
Plugin
set
All
Border
Color
set
All
Border
Width
set
All
Segment
Offsets
set
Border
Color
set
Border
Width
set
Chart
Data
set
Circumference
set
Cutout
set
Gradient
Colors
set
Half
Pie
Bottom
set
Half
Pie
Left
set
Half
Pie
Right
set
Half
Pie
Top
set
Legend
set
Plugin
set
Radius
set
Rotation
set
Segment
Colors
set
Segment
Color
Where
set
Segment
Offset
set
Title
stz-util Documentation - v1.5.2
Loading...