API / geotoolkit / widgets / TimeSeriesWidget / TimeSeriesWidget
widgets.TimeSeriesWidget.TimeSeriesWidget
Type Aliases
Type Aliases
Ƭ AddAnnotationOptions: AnnotationOptions & { curveid?: string ; symbol?: string ; time?: number }
json object that represents the annotation options
Ƭ AnnotationLineOptions: Options & { alignment?: AnchorType ; angle?: number ; fillstyle?: Type ; linestyle?: Type ; linevisible?: boolean ; point?: Point ; text?: string ; textstyle?: Type ; textvisible?: boolean }
Ƭ AnnotationLineOptionsOut: OptionsOut & { alignment: AnchorType ; angle: number ; label: string ; linevisible: boolean ; point: Point ; text: string ; textstyle: TextStyle | null ; textvisible: boolean }
Ƭ AnnotationOptions: Options & { fillstyle?: Type ; label?: string ; linestyle?: Type ; point?: Point ; symbol?: string | PainterFunction ; symbolsize?: number ; textbackground?: Type ; textstyle?: Type ; timeseriesobject?: TimeSeriesObject }
Ƭ AnnotationOptionsOut: Merge<OptionsOut, { fillstyle: FillStyle | null ; label: string ; linestyle: LineStyle | null ; point: Point ; symbol: string ; symbolsize: number ; textbackground: Type ; textstyle: Type ; timeseriesobject: TimeSeriesObject }>
Ƭ BarHighlighting: Object
Bar to highlight
| Name | Type | Description |
|---|---|---|
datapointindex | number | Index of data in x coordinate |
lineindex | number | Index of curve |
Ƭ BarHighlightingCallback: (highlightBar: BarHighlighting, linestyle: LineStyle, fillstyle: FillStyle) => BarHighlightingStyle
▸ (highlightBar, linestyle, fillstyle): BarHighlightingStyle
Callback for highlighting method
| Name | Type |
|---|---|
highlightBar | BarHighlighting |
linestyle | LineStyle |
fillstyle | FillStyle |
Ƭ BarHighlightingStyle: Object
Defines bar highlighting style
| Name | Type | Description |
|---|---|---|
fillstyle | FillStyle | null | Fill style of series for highlighted bar |
linestyle | LineStyle | null | Line style of series for highlighted bar |
Ƭ BarMode: Object
Options for bar mode
| Name | Type | Description |
|---|---|---|
barvaluevisibility? | boolean | number | Bar values visible distance in device space of TimeSeriesBar |
highlightingmethod? | BarHighlightingCallback | Bar highlighting method |
renderingorder? | BarRenderingOrderCallback | Determine rendering order of each bar. By default, bars will be rendered in the order of bar series when it was added |
Ƭ BarModeOut: Required<BarMode>
Options for bar mode
Ƭ BarRenderingOrderCallback: (valueOrderPairs: BarValueOrderPair[]) => BarValueOrderPair[]
▸ (valueOrderPairs): BarValueOrderPair[]
Callback for renderingOrder
| Name | Type |
|---|---|
valueOrderPairs | BarValueOrderPair[] |
Ƭ BarValueOrderPair: Object
Defines value order pair
| Name | Type | Description |
|---|---|---|
height | number | Height of bar in model space |
order | number | The original rendering order of the series |
value | number | Value of bar |
Ƭ CurveData: Object
Defines curve data
| Name | Type | Description |
|---|---|---|
color | string | Curve color in css |
curve | TimeSeriesLine | Curve object |
id | string | Curve id |
index | number | Index of x coordinate |
name | string | Curve name |
originalunit | AbstractUnit | string | Curve original unit |
originalvalue | number | Curve value |
position | number | Curve x coordinate in model space |
symbol | SymbolShape | Curve symbol |
unit | string | Curve value unit |
value | number | Curve y coordinate in model space |
Ƭ CurveOptions: Object
| Name | Type | Description |
|---|---|---|
curvesymbol? | SymbolOptions | Curve symbol setting |
data | DataTableView | Curve data |
id? | string | Curve id, defaults to uri if unspecified |
name | string | Curve name |
position? | number | Position or order of the curve |
properties | CurveProperties | Curve properties |
referencelines? | (string | ReferenceLineData)[] | The reference lines should connect to the curve. New reference lines will be created if specified data objects for the reference lines instead of existed reference line ids. |
uri | string | Curve unique id, it will also be used with the associated TimeSeriesObject |
Ƭ CurveProperties: Omit<CurveOptions, "title" | "microposition"> & AxisOptions & { id?: string }
Ƭ EditAnnotation: Merge<AnnotationOptions, AnnotationLineOptions>
Ƭ EventMap: EventMap & { beforeSelectionChange: SelectionChangeEventArgs ; onAnnotationClick: string ; onAnnotationLineClick: string ; onCursorChanged: Point ; onSelectionChanged: SelectionChangeEventArgs ; onVisibleRangeChanged: VisibleRangeChangeEventArgs }
Ƭ ExportToPDFOptions: Object
PDF options
| Name | Type | Description |
|---|---|---|
embededfonts? | EmbededFont[] | array of embedded fonts |
footer? | FooterComponent | an optional PDF footer |
header? | HeaderComponent | an optional PDF header |
imagecompression? | { mode?: ImageCompression ; quality?: number ; speed?: SpeedCompression } | compression options |
imagecompression.mode? | ImageCompression | image compression method used to exporting pdf. |
imagecompression.quality? | number | quality range from 0 to 1 that will express the jpeg image compression quality, available for jpeg mode only. |
imagecompression.speed? | SpeedCompression | speed referring to the png compression speed, available for png mode only. |
limits? | { end?: number ; start?: number } | export depth or time limits |
limits.end? | number | end limit by default visible limits |
limits.start? | number | start limit by default visible limits |
output? | string | define optional output filename |
pdfstream? | IWritable | optional user-customized Stream object |
printsettings? | DocumentExportSettings | define optional paper and export parameters |
save? | boolean | flag to save the pdf directly to file or open dialog |
scale? | number | export scale from model index unit to pixels by default as is |
streamcompression? | boolean | enable or disable pdf output compression |
Ƭ FormatHandler: (value: number) => string
▸ (value): string
| Name | Type |
|---|---|
value | number |
string
Ƭ GroupOptions: Options & { curveids?: string[] | number[] ; options?: AxisOptions ; referencelines?: (string | ReferenceLineData)[] }
group id
Ƭ ModelOffsets: Object
model offsets
| Name | Type | Description |
|---|---|---|
left? | string | number | model left offset |
right? | string | number | model right offset |
Ƭ NotifySelection: Object
selection event arguments
| Name | Type | Description |
|---|---|---|
id | string | selection id |
type? | string | selection type |
Ƭ Options: Options & OptionsBase
Ƭ OptionsBase: Object
object containing widget options
| Name | Type | Description |
|---|---|---|
alignaxis? | boolean | align axis |
automodellimitsmode? | boolean | automodellimits mode |
barmode? | BarMode | Options for bar mode |
cursor? | { linestyle?: Type } | cursor tool options |
cursor.linestyle? | Type | defines linestyle for timeseries cursor tool |
cursorselectionlimit? | number | Threshold distance indevice space, from vertical cursor line to show symbol, update legend and show tooltip |
curve? | CurveOptions | - |
curveaxis? | AxisOptions | JSON which defines curve axis |
curvelimits? | CurveLimitsOptions | JSON which defines curve limits area |
curvesymbol? | SymbolOptions | JSON which defines curve highlighting symbol |
intervalbuttons? | { intervals?: Record<string, number> ; visible?: boolean } | JSON which defines the interval buttons |
intervalbuttons.intervals? | Record<string, number> | JSON which defines the text and scale value of each interval button |
intervalbuttons.visible? | boolean | visibility of the interval buttons |
lastupdatedate? | { color?: string ; followcursor?: boolean ; font?: string ; formatter?: string | FormatHandler ; visible?: boolean } | JSON which defines last update date area |
lastupdatedate.color? | string | last update date text color |
lastupdatedate.followcursor? | boolean | false means the last data time will be displayed and true means the cursor position data time will be displayed |
lastupdatedate.font? | string | last update date text font |
lastupdatedate.formatter? | string | FormatHandler | visible range text formatter |
lastupdatedate.visible? | boolean | visibility of the last update date area |
legends? | { alignwithcentermodel?: boolean ; autocolorlabel?: boolean ; direction?: Direction ; fillstyle?: Type ; height?: number ; legendoptions?: LegendOptions ; linestyle?: Type ; marginbottom?: number ; margintext?: number ; position?: LegendPosition ; visible?: boolean ; width?: number } | JSON which defines legends area |
legends.alignwithcentermodel? | boolean | aligns the legendcontainer with the centermodel when positioned outside |
legends.autocolorlabel? | boolean | legend's text label color |
legends.direction? | Direction | direction of legends (left-to-right, right-to-left) |
legends.fillstyle? | Type | - |
legends.height? | number | legends area height |
legends.legendoptions? | LegendOptions | JSON which defines legend options |
legends.linestyle? | Type | - |
legends.marginbottom? | number | legends area bottom margin (outside only) |
legends.margintext? | number | legend text margin left and right |
legends.position? | LegendPosition | Outside/Inside model |
legends.visible? | boolean | visibility of legends area |
legends.width? | number | if positioned inside, container width |
margin? | number[] | array of margins of this widget [top, right, bottom, left] |
model? | Group | Timeseries' center model limits can be specified using this option |
modelaxis? | { baselinestyle?: Type ; tickgenerator?: TickGenerator ; visible?: boolean } | JSON which defines axis inside model |
modelaxis.baselinestyle? | Type | base linestyle for the model axis |
modelaxis.tickgenerator? | TickGenerator | tick generator for the axis inside model |
modelaxis.visible? | boolean | visiblility of the axis inside model |
modelgrid? | { horizontaltickgenerator?: TickGenerator ; horizontalvisibility?: { edge?: boolean ; major?: boolean ; minor?: boolean } ; verticaltickgenerator?: TickGenerator ; verticalvisibility?: { edge?: boolean ; major?: boolean ; minor?: boolean } } | JSON which contains 'horizontaltickgenerator' and 'verticaltickgenerator' |
modelgrid.horizontaltickgenerator? | TickGenerator | Horizontal tickgenerator for the model grid. (Horizontal reference curve takes precedence over this option). Default is an instance of AdaptiveTickGenerator |
modelgrid.horizontalvisibility? | { edge?: boolean ; major?: boolean ; minor?: boolean } | JSON defining horizontal gridline visibility |
modelgrid.horizontalvisibility.edge? | boolean | - |
modelgrid.horizontalvisibility.major? | boolean | - |
modelgrid.horizontalvisibility.minor? | boolean | - |
modelgrid.verticaltickgenerator? | TickGenerator | Vertical tickgenerator for the model grid (default visibility of ticks is false). Default is an instance of AdaptiveDateTimeTickGenerator |
modelgrid.verticalvisibility? | { edge?: boolean ; major?: boolean ; minor?: boolean } | JSON defining vertical gridline visibility |
modelgrid.verticalvisibility.edge? | boolean | - |
modelgrid.verticalvisibility.major? | boolean | - |
modelgrid.verticalvisibility.minor? | boolean | - |
modeloffsets? | ModelOffsets | Options for model padding offsets |
percent? | PercentMode | Percent TimesSeriesWidget settings |
scrollbar? | { height?: number ; options?: Options & { color?: string ; font?: string ; formatter?: string } ; tickgenerator?: TickGenerator ; type?: ScrollBarType | string ; visible?: boolean } | JSON which defines scroll bar area |
scrollbar.height? | number | scroll bar area height |
scrollbar.options? | Options & { color?: string ; font?: string ; formatter?: string } | Additional options to use for scrollbar (this depends on the options the specific scrollbar accepts) |
scrollbar.tickgenerator? | TickGenerator | - |
scrollbar.type? | ScrollBarType | string | scroll type or className. for className use ScrollFactory#registerScrollbar first |
scrollbar.visible? | boolean | visibility of scroll bar area |
scrolltonowbutton? | { visible?: boolean } | JSON which defines the now button |
scrolltonowbutton.visible? | boolean | visibility of the now button |
selectionstrategy? | SelectionStrategyCallback | selection strategy to set |
southaxis? | { color?: string ; font?: string ; height?: number ; tickgenerator?: TickGenerator ; visible?: boolean } | JSON which defines south axis |
southaxis.color? | string | south axis label color |
southaxis.font? | string | south axis label font |
southaxis.height? | number | south axis height |
southaxis.tickgenerator? | TickGenerator | tick generator for south axis. Default is an instance of AdaptiveDateTimeTickGenerator |
southaxis.visible? | boolean | visibility of south axis |
stack? | StackMode | Stack TimesSeriesWidget settings |
timezone? | TimeZone | UTC or local time |
title? | { centered?: boolean ; color?: string ; font?: string ; height?: number ; padding?: number[] ; text?: string ; visible?: boolean } | JSON which defines title area |
title.centered? | boolean | centers title text |
title.color? | string | title text color |
title.font? | string | title text font |
title.height? | number | height of title |
title.padding? | number[] | array of padding for title text |
title.text? | string | title text |
title.visible? | boolean | visibility of title text |
tooltips? | { fillstyle?: Type ; linestyle?: Type ; selectionradius?: number ; symbollinestyle?: Type ; tooltipoptions?: TooltipItemOptions & { index?: { formatter?: Format ; indextext?: string ; name?: string ; symbol?: SymbolShape ; textcolor?: string ; unittext?: string ; visible?: boolean } } ; visible?: boolean } | json defining tooltips |
tooltips.fillstyle? | Type | fillstyle of tooltip box |
tooltips.linestyle? | Type | linestyle of tooltip box |
tooltips.selectionradius? | number | radius of tooltip selection visibility |
tooltips.symbollinestyle? | Type | border linestyle of tooltip symbol |
tooltips.tooltipoptions? | TooltipItemOptions & { index?: { formatter?: Format ; indextext?: string ; name?: string ; symbol?: SymbolShape ; textcolor?: string ; unittext?: string ; visible?: boolean } } | JSON which defines tooltip options |
tooltips.visible? | boolean | tooltip visibility |
viewcache? | boolean | - |
visiblerange? | { color?: string ; font?: string ; formatter?: string | FormatHandler ; height?: number ; visible?: boolean | { max?: boolean ; min?: boolean } } | JSON which defines visible range area |
visiblerange.color? | string | visible range text color |
visiblerange.font? | string | visible range text font |
visiblerange.formatter? | string | FormatHandler | visible range text formatter |
visiblerange.height? | number | visible range area height |
visiblerange.visible? | boolean | { max?: boolean ; min?: boolean } | visibility of visible range area |
Ƭ OptionsOut: OptionsOut & Required<OptionsBase>
Ƭ PercentMode: Object
Percent TimesSeriesWidget settings
| Name | Type | Description |
|---|---|---|
enabled? | boolean | True to enable time series percent mode, false otherwise |
fillstyles? | { [key: string]: RgbaColor; } | Percent mode time series fill styles, key of each fill style is curve id |
tooltip? | { showoriginalvalue?: boolean } | Tooltip option for percentage mode |
tooltip.showoriginalvalue? | boolean | True to show original value along side with percentage |
Ƭ PercentModeOut: Required<PercentMode>
Percent TimesSeriesWidget settings
Ƭ ReferenceLineData: ReferenceLineOptions & Required<Pick<ReferenceLineOptions, "id">> | Required<Pick<ReferenceLineOptions, "connect">>
Reference line data
Ƭ ReferenceLineOptions: Options & { connect?: string ; max?: number ; min?: number ; text?: { alignment?: AnchorType ; offset?: Options<number> ; textstyle?: Type ; visible?: boolean } ; value?: number | null }
Reference line options
Ƭ ReferenceLineOptionsOuts: OptionsOut & { connect: string ; max: number ; min: number ; text: { alignment: AnchorType ; offset: SpaceStyle<number> ; textstyle: Type ; visible: boolean } ; value: number }
Reference line options get type
Ƭ SelectionStrategyCallback: (widget: TimeSeriesWidget, selection: NotifySelection, oldSelection: NotifySelection) => void
▸ (widget, selection, oldSelection): void
| Name | Type |
|---|---|
widget | TimeSeriesWidget |
selection | NotifySelection |
oldSelection | NotifySelection |
void
Ƭ StackMode: Object
Stack TimesSeriesWidget settings
| Name | Type | Description |
|---|---|---|
enabled? | boolean | True to enable time series stack area mode, false otherwise |
fillstyles? | { [key: string]: RgbaColor; } | Stack time series fill styles, key of each fill style is curve id |
Ƭ StackModeOut: Required<StackMode>
Stack TimesSeriesWidget settings
Ƭ Tools: { cursor: CrossHair ; panning: Panning ; picking: Selection ; rubberband: RubberBand ; zoom: Zoom } & Tools