API / geotoolkit / charts / AbstractChart / AbstractChart
charts.AbstractChart.AbstractChart
Type Aliases
Type Aliases
Ƭ EventArgs: Object
| Name | Type |
|---|---|
eventargs | DOMEventArgs |
sample? | number | string |
seriesname | string |
Ƭ EventMap: Merge<EventMap, { DesireModelLimitsChanged: void ; Updated: void ; add: ToggleableSymbolItem ; click: EventArgs ; doubleclick: EventArgs ; hover: EventArgs ; remove: ToggleableSymbolItem }>
Ƭ Hits: Record<string, number[]>
Ƭ LegendFormat: (chart: AbstractChart, type: LegendType, props: Record<string, string>) => string
▸ (chart, type, props): string
Define legend format
| Name | Type | Description |
|---|---|---|
chart | AbstractChart | current chart |
type | LegendType | |
props | Record<string, string> |
string
Ƭ LegendOptions: Object
| Name | Type | Description |
|---|---|---|
bins? | number | Amount of items to have in typed legend(s) |
format? | string | format template for chart legend items x-series - x-series identifier y-series - y-series identifier series.unit - series unit value - series value chartname - chart name Example ts '${y-series}: ${value} m' |
textstyle? | Type | Type[] | Text style(s) for legend items |
type? | LegendType | legend type for the options to be applied |
valueformat? | Format | ValueFormat | Value format |
Ƭ LegendOptionsOut: Object
| Name | Type | Description |
|---|---|---|
bins | number | Amount of items to have in typed legend(s) |
format | string | format template for chart legend items x-series - x-series identifier y-series - y-series identifier series.unit - series unit value - series value Example ts '${y-series}: ${value} m' |
type? | LegendType | legend type for the options to be applied |
valueformat | Format | ValueFormat | null | Value format |
Ƭ Options: Options & { animation?: boolean | Effects | AnimationStyle | Options | Options[] | null ; axes?: Partial<Record<AxisDimensionType, string>> ; legend?: LegendOptions | LegendOptions[] ; legendformat?: LegendFormat ; series?: { selection?: string ; table?: string } ; tooltip?: SeriesTooltip ; tooltipformat?: TooltipFormat | string }
chart options
Ƭ OptionsOut: Merge<OptionsOut, { axes: Partial<Record<AxisDimensionType, string>> ; legend: LegendOptionsOut | LegendOptionsOut[] ; legendformat?: LegendFormat | null ; series: { table?: string } ; tooltip: { format: string ; valueformat: Format | ValueFormat | null } ; tooltipformat: TooltipFormat | string | null }>
chart options
Ƭ Series: Object
Base series properties
| Name | Type | Description |
|---|---|---|
data | string | data series identifier |
field? | string | data field for values in case data is objects array |
name? | string | series name to use in tooltip and legend |
tooltip? | SeriesTooltip | Tooltip settings |
unit? | string | Unit of the data series |
Ƭ SeriesTooltip: Object
Define Series tooltip
| Name | Type | Description |
|---|---|---|
format? | string | Format of series tooltip series.symbol - series symbol series.list - series list symbol series.name - series name series.id - series id series.unit - series unit series.index - series sample index value - series value Example ts '${series.symbol} The ${series.name} is {value} m' |
title? | string | Tooltip title format template string: chartname - chart name (if specified) charttype - chart type (linechart, crossplot, etc) symbol - chart symbol (if any series have it) list - chart list symbol Series can be addressed with its name (if specified) or id (by default): seriesid.name - specific series name seriesid.value - specific series value seriesid.unit - specific series unit seriesid.symbol - specific series symbol seriesid.id - specific series identifier |
valueformat? | Format | ValueFormat | Value format |
Ƭ SeriesWithData: Merge<Series, { data: number[] | string[] | string | Date[] | Record<string, any>[] ; field?: string ; unit?: string }>
Ƭ TooltipFormat: (selection: Record<string, number[]>, chart: AbstractChart) => string
▸ (selection, chart): string
Define tooltip format
| Name | Type | Description |
|---|---|---|
selection | Record<string, number[]> | selection |
chart | AbstractChart | current chart |
string
string for current selection
Ƭ TooltipItem: Object
Tooltip item
| Name | Type | Description |
|---|---|---|
chart? | AbstractChart | Chart |
index? | number | Index of the sample |
series | { id?: string ; list?: string ; name?: string ; symbol?: TooltipSymbolOptions ; unit?: AbstractUnit } | Series info |
series.id? | string | Series's id |
series.list? | string | List symbol's color |
series.name? | string | Series's name |
series.symbol? | TooltipSymbolOptions | Series's symbol |
series.unit? | AbstractUnit | Unit of series if it exists |
value? | number | string | number[] | Selected series value |
visible? | boolean | False if tooltip item is hidden, true otherwise |
Ƭ ValueFormat: (value: number) => string
▸ (value): string
Format callback for tooltip or legend values
| Name | Type | Description |
|---|---|---|
value | number | value to be displayed |
string