Last updated

API / geotoolkit / widgets / BubbleChart / BubbleChart

Namespace: BubbleChart

widgets.BubbleChart.BubbleChart

Table of contents

Type Aliases

Contents

Type Aliases

AxisDataOptions

Ƭ AxisDataOptions: Object

JSON which defines data.

Type declaration

NameTypeDescription
annotationsize?number | stringwidth or height of annotation
autolabelrotation?boolean-
autominmax?booleanare min/max fixed (false) or automatically calculated
axis?{ title?: string }-
axis.title?string-
axisticks?OptionsJSON which defines ticks options of the axis. See TickGenerator#setProperties for details
data?number[]Array of data
datasource?NumericalDataSeries | NumericalDataSeriesViewDataSource of data
gridticks?OptionsJSON which defines horizontal ticks options of the grid (X or Y axis only). See TickGenerator#setProperties for details
label?OptionsJSON which defines label
legendvisible?booleanset legend (colorbar) visibility (Z only)
logarithmic?booleanIs the Axis logarithmic.
max?numberset the maximum limit to display data.
min?numberset the minimum limit to display data.
name?string-
neatlimit?booleanenable to calculate neat limits based on existing limits
preciselimit?booleanenable to calculate precise limits based on existing limits
reversed?booleanIs the Axis reversed.
tickgenerator?TickGeneratora custom tickgenerator for this axis
unit?AbstractUnit | stringdisplay unit

DataOptions

Ƭ DataOptions: Object

options

Type declaration

NameTypeDescription
bounds?Options | Rectbounds. See Rect.setProperties for details.
colorprovider?ColorProvidercolor provider
header?HeaderOptionsJSON which defines header area
labels?LabelsOptions-
painter?PainterOptionsJSON which defines painter options
s?AxisDataOptionsJSON which define the size of bubble and related properties S , See BubbleChart#setAxisData for details.
symbolcache?SymbolCacheOptions-
tools?ToolsOptionsJSON which define the tools used in this widgets, See BubbleChart#setToolsOptions for details.
trendline?RegressionLineOptionsJSON which defines trend line options
x?AxisDataOptionsJSON which define the properties of axis X , See BubbleChart#setAxisData for details.
y?AxisDataOptionsJSON which define the properties of axis Y , See BubbleChart#setAxisData for details.
z?AxisDataOptionsJSON which define the properties of axis z , See BubbleChart#setAxisData for details.

DataOptionsOut

Ƭ DataOptionsOut: Object

Type declaration

NameTypeDescription
bounds?Optionsbounds
colorprovider?ColorProvidercolor provider
headerRequired<HeaderOptions>JSON which defines header area
labelsLabelsOptionsOut-
painterPainterOptionsOutJSON which defines painter options
sRequired<AxisDataOptions> | EmptyRecordJSON which define the size of bubble and related properties S , See BubbleChart#setAxisData for details.
toolsToolsOptionsOutJSON which define the tools used in this widgets.
trendlineOptionsBaseOut & { enable: boolean }JSON which defines trend line options
xRequired<AxisDataOptions> | EmptyRecordJSON which define the properties of axis X , See BubbleChart#setAxisData for details.
yRequired<AxisDataOptions> | EmptyRecordJSON which define the properties of axis Y , See BubbleChart#setAxisData for details.
z?Required<AxisDataOptions> | EmptyRecordJSON which define the properties of axis z , See BubbleChart#setAxisData for details.

HeaderOptions

Ƭ HeaderOptions: Object

JSON which defines header area

Type declaration

NameTypeDescription
annotationsize?number | stringheight of header
title?OptionsJSON which defines main title.

LabelsOptions

Ƭ LabelsOptions: Object

JSON which define properties of labels

Type declaration

NameTypeDescription
data?string[] | number[]Data series of labels
datasource?NumericalDataSeries | NumericalDataSeriesView-
location?stringThe relative location of label to bubble
padding?numberthe padding between labels and bubble or view boundary
secondarylocation?stringThe relative location of label to bubble when first location is unable to show the label completely
textstyle?Typethe text style of labels
visible?booleanflag determine the visibility of labels

LabelsOptionsOut

Ƭ LabelsOptionsOut: Object

Type declaration

NameTypeDescription
location?stringThe relative location of label to bubble
paddingnumberthe padding between labels and bubble or view boundary
secondarylocationstringThe relative location of label to bubble when first location is unable to show the label completely
textstyleTextStyle | nullthe text style of labels
visiblebooleanflag determine the visibility of labels

Options

Ƭ Options: Merge<Options & OptionsBase, DataOptions>


OptionsBase

Ƭ OptionsBase: Object

Type declaration

NameTypeDescription
colorprovider?ColorProvidercolor provider
header?HeaderOptionsJSON which defines header area
painter?PainterOptionsJSON which defines painter options
trendline?OptionsJSON which defines trend line options
viewcache?boolean-
viewcachesize?{ height?: number ; width?: number }-
viewcachesize.height?numberset tiled cache size.
viewcachesize.width?numberset tiled cache size.

OptionsOut

Ƭ OptionsOut: OptionsOut & OptionsBase


PainterOptions

Ƭ PainterOptions: Object

JSON which defines painter options

Type declaration

NameTypeDescription
defaultfillstyle?Typedefault fillstyle for symbol
defaultlinestyle?Typedefault linestyle for symbol
highlightcolor?stringhighlight color for symbol
maxsize?numbermaximum size (side length of square) of symbol
minsize?numberminimum size (side length of square) of symbol
symbol?PainterFunctionsymbol painter style

PainterOptionsOut

Ƭ PainterOptionsOut: Object

Type declaration

NameTypeDescription
defaultfillstyleFillStyle | nulldefault fillstyle for symbol
defaultlinestyleLineStyle | nulldefault linestyle for symbol
maxsizenumber-
minsizenumber-
sizebinnumber-
symbolPainterFunctionsymbol painter style

RegressionLineOptions

Ƭ RegressionLineOptions: Options & { enable?: boolean }


SymbolCacheOptions

Ƭ SymbolCacheOptions: Object

symbol options

Type declaration

NameTypeDescription
height?numberthe height of symbol cache
width?numberthe width of symbol cache

Tools

Ƭ Tools: { bubbleHover: Selection ; selection: Selection } & Tools


ToolsOptions

Ƭ ToolsOptions: ToolsOptions & { tooltip?: { displayprops?: Axes[] ; enabled?: boolean ; fillstyle?: Type ; linestyle?: Type ; textstyle?: Type } }

which define the tools options


ToolsOptionsOut

Ƭ ToolsOptionsOut: ToolsOptionsOut & { selection: { enable: boolean ; resetselection: boolean } ; tooltip: { displayprops: Axes[] ; enable: boolean ; fillstyle: FillStyle | null ; linestyle: LineStyle | null ; textstyle: TextStyle | null } }


TrendlineOptions

Ƭ TrendlineOptions: OptionsBaseOut & { enable: boolean }