API / geotoolkit / widgets / CrossPlot / CrossPlot
Type Aliases
Type Aliases
Ƭ AxisDataOptions: Object
JSON which defines data.
| Name | Type | Description |
|---|---|---|
annotationsize? | number | string | width or height of annotation |
autolabelrotation? | boolean | - |
autominmax? | boolean | are min/max fixed (false) or given by datasource (true). DataSource has to exist |
axis? | { autolabelrotation?: boolean ; autolabelrotationangle?: number ; baseline?: Type ; title?: string } | Axis properties |
axis.autolabelrotation? | boolean | Auto rotation |
axis.autolabelrotationangle? | number | - |
axis.baseline? | Type | - |
axis.title? | string | Axis title text |
axisticks? | Options | JSON which defines ticks options of the axis. |
data? | number[] | Array of data |
datasource? | NumericalDataSeries | NumericalDataSeriesView | DataSource of data |
gridtickgenerator? | TickGenerator | Grid lines tick generator |
gridticks? | Options | JSON which defines horizontal ticks options of the grid (X or Y axis only). |
histogram? | { bins?: number ; fillstyle?: Type ; linecolor?: Type ; linestyle?: Type ; visible?: boolean } | JSON which defines histogram properties |
histogram.bins? | number | number of bins to be used (default is 25) |
histogram.fillstyle? | Type | fillstyle to be used |
histogram.linecolor? | Type | - |
histogram.linestyle? | Type | linestyle to be used |
histogram.visible? | boolean | Is the histogram visible (default is false) |
label? | { text?: string ; textstyle?: Type } | JSON which defines label. |
label.text? | string | Text |
label.textstyle? | Type | Text style |
legendvisible? | boolean | legend visibility (Z only) |
location? | AnnotationLocation | location of |
logarithmic? | boolean | Is the Axis logarithmic. default is false |
max? | number | Maximum Value to display data. If never set, will be max of [options.data] |
min? | number | Minimum Value to display data. If never set, will be min of [options.data] |
minspan? | number | axis min span for smart limits. It works if neatlimits is true |
neatlimits? | boolean | Calculate smart limits for linear mode. For logarithmic mode it is disabled |
preciselimits? | boolean | option for neat limits calculates only step and hide edge ticks. It is neabled only if neatlimits is set |
reversed? | boolean | Is the Axis reversed. |
tickgenerator? | TickGenerator | a custom tickgenerator for this axis |
unit? | AbstractUnit | string | display unit |
Ƭ AxisDataOptionsOut: Object
JSON which defines data.
| Name | Type | Description |
|---|---|---|
annotationsize? | number | string | width or height of annotation |
autominmax? | boolean | are min/max fixed (false) or given by datasource (true). DataSource has to exist |
axisticks? | OptionsOut | JSON which defines ticks options of the axis. |
data? | number[] | Array of data |
datasource? | NumericalDataSeries | NumericalDataSeriesView | DataSource of data |
gridticks? | OptionsOut | JSON which defines horizontal ticks options of the grid (X or Y axis only). |
histogram? | { bins?: number ; visible?: boolean } | JSON which defines histogram properties |
histogram.bins? | number | number of bins to be used |
histogram.visible? | boolean | Is the histogram visible |
label? | { text?: string ; textstyle?: Type } | JSON which defines label |
label.text? | string | Label |
label.textstyle? | Type | Text style |
location? | AnnotationLocation | location of |
logarithmic? | boolean | Is the Axis logarithmic. default is false |
max? | number | Maximum Value to display data. If never set, will be max of [options.data] |
min? | number | Minimum Value to display data. If never set, will be min of [options.data] |
minspan? | number | axis min span for smart limits. It works if neatlimits is true |
neatlimits? | boolean | Calculate smart limits for linear mode. For logarithmic mode it is disabled |
preciselimits? | boolean | option for neat limits calculates only step and hide edge ticks. It is neabled only if neatlimits is set |
reversed? | boolean | Is the Axis reversed. |
unit? | AbstractUnit | string | display unit |
Ƭ DataOptions: Object
options and data
| Name | Type | Description |
|---|---|---|
bounds? | Options | Rect | bounds. |
colorprovider? | ColorProvider | ColorProvider used to color the data |
datasource? | DataSource | DataTable | DataTableView | Data source |
header? | HeaderOptions | JSON which defines header area |
marker? | MarkerOptions | JSON which defines marker options |
tools? | ToolsOptions | JSON which defines tools options. |
x? | AxisDataOptions | JSON which defines X-data. |
y? | AxisDataOptions | JSON which defines Y-data. |
z? | AxisDataOptions | JSON which defines Z-data. |
Ƭ DataOptionsOut: Object
how to extract data, null by default
| Name | Type | Description |
|---|---|---|
bounds? | Options | - |
colorprovider? | Options | ColorProvider used to color the data |
header | HeaderOptionsOut | JSON which defines header area |
marker | MarkerOptionsOut | JSON which defines marker options |
tools | ToolsOptionsOut | JSON which defines tools options. |
x | AxisDataOptionsOut | JSON which defines X-data. |
y | AxisDataOptionsOut | JSON which defines Y-data. |
z | AxisDataOptionsOut | JSON which defines Z-data. |
Ƭ HeaderOptions: Object
JSON which defines header area
| Name | Type | Description |
|---|---|---|
annotationsize? | number | string | height of header |
title? | Options | JSON which defines main title. |
Ƭ HeaderOptionsOut: Object
| Name | Type | Description |
|---|---|---|
annotationsize | number | string | height of header |
title | OptionsOut | JSON which defines main title. |
Ƭ HighlightIndices: Record<string, { indices: number[] ; options?: Options }>
to be highlighted
Ƭ HighlightOptions: Object
indices options
| Name | Type | Description |
|---|---|---|
defaultcolor? | string | default color |
highlightcolor? | string | highlight color |
Ƭ MarkerOptions: Object
JSON which defines marker options
| Name | Type | Description |
|---|---|---|
defaultcolor? | string | default color |
defaultlinecolor? | string | default line color |
highlightcolor? | string | highlight color |
highlightpainter? | Painter | - |
highlightsize? | number | highlight symbol size. it equals to symbols size by default |
painter? | Painter | painter style |
size? | number | marker size |
Ƭ MarkerOptionsOut: Object
| Name | Type | Description |
|---|---|---|
defaultcolor | string | default color of marker |
defaultlinecolor | string | default line color or marker |
highlightcolor? | string | highlight color |
highlightsize | number | highlight symbol size, by default it is equal to the symbol size |
painter | Painter | painter style |
size | number | marker size |
Ƭ Options: Options & DataOptions & { viewcache?: boolean ; viewcachesize?: { height?: number ; width?: number } }
options to initialize crossplot
Ƭ OptionsBase: Options
Ƭ OptionsBaseOut: Merge<DataOptionsOut, { colorprovider?: ColorProvider }>
Ƭ OptionsOut: OptionsOut & DataOptionsOut
properties to apply