API / geotoolkit / controls / shapes / RegressionLine / RegressionLine
shapes.RegressionLine.RegressionLine
Type Aliases
Type Aliases
Ƭ DataOptions: Object
data
| Name | Type | Description |
|---|---|---|
datax? | number[] | INumericalDataSeries | data source for x |
datay? | number[] | INumericalDataSeries | data source for y |
weights? | number[] | INumericalDataSeries | weights of data point |
Ƭ LabelOptions: Object
Regression line label options
| Name | Type | Description |
|---|---|---|
anchortype? | AnchorType | Label anchor type |
fillstyle? | Type | Label fill style |
linestyle? | Type | Label border line style |
location? | number | The distance of the label in the range of [0, 1] 0 is the start point of the line, from the left end 1 is the end point of the line, the right end |
offset? | number | Offset of label in device space with the line |
text? | string | Label text |
textstyle? | Type | Label text style |
visible? | boolean | Label visibility |
Ƭ LineOptions: Object
options for setting line
| Name | Type | Description |
|---|---|---|
label? | LabelOptions | Regression line label options |
linestyle? | Type | set line style of this type of line |
visible? | boolean | set visibility of this type of line |
Ƭ LineOptionsOut: Object
options for setting line
| Name | Type | Description |
|---|---|---|
label? | LabelOptions | Regression line label options |
linestyle? | LineStyle | set line style of this type of line |
visible? | boolean | set visibility of this type of line |
Ƭ LineType: "regression" | "confidence" | "prediction"
Line type
Ƭ LineTypeExtended: "regression" | "confidenceupper" | "confidencelower" | "predictionupper" | "predictionlower"
Extended line type
Ƭ Options: Options & OptionsBase & DataOptions
Ƭ OptionsBase: Object
options
| Name | Type | Description |
|---|---|---|
autolimits? | boolean | enable auto calculate model limits base on lines geometry Deprecated since 4.1. Setting is not used anymore. |
confidenceline? | ProbabilityLineOptions | options for confidence line |
databounds? | Rect | Regression line data bounds to limit regression line and its confident/prediction lines within a specific bounds in model space |
extended? | boolean | the flag if extend x limits of curve to the limits of shape's model limits |
horizontallogmode? | boolean | Log mode in horizontal direction |
infinity? | boolean | infinity mode flag to draw regression line outside the model limits |
plotinterval? | number | the interval of sampling x when drawing curve |
predictionline? | ProbabilityLineOptions | options for prediction line |
regressionline? | LineOptions | options for regression line |
regressionmodel? | Options & { order?: number ; type?: RegressionBase | PredictFunction | typeof RegressionBase } | options for regression model |
residualline? | ResidualLine | Residual line setting for the line connecting data point with regression line |
verticallogmode? | boolean | Log mode in vertical direction |
Ƭ OptionsBaseOut: Object
| Name | Type | Description |
|---|---|---|
autolimits | boolean | Deprecated since 4.1 |
confidenceline | ProbabilityLineOptions | - |
databounds | Rect | - |
extended | boolean | - |
horizontallogmode | boolean | - |
infinity | boolean | - |
plotinterval | number | - |
predictionline | ProbabilityLineOptions | - |
regressionline | LineOptionsOut | - |
regressionmodel | OptionsOut & { type: RegressionBase } | - |
residualline | ResidualLineOut | - |
verticallogmode | boolean | - |
Ƭ OptionsOut: OptionsOut & OptionsBaseOut & DataOptions
properties
Ƭ ProbabilityLabelOptions: Object
Probability line label options for confidence or prediction line
| Name | Type | Description |
|---|---|---|
lower? | LabelOptions | Probability line lower label options |
upper? | LabelOptions | Probability line upper label options |
Ƭ ProbabilityLineOptions: Omit<LineOptions, "label"> & { custompredict?: { lower?: PredictFunction ; upper?: PredictFunction } ; fillstyle?: Type ; label?: ProbabilityLabelOptions ; probability?: Probability }
options
Ƭ ProbabilityLineOptionsOut: Omit<LineOptions, "label"> & { custompredict?: { lower?: PredictFunction ; upper?: PredictFunction } ; fillstyle?: FillStyle ; label?: ProbabilityLabelOptions ; probability?: Probability }
options
Ƭ ResidualLine: Object
Residual line setting for the line connecting data point with regression line
| Name | Type | Description |
|---|---|---|
linestyle? | Type | Residual line line style |
margin? | { end?: number ; start?: number } | Margin of residual line from the data point and from regression line |
margin.end? | number | Margin of residual line from the regression line |
margin.start? | number | Margin of residual line from the data point |
mode? | ResidualLineMode | Residual line mode |
visible? | boolean | Whether residual lines should be visible |
Ƭ ResidualLineOut: Object
Residual line setting for the line connecting data point with regression line
| Name | Type | Description |
|---|---|---|
linestyle? | LineStyle | Residual line line style |
margin? | { end?: number ; start?: number } | Margin of residual line from the data point and from regression line |
margin.end? | number | Margin of residual line from the regression line |
margin.start? | number | Margin of residual line from the data point |
mode? | ResidualLineMode | Residual line mode |
visible? | boolean | Whether residual lines should be visible |