Last updated

API / geotoolkit / widgets / Histogram / Histogram

Namespace: Histogram

widgets.Histogram.Histogram

Table of contents

Type Aliases

Contents

Type Aliases

AxisDataOptions

Ƭ AxisDataOptions: Object

JSON which defines data.

Type declaration

NameTypeDescription
annotationside?stringspecifies which side should have axes. By default 'both' means from left and right
annotationsize?number | stringwidth or height of annotation
autominmax?booleanare X min/max fixed (false) or given by datasource (true). DataSource has to exist
axistickgenerator?TickGeneratora custom axis tick generator
axisticks?OptionsJSON which defines ticks options of the axis.
gridtickgenerator?TickGeneratora custom grid tick generator
gridticks?OptionsJSON which defines horizontal ticks options of the grid.
label?OptionsJSON which defines label.
max?numberMaximum Value to display data. If never set, will be max of [options.data]
min?numberMinimum Value to display data. If never set, will be min of [options.data]
neatlimits?booleanCalculate smart limits
neatlimitscenteredonzero?booleanCenter the smart limits on zero
preciselimits?booleanprecise limits
reversed?booleanIs the Axis reversed.

AxisDataOptionsOut

Ƭ AxisDataOptionsOut: EmptyRecord | { annotationsize: number | string ; autominmax?: boolean ; axisticks: OptionsOut | OptionsOut ; gridticks: OptionsOut | OptionsOut ; label: OptionsOut ; max: number ; min: number ; neatlimits?: boolean ; preciselimits: boolean ; reversed: boolean }

how to extract data, null by default


DataOptions

Ƭ DataOptions: Object

data

Type declaration

NameTypeDescription
accumulation?{ linestyle?: Type ; visible?: boolean }JSON for accumulation curve.
accumulation.linestyle?TypeJSON for accumulation curve.
accumulation.visible?booleanVisibility of accumulation curve.
autogradient?booleanFillStyle autogradient
autominmax?booleanare X min/max fixed (false) or given by datasource (true). DataSource has to exist
bins?numberNumber of bins
binspacing?numberbin spacing in percentage
bounds?Rect | Options-
data?number[]Array of data
datasource?NumericalDataSeries | NumericalDataSeriesViewDataSource
fillstyle?TypeBins FillStyle.
frequencytype?FrequencyType | stringFrequency Type
header?HeaderOptionsJSON which defines header area
highlightcolor?stringColor used to highlight bins
linestyle?TypeBins LineStyle.
tools?ToolsOptionsJSON which defines tools data.
unit?string | AbstractUnit-
x?AxisDataOptionsJSON which defines X-data.
y?AxisDataOptionsJSON which defines Y-data.

DataOptionsOut

Ƭ DataOptionsOut: Object

how to extract data, null by default

Type declaration

NameTypeDescription
accumulation{ linestyle: OptionsOut ; visible: boolean }JSON for accumulation curve.
accumulation.linestyleOptionsOutJSON for accumulation curve.
accumulation.visiblebooleanVisibility of accumulation curve.
autogradientbooleanFillStyle autogradient
autominmax?booleanare X min/max fixed (false) or given by datasource (true). DataSource has to exist
binsnumberNumber of bins
binspacingnumberbin spacing in percentage
bounds?Options-
data?number[]-
datasource?NumericalDataSeries | NumericalDataSeriesViewDataSource
fillstyleOptionsOutBins FillStyle.
frequencytypeFrequencyTypeFrequency Type
headerHeaderOptionsOutJSON which defines header area
highlightcolorstringColor used to highlight bins
linestyleLineStyle | nullBins LineStyle.
toolsToolsOptionsOut-
xAxisDataOptionsOutJSON which defines X-data.
yAxisDataOptionsOutJSON which defines Y-data.

EventMap

Ƭ EventMap: EventMap & { dataUpdated: { binCount: number ; count: number ; maxValue: number ; minValue: number } }


HeaderOptions

Ƭ HeaderOptions: Object

JSON which defines header area

Type declaration

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

HeaderOptionsOut

Ƭ HeaderOptionsOut: Object

JSON which defines header area

Type declaration

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

Options

Ƭ Options: Options & DataOptions


OptionsOut

Ƭ OptionsOut: Omit<OptionsOut, "linestyle"> & DataOptionsOut

properties