API / geotoolkit / charts / widgets / ChartWidget / ChartWidget
widgets.ChartWidget.ChartWidget
Type Aliases
Type Aliases
Ƭ AxesOptions: Record<string, AxisOptions | Axis>
Options for axes on each side of the widget
Ƭ AxisOptions: Options
Ƭ ColorBarAxisOptions: ColorBarAxisOptions
Ƭ HighlightCallback: (this: ChartWidget, selection: SelectedItem<AbstractChart>[], event: string, eventArgs: EventArgs | Point | Rect) => void
▸ (this, selection, event, eventArgs): void
Callback to manage highlighting state(s) based on current selection data
| Name | Type |
|---|---|
this | ChartWidget |
selection | SelectedItem<AbstractChart>[] |
event | string |
eventArgs | EventArgs | Point | Rect |
void
Ƭ Options: { axes?: AxesOptions } & { system?: Cartesian | Ternary } | { axes?: PolarAxesOptions } & { system?: Polar } & Options & { chart?: ChartOptions | ChartOptions[] ; data?: DataSource | Options ; highlight?: { callback?: HighlightCallback ; enabled?: boolean } ; legend?: LegendOptions | LegendOptions[] ; selection?: { callback?: SelectionCallback ; radius?: number } ; selectionmode?: SelectionMode ; title?: { location?: AnnotationLocation ; paddingstyle?: Type ; text?: string ; textstyle?: Type ; visible?: boolean } ; tooltip?: Omit<Options, "callback"> & { callback?: TooltipCallback ; titleformat?: string } ; usedesiredoffset?: boolean }
widget options
Ƭ OptionsOut: OptionsOut & { axes?: Record<string, Axis> ; highlight?: { callback?: HighlightCallback ; enabled?: boolean } ; legend?: LegendOptionsOut ; selection?: { callback?: SelectionCallback ; radius?: number } ; selectionmode?: SelectionMode ; title?: { location?: AnnotationLocation ; text?: string ; textstyle?: TextStyle ; visible?: boolean } ; tooltip?: { callback?: TooltipCallback ; titleformat: string } ; usedesiredoffset: boolean }
properties
Ƭ PolarAxesOptions: Record<string, PolarAxisOptions | AxisOptions | Axis>
Options for axes of polar charts
Ƭ PolarAxisOptions: RemoveLocationField<AxisOptions> & { angle?: number ; location?: PolarAnnotationLocation | AnnotationLocation ; title?: Options["title"] & { angle?: number } ; type?: Exclude<AxisType, ColorBar> }
Ƭ RemoveLocationField<Type>: { [Property in keyof Type as Exclude<Property, "location">]: Type[Property] }
| Name |
|---|
Type |
Ƭ SelectionCallback: (this: ChartWidget, event: string, eventArgs: EventArgs | Point | Rect) => SelectedItem<AbstractChart>[]
▸ (this, event, eventArgs): SelectedItem<AbstractChart>[]
Callback to create selection data based on the current event and selected area
| Name | Type |
|---|---|
this | ChartWidget |
event | string |
eventArgs | EventArgs | Point | Rect |
Ƭ Tools: { LegendTool: FloatingColorBarTool ; colorbar-tools: CompositeTool ; legend-move: AbstractTool ; legend-resize: AbstractTool ; legend-scrolls: CompositeTool ; scrollablepanel-panning: Panning ; tooltip: ToolTipTool } & Tools
Ƭ TooltipCallback: (this: ChartWidget, selection: SelectedItem<AbstractChart>[], event: string, eventArgs: EventArgs | Point | Rect) => ReturnType<Callback>
▸ (this, selection, event, eventArgs): ReturnType<Callback>
Callback to return tooltip info based on the current selection data
| Name | Type |
|---|---|
this | ChartWidget |
selection | SelectedItem<AbstractChart>[] |
event | string |
eventArgs | EventArgs | Point | Rect |
ReturnType<Callback>