Skip to content

Interface: TrendlineResult ​

One OLS fit of a figure, as a row of px's get_trendline_results DataFrame.

Properties ​

PropertyModifierTypeDescription
fitreadonlyOlsFitThe fit: coefficients, R², standard errors, p-values, … (statsmodels' OLSResults).
frame?readonlystringName of the frame the fit belongs to, for animated figures.
groupsreadonlyReadonly<Record<string, string>>The group the line was fit on: { sex: 'Female', day: 'Sun' } by column label (the grouping, facet and frame columns), empty for the overall trendline.
logXreadonlybooleanWhether x (y) was fit on its log10 (trendlineOptions.logX / logY).
logYreadonlyboolean-
traceIndexreadonlynumberIndex of the trendline trace in figure.data (and in each frame's data).

Released under the MIT License.