API / geotoolkit / controls / shapes / BarChart / BarChart
Type Aliases
Type Aliases
Ƭ BarStylesTypes: Object
| Name | Type |
|---|---|
fillstyles? | Type | Type[] |
label? | string |
linestyles? | Type | Type[] |
selected-fillstyles? | FillStyle | FillStyle[] |
selected-linestyles? | LineStyle | LineStyle[] |
Ƭ BarValues: Object
| Name | Type | Description |
|---|---|---|
decimalprecision? | number | bar values decimal precision |
location? | BarValueLocation | bar values' label location |
margins? | { anchorx?: number ; anchory?: number } | margins options |
margins.anchorx? | number | labels anchor x margin in pixels. This value will be added to anchor before text rotation |
margins.anchory? | number | labels anchor y margin in pixels. This value will be added to anchor before text rotation |
rotationangle? | number | bar value labels rotation |
textstyle? | Type | bar value text style |
totalonly? | boolean | to only show total bar values for stacked bar mode |
visible? | boolean | boolean[] | boolean[][] | IsVisibleValue | bar values visibility flag, supports individual bar value visibility flag if value visible is a function, it'll be in this format: function (groupIndex, barIndex, value, valueType, textWidth, textHeight, orientation) and return a boolean |
Ƭ CreateSelectedStyle: (s: LineStyle | FillStyle) => LineStyle | FillStyle
Ƭ Data: Object
data object
| Name | Type | Description |
|---|---|---|
append? | boolean | append/replace flag |
datasets? | DataSeries[] | Array of Values for non-float and Array of Array(2) Values for float charts |
mode? | DataMode | Data mode for the barchart |
positions? | number[] | NumericalDataSeries | Array of data determines bars positions |
series? | { visible?: boolean }[] | Visibility of series |
Ƭ DataSeries: Object
| Name | Type |
|---|---|
values? | number[] | number[][] |
Ƭ FormatLabelHandler: (text: string, groupId?: number, id?: number, value?: number) => string | number
▸ (text, groupId?, id?, value?): string | number
| Name | Type |
|---|---|
text | string |
Optional groupId | number |
Optional id | number |
Optional value | number |
string | number
Ƭ IsMissingValue: (v: number | number[]) => boolean
▸ (v): boolean
| Name | Type |
|---|---|
v | number | number[] |
boolean
Ƭ IsVisibleValue: (iReadout: number, iProperty: number, value: number, valueType: string, textWidth: number, textHeight: number, barWidth: number, barHeight: number, orientation: Orientation) => boolean
▸ (iReadout, iProperty, value, valueType, textWidth, textHeight, barWidth, barHeight, orientation): boolean
| Name | Type |
|---|---|
iReadout | number |
iProperty | number |
value | number |
valueType | string |
textWidth | number |
textHeight | number |
barWidth | number |
barHeight | number |
orientation | Orientation |
boolean
Ƭ Options: Options & { autogradient?: boolean ; barmaxwidth?: number ; barmode?: BarMode ; barpad?: number ; barstyles?: BarStylesTypes[] ; barvalues?: BarValues ; barwidth?: number ; createselectedstyle?: CreateSelectedStyle ; ismissingvalue?: IsMissingValue ; neatlimits?: boolean ; orientation?: Orientation ; positionlimits?: { maxvalue?: number ; minvalue?: number } ; series?: { visible?: boolean }[] ; symbol?: Options ; valuelimits?: { maxvalue?: number | ValueCallback ; minvalue?: number | ValueCallback } }
Ƭ OptionsBase: Object
options object
| Name | Type | Description |
|---|---|---|
autogradient? | boolean | enables auto gradient of the bars |
barmaxwidth? | number | maximum width of bar in device space |
barmode? | BarMode | Bar display mode of the chart |
barpad? | number | padding between the datasets |
barstyles? | BarStylesTypes[] | array of barstyles (see example below) |
barvalues? | BarValues | bar values parameters |
barwidth? | number | width of the bars |
createselectedstyle? | CreateSelectedStyle | method to create selected style based on "regular" one |
ismissingvalue? | IsMissingValue | missing value verification criteria; default is function(value){ return (value===null); } |
neatlimits? | boolean | use neatlimits flag |
orientation? | Orientation | orientation of the chart |
positionlimits? | { maxvalue?: number ; minvalue?: number } | value limits for bars positions data |
positionlimits.maxvalue? | number | max value to for bars positions data |
positionlimits.minvalue? | number | min value to for bars positions data |
series? | { visible?: boolean }[] | Enable/disable specific bar chart series |
symbol? | Options | Options for symbols on top of each bar |
valuelimits? | { maxvalue?: number | ValueCallback ; minvalue?: number | ValueCallback } | value limits parameters |
valuelimits.maxvalue? | number | ValueCallback | max value to set |
valuelimits.minvalue? | number | ValueCallback | min value to set |
Ƭ OptionsBaseOut: Object
options object
| Name | Type | Description |
|---|---|---|
autogradient? | boolean | enables auto gradient of the bars |
barmaxwidth? | number | maximum width of bar in device space |
barmode? | BarMode | Bar display mode of the chart |
barpad? | number | padding between the datasets |
barstyles? | BarStylesTypes[] | array of barstyles |
barvalues? | BarValues | bar values parameters |
barwidth? | number | width of the bars |
createselectedstyle? | CreateSelectedStyle | method to create selected style based on "regular" one |
ismissingvalue? | IsMissingValue | missing value verification criteria; default is function(value){ return (value===null); } |
neatlimits? | boolean | use neatlimits flag |
orientation? | Orientation | orientation of the chart |
positionlimits? | { maxvalue?: number ; minvalue?: number } | value limits for bars positions data |
positionlimits.maxvalue? | number | max value to for bars positions data |
positionlimits.minvalue? | number | min value to for bars positions data |
series? | { visible?: boolean }[] | Enable/disable specific bar chart series |
symbol | Options | Options for symbols on top of each bar |
valuelimits? | { maxvalue?: number | ValueCallback ; minvalue?: number | ValueCallback } | value limits parameters |
valuelimits.maxvalue? | number | ValueCallback | max value to set |
valuelimits.minvalue? | number | ValueCallback | min value to set |
Ƭ OptionsOut: OptionsOut & OptionsBaseOut
options object
Ƭ ValueCallback: (min: number, max: number) => number
▸ (min, max): number
| Name | Type |
|---|---|
min | number |
max | number |
number