Last updated

API / geotoolkit / charts / widgets / ChartWidget / ChartWidget

Namespace: ChartWidget

widgets.ChartWidget.ChartWidget

Table of contents

Type Aliases

Contents

Type Aliases

AxesOptions

Ƭ AxesOptions: Record<string, AxisOptions | Axis>

Options for axes on each side of the widget


AxisOptions

Ƭ AxisOptions: Options


ColorBarAxisOptions

Ƭ ColorBarAxisOptions: ColorBarAxisOptions


HighlightCallback

Ƭ HighlightCallback: (this: ChartWidget, selection: SelectedItem<AbstractChart>[], event: string, eventArgs: EventArgs | Point | Rect) => void

Type declaration

▸ (this, selection, event, eventArgs): void

Callback to manage highlighting state(s) based on current selection data

Parameters
Name Type
thisChartWidget
selectionSelectedItem<AbstractChart>[]
eventstring
eventArgsEventArgs | Point | Rect
Returns

void


Options

Ƭ 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: 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

Ƭ PolarAxesOptions: Record<string, PolarAxisOptions | AxisOptions | Axis>

Options for axes of polar charts


PolarAxisOptions

Ƭ PolarAxisOptions: RemoveLocationField<AxisOptions> & { angle?: number ; location?: PolarAnnotationLocation | AnnotationLocation ; title?: Options["title"] & { angle?: number } ; type?: Exclude<AxisType, ColorBar> }


RemoveLocationField

Ƭ RemoveLocationField<Type>: { [Property in keyof Type as Exclude<Property, "location">]: Type[Property] }

Type parameters

Name
Type

SelectionCallback

Ƭ SelectionCallback: (this: ChartWidget, event: string, eventArgs: EventArgs | Point | Rect) => SelectedItem<AbstractChart>[]

Type declaration

▸ (this, event, eventArgs): SelectedItem<AbstractChart>[]

Callback to create selection data based on the current event and selected area

Parameters
Name Type
thisChartWidget
eventstring
eventArgsEventArgs | Point | Rect
Returns

SelectedItem<AbstractChart>[]


Tools

Ƭ Tools: { LegendTool: FloatingColorBarTool ; colorbar-tools: CompositeTool ; legend-move: AbstractTool ; legend-resize: AbstractTool ; legend-scrolls: CompositeTool ; scrollablepanel-panning: Panning ; tooltip: ToolTipTool } & Tools


TooltipCallback

Ƭ TooltipCallback: (this: ChartWidget, selection: SelectedItem<AbstractChart>[], event: string, eventArgs: EventArgs | Point | Rect) => ReturnType<Callback>

Type declaration

▸ (this, selection, event, eventArgs): ReturnType<Callback>

Callback to return tooltip info based on the current selection data

Parameters
Name Type
thisChartWidget
selectionSelectedItem<AbstractChart>[]
eventstring
eventArgsEventArgs | Point | Rect
Returns

ReturnType<Callback>