API / geotoolkit / widgets / timeseries / TimeSeriesObject / TimeSeriesObject
timeseries.TimeSeriesObject.TimeSeriesObject
Type Aliases
Type Aliases
Ƭ CurveLimitsOptions: Object
JSON describing curve limits group options
| Name | Type | Description |
|---|---|---|
font? | string | 10px Arial] curve limits text font |
margin? | number | curve limits area margin (top and bottom) |
visible? | boolean | visibility of curve limits area |
width? | number | width for each curve limits column |
Ƭ CurveLimitsOptionsOut: Object
| Name | Type | Description |
|---|---|---|
font | string | curve limits text font |
margin | number | curve limits area margin (top and bottom) |
visible | boolean | visibility of curve limits area |
width | number | width for each curve limits column |
Ƭ CurveOptions: Object
object containing curve options
| Name | Type | Description |
|---|---|---|
autoscale? | boolean | true if curve in auto-scaling mode |
axisposition? | string | 'left'/'right' |
barmode? | { barvalues?: { formatter?: NumberFormat ; margins?: { left?: number ; top?: number } ; rotationangle?: number ; textstyle?: Type } ; barwidth?: number ; enabled?: boolean ; fillstyle?: Type ; linestyle?: Type } | options |
barmode.barvalues? | { formatter?: NumberFormat ; margins?: { left?: number ; top?: number } ; rotationangle?: number ; textstyle?: Type } | Bar values options |
barmode.barvalues.formatter? | NumberFormat | Formatter for bar value texts |
barmode.barvalues.margins? | { left?: number ; top?: number } | Options to set bar values margins in device space |
barmode.barvalues.margins.left? | number | Left margin in device space |
barmode.barvalues.margins.top? | number | Top margin in device space |
barmode.barvalues.rotationangle? | number | Bar value rotation angle |
barmode.barvalues.textstyle? | Type | Bar value text style |
barmode.barwidth? | number | Width of each bar in device space |
barmode.enabled? | boolean | enabled barmode |
barmode.fillstyle? | Type | Fill style for bars, default is line color of TimeSeriesLine |
barmode.linestyle? | Type | Line style for bars, default is line style of TimeSeriesLine |
borderlinestyle? | Type | timeseriesshape border line style |
curvevisible? | boolean | curve line visibility flag |
decimationspacing? | number | - |
interpolationtype? | InterpolationType | interpolation type |
linestyle? | Type | curve linestyle |
logarithmicscale? | boolean | logarithmic scale |
marker? | Marker | SymbolShape | object containing marker symbol |
markervisible? | boolean | visibility of point markers |
max? | number | curve max value |
microposition? | { bottom?: number ; top?: number } | micro position limits |
microposition.bottom? | number | vertical end micro position in the range from 0 to 1 |
microposition.top? | number | vertical start micro position in the range from 0 to 1 |
min? | number | curve min value |
name? | string | name of curve |
neatlimits? | boolean | { enable?: boolean ; max?: number ; min?: number ; precise?: boolean } | neatlimits setting, true of set neatlimits object to enable, false or null|undefined to disable |
neatlimitscenteredonzero? | boolean | true if curve in neat-limits mode |
spline? | boolean | toggle spline interpolation |
title? | { anchor?: AnchorType ; offset?: Point | Dimension } | curve title |
title.anchor? | AnchorType | - |
title.offset? | Point | Dimension | offset |
unit? | string | AbstractUnit | unit string |
values? | Values | object containing point values options |
visible? | boolean | visibility of curve |
Ƭ CurveOptionsOut: Object
| Name | Type | Description |
|---|---|---|
autoscale | boolean | true if curve in auto-scaling mode |
axisposition | string | 'left'/'right' |
barmode | { barvalues?: { formatter?: NumberFormat ; margins?: { left?: number ; top?: number } ; rotationangle?: number ; textstyle?: Type } ; barwidth?: number ; enabled?: boolean ; fillstyle?: Type ; linestyle?: Type } | options |
barmode.barvalues? | { formatter?: NumberFormat ; margins?: { left?: number ; top?: number } ; rotationangle?: number ; textstyle?: Type } | Bar values options |
barmode.barvalues.formatter? | NumberFormat | Formatter for bar value texts |
barmode.barvalues.margins? | { left?: number ; top?: number } | Options to set bar values margins in device space |
barmode.barvalues.margins.left? | number | Left margin in device space |
barmode.barvalues.margins.top? | number | Top margin in device space |
barmode.barvalues.rotationangle? | number | Bar value rotation angle |
barmode.barvalues.textstyle? | Type | Bar value text style |
barmode.barwidth? | number | Width of each bar in device space |
barmode.enabled? | boolean | enabled barmode |
barmode.fillstyle? | Type | Fill style for bars, default is line color of TimeSeriesLine |
barmode.linestyle? | Type | Line style for bars, default is line style of TimeSeriesLine |
borderlinestyle | LineStyle | null | timeseriesshape border line style |
flip | boolean | is vertically flipped |
id | string | - |
interpolationtype | InterpolationType | - |
linestyle | LineStyle | null | curve linestyle |
logarithmicscale | boolean | logarithmic scale |
max | number | curve max value |
microposition | { bottom?: number ; top?: number } | micro position limits |
microposition.bottom? | number | vertical end micro position in the range from 0 to 1 |
microposition.top? | number | vertical start micro position in the range from 0 to 1 |
min | number | curve min value |
name | string | name of curve |
neatlimits | boolean | { enable?: boolean ; max?: number ; min?: number ; precise?: boolean } | neatlimits setting, true of set neatlimits object to enable, false or null|undefined to disable |
neatlimitscenteredonzero | boolean | true if curve in neat-limits mode |
unit | AbstractUnit | string | unit |
visible | boolean | visibility of curve |
Ƭ DataOptions: Object
data source or object to specify data source
| Name | Type | Description |
|---|---|---|
datatable? | DataTableView | DataTable | DataTable or DataTableView which contains time and value column |
indices? | string | number | name or index of series in data table / view if it is provided |
name? | string | name of the curve |
values? | string | number | name or index of series in data table / view if it is provided |
Ƭ EventMap: EventMap & { curveaxischanged: Group ; dataset: { new: DataTableView | DataTable ; old: DataTableView | DataTable | DataOptions } ; legenditemchanged: LegendItem ; legendvaluechanged: Group ; limitsupdated: TimeSeriesObject }
Ƭ FillData: Object
| Name | Type |
|---|---|
filldirection | FillDirection |
fillstyle | FillStyle |
filltype | FillType |
id1 | string |
id2 | string | number | null |
Ƭ FormatDataOptions: Object
object which contains properties to be displayed
| Name | Type | Description |
|---|---|---|
additionaltext? | string | an additional value text to be displayed |
id? | string | item id |
name? | string | a name of the object to be displayed |
symbol? | SymbolShape | symbol to be drawn |
unittext? | string | a unit text to be displayed |
valuetext? | string | a value text to be displayed |
Ƭ LegendOptions: Object
JSON which defines legend options
| Name | Type | Description |
|---|---|---|
autocolorlabel? | boolean | - |
fillstyle? | Type | legend fillstyle |
fixedwidth? | number | fixed width option |
font? | string | 12px Arial] legend font |
formatter? | Format | represents the legend number formatter. |
height? | number | legend height |
internalpadding? | number | legend padding |
labelcolor? | string | '6b6b6b' legend text color |
linestyle? | Type | legend border linestyle |
margintext? | number | margin between edge and text of legend |
Ƭ LegendOptionsOut: Object
JSON which defines legend options
| Name | Type | Description |
|---|---|---|
fillstyle | FillStyle | null | fill style |
fixedwidth | number | fixed width |
font | string | font |
formatter | Format | represents the legend number formatter. |
height | number | height |
internalpadding | number | internal padding |
labelcolor | string | label color |
linestyle | LineStyle | null | line style |
margintext | number | margin of text |
Ƭ Marker: Object
| Name | Type | Description |
|---|---|---|
alignment? | AnchorType | anchor type of marker |
fillstyle? | Type | style applied on fill |
height? | number | marker height |
linestyle? | Type | style applied on outline |
painter? | Painter | marker's painter's className |
sizeisindevicespace? | boolean | size is in device space |
width? | number | marker width |
Ƭ Options: Options & { curve?: { data?: DataTableView | DataTable | DataOptions ; properties?: CurveOptions } ; curvelimits?: CurveLimitsOptions ; curvesymbol?: SymbolOptions ; legenditem?: LegendOptions ; legendsvisible?: boolean ; tooltipitem?: TooltipItemOptions ; tooltipsvisible?: boolean ; uri?: string }
object
Ƭ OptionsOut: OptionsOut & { curve: { properties: CurveOptionsOut } ; curvelimits: CurveLimitsOptionsOut ; curvesymbol: SymbolOptionsOut ; legenditem: LegendOptionsOut ; tooltipitem: TooltipOptions ; uri: string }
properties object
Ƭ SymbolOptions: Object
JSON of symbol options
| Name | Type | Description |
|---|---|---|
fillstyle? | Type | fillstyle of symbol |
height? | number | height of symbol |
painter? | Painter | Painter |
type? | "cross" | "diamond" | "plus" | "square" | "star" | "triangle" | "circle" | type of painter Deprecated since 4.0 use "painter" instead |
visible? | boolean | visibility of curve highlighting symbol |
width? | number | width of symbol |
Ƭ SymbolOptionsOut: Object
| Name | Type | Description |
|---|---|---|
fillstyle | FillStyle | null | - |
height | number | height of symbol |
painter | Painter | Painter |
type | string | type of painter Deprecated since 4.0 use "painter" instead |
visible | boolean | - |
width | number | width of symbol |
Ƭ TooltipItemOptions: Options & { externalpadding?: number ; fixedwidth?: number | null ; font?: string ; formatdatahandler?: (obj: FormatDataOptions) => FormatDataOptions ; formatter?: Format ; height?: number ; internalpadding?: number ; margintext?: number ; nanvisibility?: boolean ; singlerow?: boolean ; symbolsize?: number ; textcolor?: string ; valuevisible?: boolean }
Ƭ TooltipOptions: Object
JSON which defines tooltip options
| Name | Type | Description |
|---|---|---|
externalpadding | number | external padding |
fillstyle | FillStyle | null | fill style |
fixedwidth | number | fixed width |
font | string | font |
formatter | Format | represents the tooltip number formatter. |
internalpadding | number | internal padding |
linestyle | LineStyle | null | line style |
margintext | number | margin between edge and text of tooltip |
nanvisibility | boolean | if true then tooltip also display with value NaN |
singlerow | boolean | if true then text display in tooltip single row |
symbolsize | number | size of symbol |
textcolor | string | text color |
Ƭ Values: Object
| Name | Type | Description |
|---|---|---|
anchor? | AnchorType | - |
color? | string | color of value text font |
fillstyle? | Type | fillstyle of value text container |
font? | string | value text font |
format? | NumberFormat | formatter for value text |
linestyle? | Type | linestyle of value text container |
offset? | number | - |
offsetx? | number | - |
offsety? | number | - |
padding? | number | Deprecated since 4.1 use paddingstyle instead inner padding in device coordinates |
paddingstyle? | Type | inner padding style in device coordinates |
textstyle? | Type | texttyle of value text container |
visible? | boolean | visibility of point values |