Last updated

API / geotoolkit / controls / shapes / LineChart / LineChart

Namespace: LineChart

shapes.LineChart.LineChart

Table of contents

Type Aliases

Contents

Type Aliases

AreaRange

Ƭ AreaRange: Object

The area range definition.

Type declaration

NameTypeDescription
fillstyle?Typefillstyle to apply between ranges
linestyles?Type[]Linestyles for area range series
range?number[][] | INumericalDataSeries[] | number[]Defines upper bound range and lowerbound range

DataModel

Ƭ DataModel: Object

Type declaration

NameTypeDescription
arearange?AreaRange[]Defines Area Range
autodatalimitsboolean-
baselinenumberA base line for the fill
datainterpolationstrategyDataInterpolationType-
fillstylesType[]Fill styles to apply to curves
gapfillcutoffvaluenumbervalue of the cutoff used for removing NaN valued samples. Gaps will only be 'filled' when the cutoff value is non zero.
gapvaluenumberMaximum value will be used to disconnect the sample if the distance between two samples in x axis is more than specified value
gridvisible?booleanset visible the gridlines
labels?{ annotations?: number[][] | string[][] | DataSeries[] | DataSeriesView[] ; fillstyles?: FillStyle[] ; linestyles?: LineStyle[] ; offsetx?: number ; offsety?: number ; showellipsis?: boolean ; textstyles?: TextStyle[] }labels for linechart points
labels.annotations?number[][] | string[][] | DataSeries[] | DataSeriesView[]annotations for linechart points, if not specified y value of linechart will be displayed
labels.fillstyles?FillStyle[]fillstyles for label
labels.linestyles?LineStyle[]linestyles for label
labels.offsetx?numbertext margin for label in x-direction
labels.offsety?numbertext margin for label in y-direction
labels.showellipsis?booleanshow ellipses for textstyle
labels.textstyles?TextStyle[]textstyles for label
linecolorproviders?ColorProvider[]The color providers used to color line based on Z value
linestylecallbacks?LineStyleCallbackType[]The custom callbacks used for changing style for each line segment individually
linestylesType[]Line styles to apply to curves
logscaleboolean | { x: boolean ; y: boolean }-
percentarea?booleanDefines if chart is percene area chart
series?{ visible?: boolean }[]returns the visibility of line chart series
sizenumber-
splinebooleantrue to display spline chart instead of polyline
stackedarea?booleanDefines if chart is stacked area chart
symbols{ decimate?: boolean ; dimensions?: Dimension[] ; fillcolorproviders?: ColorProvider[] ; fillstyles?: Type[] ; height?: number ; linecolorproviders?: ColorProvider[] ; linestyles?: Type[] ; painters?: Painter[] ; sizeisindevicespace?: boolean ; step?: number ; visible?: boolean | boolean[] ; width?: number }-
symbols.decimate?boolean-
symbols.dimensions?Dimension[]Symbols dimensions, for each one series
symbols.fillcolorproviders?ColorProvider[]The color providers used to draw symbol interior based on Z value
symbols.fillstyles?Type[]Defines series symbols fill styles
symbols.height?numberSymbols height, for all series
symbols.linecolorproviders?ColorProvider[]The color providers used to draw symbol outline based on Z value
symbols.linestyles?Type[]Defines series symbols line styles
symbols.painters?Painter[]painters for series. Nulls are acceptable if a series should not have a symbols
symbols.sizeisindevicespace?booleanFlag that determines if symbols must keep device size
symbols.step?numberNumber of steps at which symbol should be displayed, for all series
symbols.visible?boolean | boolean[]define visibility of the symbols
symbols.width?numberSymbols width, for all series
xnumber[] | number[][] | INumericalDataSeries[] | INumericalDataSeriesarray of X coordinates
ynumber[] | number[][] | INumericalDataSeries[]array of Y coordinates
z?number[] | number[][] | INumericalDataSeries[]array of Z values (color)

Hits

Ƭ Hits: { indices: number[] ; points: { index: number ; x: number ; y: number ; y1: number[] | number ; z?: number }[] ; series: number }[]


Options

Ƭ Options: Options & Partial<DataModel> & { bounds?: Rect ; cache?: boolean ; modellimits?: Rect }

array of X coordinates or parameters object


OptionsBaseOut

Ƭ OptionsBaseOut: Object

Type declaration

NameTypeDescription
autodatalimits?booleanautomatic model limits calculation
baseline?numberA base line for the fill
fillstyles?Type[]curve fillstyles
gapvalue?numberMaximum value will be used to disconnect the sample if the distance between two samples in x axis is more than specified value
labels?{ anchor?: AnchorType ; annotations?: number[][] | string[][] | DataSeries[] | DataSeriesView[] ; fillstyles?: FillStyle[] ; linestyles?: LineStyle[] ; offset?: number ; offsetx?: number ; offsety?: number ; padding?: number ; showellipsis?: boolean ; step?: number ; textstyles?: TextStyle[] }labels for linechart points
labels.anchor?AnchorTypetext anchor type for label (in device space)
labels.annotations?number[][] | string[][] | DataSeries[] | DataSeriesView[]annotations for linechart points, if not specified y value of linechart will be displayed
labels.fillstyles?FillStyle[]fillstyles for labels
labels.linestyles?LineStyle[]linestyles for labels
labels.offset?numbertext margin in pixel for label in x-y-direction (in device space) calculated automatically according label anchor
labels.offsetx?numbertext margin for label in x-direction
labels.offsety?numbertext margin for label in y-direction
labels.padding?numbertext padding in pixel for label
labels.showellipsis?booleanshow ellipses for textstyle
labels.step?numberNumber of steps at which label should be displayed, for all series
labels.textstyles?TextStyle[]textstyles for labels
linecolorproviders?ColorProvider[]The color providers used to color line based on Z value
linestylecallbacks?LineStyleCallbackType[]The custom callbacks used for changing style for each line segment individually
linestyles?Type[]curve linestyles
modellimits?Rectmodel limits of chart. if it is not set then model limits are calculated.
series?{ visible?: boolean }[]Defines the visibility of linechart series. By default it's true
spline?booleanSpline or polygon path
symbols?{ dimensions?: Dimension[] ; fillcolorproviders?: ColorProvider[] ; fillstyles?: FillStyle[] ; height?: number ; linecolorproviders?: ColorProvider[] ; linestyles?: LineStyle[] ; painters?: Painter[] ; sizeisindevicespace?: boolean ; step?: number ; visible?: boolean | boolean[] ; width?: number }Symbols definition for data series. This object may contain definition for more than one series
symbols.dimensions?Dimension[]Symbols dimensions for each one series
symbols.fillcolorproviders?ColorProvider[]The color providers used to draw symbol interior based on Z value
symbols.fillstyles?FillStyle[]Series symbols fill styles
symbols.height?numberSymbols height, for all series
symbols.linecolorproviders?ColorProvider[]The color providers used to draw symbol outline based on Z value
symbols.linestyles?LineStyle[]Series symbols line styles
symbols.painters?Painter[]painters for series. Nulls are acceptable if a series should not have a symbols
symbols.sizeisindevicespace?booleanFlag that determines if symbols must keep device size,
symbols.step?numberNumber of steps at which symbol should be displayed, for all series
symbols.visible?boolean | boolean[]visibility of the symbols
symbols.width?numberSymbols width, for all series

OptionsOut

Ƭ OptionsOut: Merge<OptionsOut, OptionsBaseOut>

options