Last updated

API / geotoolkit / widgets / timeseries / TimeSeriesObjectBase / TimeSeriesObjectBase

Namespace: TimeSeriesObjectBase

timeseries.TimeSeriesObjectBase.TimeSeriesObjectBase

Table of contents

Type Aliases

Contents

Type Aliases

AxisOptions

Ƭ AxisOptions: Object

JSON which defines curve axis

Type declaration

NameTypeDescription
autocoloraxis?booleansynchronize axis color with curve color
autocolorlabel?booleansynchronize axis and label color with curve color
autolabelrotation?booleanautomatic label rotation
axisautolabelrotation?booleanaxis automatic label rotation
axiscolor?stringaxis color is autocoloraxis is false
axisvisible?booleanaxis visibility
axiswidth?numbercurve axis width
baselinestyle?LineStyle | Optionsbase line style. Color set to curve's color, width = 1 by default.
compact?booleancompact
font?stringcurve axis text font
labelorientation?string | Orientation | numberrotation of the curveaxis labels; can be automatic, vertical, horizontal
labeltext?stringtitle text override
logarithmicscale?booleanlogarithmic scale
microposition?{ bottom?: number ; top?: number }microposition limits
microposition.bottom?numberlower bound of microposition (range from 0 to 1)
microposition.top?numberupper bound of microposition (range from 0 to 1)
position?stringcurve axis position 'left'/'right'
textcolor?stringtext color if autocolorlabel is false
textwidth?numbercurve text width
tickgenerator?NumericTickGeneratortick generator
tickgeneratoroptions?{ edge?: { labelvisible?: boolean ; tickvisible?: boolean } ; format?: LabelFormatHandler | Format ; major?: { labelvisible?: boolean ; tickvisible?: boolean } ; minor?: { labelvisible?: boolean ; tickvisible?: boolean } }JSON which defines tick generator options. See TickGenerator.setProperties for details
tickgeneratoroptions.edge?{ labelvisible?: boolean ; tickvisible?: boolean }edge
tickgeneratoroptions.edge.labelvisible?booleanedge label visibility
tickgeneratoroptions.edge.tickvisible?booleanedge tick visibility
tickgeneratoroptions.format?LabelFormatHandler | Formatlabel formatter for tick generator
tickgeneratoroptions.major?{ labelvisible?: boolean ; tickvisible?: boolean }major
tickgeneratoroptions.major.labelvisible?booleanmajor label visibility
tickgeneratoroptions.major.tickvisible?booleanmajor tick visibility
tickgeneratoroptions.minor?{ labelvisible?: boolean ; tickvisible?: boolean }minor
tickgeneratoroptions.minor.labelvisible?booleanminor label visibility
tickgeneratoroptions.minor.tickvisible?booleanminor tick visibility
title?{ anchor?: AnchorType ; offset?: Point | Dimension }JSON which defines title
title.anchor?AnchorTypetitle anchor
title.offset?Point | Dimensiontitle offset
titlerotateangle?numbertitle rotate angle
titlevisible?booleancurve axis label visibility
visible?booleanvisibility of curve axis

AxisOptionsOut

Ƭ AxisOptionsOut: Object

JSON which defines curve axis

Type declaration

NameTypeDescription
autocoloraxisbooleansynchronize axis color with curve color
autocolorlabelbooleansynchronize axis and label color with curve color
autolabelrotationbooleanautomatic label rotation
axiscolorstringaxis color is autocoloraxis is false
axisvisiblebooleanaxis visibility
axiswidthnumbercurve axis width
baselinestyleLineStyle | nullbase line style. Color set to curve's color, width = 1 by default.
compactbooleancompact
fontstringcurve axis text font
labelorientation?string | Orientation | numberrotation of the curveaxis labels; can be automatic, vertical, horizontal
labeltextstringtitle text override
logarithmicscalebooleanlogarithmic scale
microposition{ bottom: number ; top: number }microposition limits
microposition.bottomnumberlower bound of microposition (range from 0 to 1)
microposition.topnumberupper bound of microposition (range from 0 to 1)
positionstringcurve axis position 'left'/'right'
textcolorstringtext color if autocolorlabel is false
textwidthnumbercurve text width
tickgeneratorNumericTickGeneratortick generator
tickgeneratoroptions{ format: LabelFormatHandler | Format }JSON which defines tick generator options. See TickGenerator.getProperties for details
tickgeneratoroptions.formatLabelFormatHandler | Formatlabel formatter for tick generator
title{ anchor: AnchorType ; offset: Point }JSON which defines title
title.anchorAnchorTypetitle anchor
title.offsetPointtitle offset
titlerotateanglenumbertitle rotate angle
titlevisiblebooleancurve axis label visibility
visiblebooleanvisibility of curve axis

EventMap

Ƭ EventMap: EventMap & { AxisPositionChanged: { axisposition: string ; id: string ; oldposition: string } ; AxisUpdated: TimeSeriesObjectBase }


Options

Ƭ Options: Object

JSON which defines object

Type declaration

NameTypeDescription
curveaxis?AxisOptionsJSON which defines axis object
id?stringObject's id/uri
name?stringObject/curve's name

OptionsOut

Ƭ OptionsOut: Object

properties object

Type declaration

NameTypeDescription
curveaxisAxisOptionsOutaxis options
idstringObject's id/uri
namestringObject/curve's name