Skip to content

Commit abd1903

Browse files
committed
move dependent variable documentation to their respective marks; new lines
1 parent 0549441 commit abd1903

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

src/marks/linearRegression.d.ts

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,21 @@ import type {BinOptions, BinReducer} from "../transforms/bin.js";
44

55
/** Options for the linearRegressionX and linearRegressionY marks. */
66
interface LinearRegressionOptions extends MarkOptions, BinOptions {
7-
/**
8-
* A channel for the dependent variable **x**.
9-
*/
10-
x?: ChannelValueSpec;
11-
/**
12-
* A channel for the dependent variable **y**.
13-
*/
14-
y?: ChannelValueSpec;
157
/**
168
* The series, for multiple regressions.
179
*/
1810
z?: ChannelValue;
11+
1912
/**
2013
* The confidence interval in [0, 1), or 0 to hide bands; defaults to 0.95.
2114
*/
2215
ci?: number;
16+
2317
/**
2418
* The distance (in pixels) between samples of the confidence band; defaults to 4.
2519
*/
2620
precision?: number;
21+
2722
/**
2823
* Reducer for when the independent variable is binned with an **interval**. For example, to create a trend line on the maximum value of the AAPL ticker by month:
2924
*
@@ -40,6 +35,11 @@ export interface LinearRegressionXOptions extends LinearRegressionOptions {
4035
* A channel for the independent variable **y**.
4136
*/
4237
y?: ChannelValueDenseBinSpec;
38+
39+
/**
40+
* A channel for the dependent variable **x**.
41+
*/
42+
x?: ChannelValueSpec;
4343
}
4444

4545
/** Options for the linearRegressionY mark. */
@@ -48,6 +48,11 @@ export interface LinearRegressionYOptions extends LinearRegressionOptions {
4848
* A channel for the independent variable **y**.
4949
*/
5050
x?: ChannelValueDenseBinSpec;
51+
52+
/**
53+
* A channel for the dependent variable **y**.
54+
*/
55+
y?: ChannelValueSpec;
5156
}
5257

5358
/**

0 commit comments

Comments
 (0)