API / geotoolkit / controls / shapes / BoxPlot / BoxPlot
Type Aliases
Ƭ BoxValues: Object
| Name | Type | Description |
|---|---|---|
decimalprecision? | number | box values decimal precision |
filterstrategy? | AbstractStrategy | Box value filter strategies |
horizontaloffset? | number | box values' horizontal offset from original position |
location? | BoxValueLocation | box values' label location |
numberformat? | NumberFormat | Box value number format |
suppress? | boolean | enable label suppress when intersection |
textstyle? | Type | box value text style |
verticaloffset? | number | box values' vertical offset from original position |
visible? | boolean | box values visibility flag |
Ƭ Data: Object
data object
| Name | Type | Description |
|---|---|---|
datasets? | DataSet | DataSet[] | Array (or instance) of dataset, each item is an object containing property values and fillstyle |
mode? | DataMode | Data mode for the BoxPlot |
Ƭ DataSet: Object
The dataset definition.
| Name | Type | Description |
|---|---|---|
datasource? | DataSource | - |
fillstyle? | FillStyles | Type | FillStyles[] | Type[] | (FillStyles | Type)[] | fillstyle object for corresponding values. |
values? | number[][] | collection of values to be rendered |
Ƭ EventMap: EventMap & { ModelLimitsChanged: void }
Ƭ FillStyles: Object
| Name | Type | Description |
|---|---|---|
primaryfillstyle? | Type | fillstyle for the box area between third quartile and median |
secondaryfillstyle? | Type | fillstyle for the box area between first quartile and median |
Ƭ IsMissingValue: (v: number | number[]) => boolean
▸ (v): boolean
| Name | Type |
|---|---|
v | number | number[] |
boolean
Ƭ Options: Options & OptionsBase & { connectedlinepattern?: Patterns ; connectedlinestyle?: Type ; fillstyles?: FillStyles[] | Type[] | (FillStyles | Type)[] | (FillStyles[] | Type[] | (FillStyles | Type)[])[] ; ismissingvalue?: IsMissingValue ; linestyles?: Type[] | Type[][] ; primaryfillstyle?: Type ; secondaryfillstyle?: Type }
options object
Ƭ OptionsBase: Object
options object
| Name | Type | Description |
|---|---|---|
boxpad? | number | padding between the box group (datasets) |
boxpositioning? | { boxrange?: Range ; positions?: number[] } | Boxes horizontal positions options |
boxpositioning.boxrange? | Range | An custom limits of box plot positions along the the x-axis |
boxpositioning.positions? | number[] | A list or array of positions where each box plot should be placed along the x-axis |
boxvalues? | BoxValues | box values parameters |
boxwidth? | number | width of the boxs |
boxwidthunit? | string | set unit for the width of box when using absolute width value |
fixedboxwidth? | number | set absolute value for the width of box |
isoutliersvisible? | boolean | enable display of outliers |
orientation? | Orientation | orientation of the plot |
valuelimits? | { maxvalue?: number ; minvalue?: number ; neatlimits?: boolean } | value limits parameters |
valuelimits.maxvalue? | number | max value to set |
valuelimits.minvalue? | number | min value to set |
valuelimits.neatlimits? | boolean | neat limits flag |
whiskerswidth? | number | width of whiskers (the line representing max and min value) |
Ƭ OptionsOut: OptionsOut & OptionsBase & { connectedlinestyle?: LineStyle ; fillstyles?: FillStyles[] | FillStyle[] | (FillStyles | FillStyle)[] | (FillStyles[] | Type[] | (FillStyles | Type)[])[] ; linestyles?: Type[] | Type[][] ; primaryfillstyle?: FillStyle ; secondaryfillstyle?: FillStyle }
properties object