6Dh! 4 S r / SQrS rS rS rS rS rS rg) a
The `trendline_functions` module contains functions which are called by Plotly Express
when the `trendline` argument is used. Valid values for `trendline` are the names of the
functions in this module, and the value of the `trendline_options` argument to PX
functions is passed in as the first argument to these functions when called.
Note that the functions in this module are not meant to be called directly, and are
exposed as part of the public API for documentation purposes.
)olslowessrollingewm expandingc SSK n/ SQnU R 5 H+ n X; d M
[ SSR U5 < SU < S35 e SSKJn
U R
SS 5 n U R
S
S 5 n U R
S S 5 n
U
( a: UR US:* 5 ( a [ S
5 eUR U5 nSU- nU ( a: UR US:* 5 ( a [ S5 eUR U5 nSU- nU ( a U
R U5 nU
R X2SS9R 5 nUR 5 nU
( a UR SU5 nSn[ UR 5 S:X a' USUUR S UUR S 4- -
nO5U ( d USX^R S U4- -
nOUSX^R S 4- -
nUSUR - -
nUUU4$ )a Ordinary Least Squares (OLS) trendline function
Requires `statsmodels` to be installed.
This trendline function causes fit results to be stored within the figure,
accessible via the `plotly.express.get_trendline_results` function. The fit results
are the output of the `statsmodels.api.OLS` function.
Valid keys for the `trendline_options` dict are:
- `add_constant` (`bool`, default `True`): if `False`, the trendline passes through
the origin but if `True` a y-intercept is fitted.
- `log_x` and `log_y` (`bool`, default `False`): if `True` the OLS is computed with
respect to the base 10 logarithm of the input. Note that this means no zeros can
be present in the input.
N) add_constantlog_xlog_yz+OLS trendline_options keys must be one of [, ] but got ''r Tr
Fr zOCan't do OLS trendline with `log_y=True` when `y` contains non-positive values.z log10(%s)zPCan't do OLS trendline with `log_x=True` when `x` contains non-positive values.drop)missing
zOLS trendline
z%s = %g * %s + %g
z%s = %g * %s
z %s = %g
zR2=%f
)numpykeys
ValueErrorjoinstatsmodels.apiapigetanylog10r OLSfitpredictpowerlenparamsrsquared)trendline_optionsx_rawxyx_labely_label non_missingnp
valid_optionsksmr r
r fit_resultsy_out hover_headers ]/var/www/html/env/lib/python3.13/site-packages/plotly/express/trendline_functions/__init__.pyr r s $ 6M
#
#
% ! 99]+Q0
& !$(( >L ! !'5 1E ! !'5 1E
66!q&>> a
HHQK '
66!q&>> b
HHQK ' OOA &&v&.224K !E U#-L
; !#/ q ! q ! 3
*g7I7I!7Lg-VVV
2D2DQ2G(HHH .1E1EEEL , ++ c S/nU R 5 H+ nX; d M
[ SSR U5 < SU< S35 e SSKJn U R SS5 n
U R R X2S U
S
9SS2S 4 n S n XS4$ )
a LOcally WEighted Scatterplot Smoothing (LOWESS) trendline function
Requires `statsmodels` to be installed.
Valid keys for the `trendline_options` dict are:
- `frac` (`float`, default `0.6666666`): the `frac` parameter from the
`statsmodels.api.nonparametric.lowess` function
fracz.LOWESS trendline_options keys must be one of [r r
r r Ng1UU?r )r r5 r z LOWESS trendline
)r r r r r r
nonparametricr )
r$ r% r& r' r( r) r* r, r- r. r5 r0 r1 s
r2 r r T s HM
#
#
% ! 99]+Q0
& ! 3D # #A&t # DQT JE4L $$r3 c SS K n SS Kn[ SSSS9nUR 5 nUR SS5 n UR S [ 5 5 n
UR
UR U5 UR 5 S
9n [ X5 n U " S0 UD6n
[ X5 nU" S0 U
D6nX nS X < S U < S
3nUUS 4$ ! [ a Sn[ U5 ef = f)Nr z)Trendline requires pandas to be installedRollingzExponentially Weighted Expanding)r r r functionmean
function_args)indexz z trendline
) r pandas ImportErrordictcopypopSeries to_pandasgetattr)moder$ r% r' r* r+ pdmsgmodes
function_namer< seriesaggagg_objr: r0 r1 s r2 _pandasrP o s
(@K XE)..0%))*f=M%))/46BM
YYrwwqz ):Y
;F &
C&%&Gw.H %} %E E7<{MRL , $$+ 9# s B: :Cc [ SXX65 $ )aS Rolling trendline function
The value of the `function` key of the `trendline_options` dict is the function to
use (defaults to `mean`) and the value of the `function_args` key are taken to be
its arguments as a dict. The remainder of the `trendline_options` dict is passed as
keyword arguments into the `pandas.Series.rolling` function.
r rP r$ r% r& r' r( r) r* s r2 r r s 9 / GGr3 c [ SXX65 $ )aW Expanding trendline function
The value of the `function` key of the `trendline_options` dict is the function to
use (defaults to `mean`) and the value of the `function_args` key are taken to be
its arguments as a dict. The remainder of the `trendline_options` dict is passed as
keyword arguments into the `pandas.Series.expanding` function.
r rR rS s r2 r r s ; 1! IIr3 c [ SXX65 $ )ak Exponentially Weighted Moment (EWM) trendline function
The value of the `function` key of the `trendline_options` dict is the function to
use (defaults to `mean`) and the value of the `function_args` key are taken to be
its arguments as a dict. The remainder of the `trendline_options` dict is passed as
keyword arguments into the `pandas.Series.ewm` function.
r rR rS s r2 r r s 5+A CCr3 N)__doc____all__r r rP r r r r? r3 r2 rX s4 ;C,L%6%:HJDr3