API / geotoolkit / controls / shapes / DonutChart / DonutChart
shapes.DonutChart.DonutChart
Type Aliases
Ƭ Data: Object
data object
| Name | Type | Description |
|---|---|---|
mode? | DataMode | string | data mode |
order? | DataOrder | string | data order |
values? | AbstractDataSeries | Record<string, number> | number[] | string[] | string | number | boolean | Array of values or associative object |
Ƭ FormatLabel: (annotation: string | number, value?: number) => string
▸ (annotation, value?): string
label format function
| Name | Type |
|---|---|
annotation | string | number |
Optional value | number |
string
Ƭ Options: Object
params object
| Name | Type | Description |
|---|---|---|
autogradient? | boolean | autogradient flag |
createselectedstyle? | (src: FillStyle) => FillStyle | method to create selected style based on "regular" one (used when "selected_fillstyles" not set explicitly) |
depth3d? | number | height of a pseudo-3d chart |
direction? | Direction | slices' rendering direction |
fillstyles? | Type[] | fill styles OR colors, in css or rgb (the color order follow "data.order" parameter in "setData" call) |
inclination3d? | number | angle of the pseudo-3d chart. should be between 0 and 90 |
innerradius? | number | inner radius |
label? | { direction?: LabelDirection ; format?: FormatLabel ; hideifdontfit?: boolean ; ispointingup?: boolean ; location?: LabelLocation ; preserveaspectratio?: boolean ; preservereadingorientation?: boolean ; preserverightangle?: boolean ; text?: string ; textstyle?: Type } | labeling options object |
label.direction? | LabelDirection | label direction |
label.format? | FormatLabel | label formatting method |
label.hideifdontfit? | boolean | hide an inside label if it doesn't fit |
label.ispointingup? | boolean | - |
label.location? | LabelLocation | label location |
label.preserveaspectratio? | boolean | - |
label.preservereadingorientation? | boolean | - |
label.preserverightangle? | boolean | - |
label.text? | string | - |
label.textstyle? | Type | label text style |
linestyle? | Type | linestyle |
maxouterradius? | number | max outer radius |
maxslices? | number | maximum amount of slices the graph can have including an "other" slice. 0 for infinite |
minpercentage? | number | minimum percentage cutoff for a slice before it becomes part of "other". 0 for no limit |
modellimitsmode? | ModelLimitsMode | string | model limits mode |
outerradius? | number | outer radius |
outsideline? | { length?: number ; linestyle?: Type ; pad?: number } | outside line options object |
outsideline.length? | number | outside line length |
outsideline.linestyle? | Type | outside line style |
outsideline.pad? | number | outside line pad |
piemode? | PieMode | 2d- or 3d-representation |
selected-fillstyles? | Type[] | fill styles OR colors, in css or rgb (the color order follow "data.order" parameter in "setData" call) |
showpercentagesthreshold? | number | below this threshold (from 0 to 100) the percentage is not displayed |
sliceshift? | { offsets?: number[] } | slice shift options object |
sliceshift.offsets? | number[] | slices shift offsets. Index in the array to match the index of slice |
startangle? | number | starting angle of the first slice drawn, in degrees |
totalangle? | number | - |
Ƭ OptionsBaseOut: Object
| Name | Type | Description |
|---|---|---|
autogradient | boolean | autogradient flag |
createselectedstyle | (src: FillStyle) => FillStyle | method to create selected style based on "regular" one (used when "selected_fillstyles" not set explicitly) |
depth3d | number | height of a pseudo-3d chart |
direction | Direction | slices' rendering direction |
fillstyles | FillStyle[] | fill styles OR colors, in css or rgb (the color order follow "data.order" parameter in "setData" call) |
inclination3d | number | angle of the pseudo-3d chart. should be between 0 and 90 |
innerradius | number | inner radius |
label | { direction: LabelDirection ; format: FormatLabel ; hideifdontfit: boolean ; location: LabelLocation ; text?: string ; textstyle: TextStyle | null } | labeling options object |
label.direction | LabelDirection | label direction |
label.format | FormatLabel | label formatting method in form function myLabelFormat(annotation, value) {...} returning {string} value |
label.hideifdontfit | boolean | hide an inside label if it doesn't fit |
label.location | LabelLocation | label location |
label.text? | string | - |
label.textstyle | TextStyle | null | label text style |
linestyle | LineStyle | null | slice line style |
maxouterradius | number | max outer radius |
maxslices | number | maximum amount of slices the graph can have including an "other" slice. 0 for infinite |
minpercentage | number | minimum percentage cutoff for a slice before it becomes part of "other". 0 for no limit |
modellimitsmode | ModelLimitsMode | model limits mode |
outerradius | number | outer radius |
outsideline | { length: number ; linestyle: LineStyle | null ; pad: number } | outside line options object |
outsideline.length | number | outside line length |
outsideline.linestyle | LineStyle | null | outside line style |
outsideline.pad | number | outside line pad |
piemode | PieMode | 2d- or 3d-representation |
selected-fillstyles | FillStyle[] | fill styles OR colors, in css or rgb (the color order follow "data.order" parameter in "setData" call) |
showpercentagesthreshold | number | below this threshold (from 0 to 100) the percentage is not displayed |
sliceshift | { offsets: number[] } | slice shift options object |
sliceshift.offsets | number[] | slices shift offsets. Index in the array to match the index of slice |
startangle | number | starting angle of the first slice drawn, in degrees |
totalangle | number | - |
Ƭ OptionsOut: Merge<OptionsOut, OptionsBaseOut>
properties object
Ƭ SliceInfo: Object
returned slice object
| Name | Type | Description |
|---|---|---|
angledegend | number | end angle |
angledegstart | number | start angle |
color | Type | color |
label | string | label |
percentage | number | percentage |
value | number | value |