Configurator.context¶
- Configurator.context(*args, mode=0, file=None, **kwargs)[source]¶
Temporarily modify the rc settings in a “with as” block.
- Parameters
- Other Parameters
mode (
{0, 1, 2}
, optional) – The context mode. Dictates the behavior offind
,fill
, andcategory
within a “with as” block when called withcontext=True
.The options are as follows:
Matplotlib’s
rc_matplotlib
settings and ProPlotsrc_proplot
settings are all returned, whether or notcontext
has changed them.Unchanged
rc_matplotlib
settings returnNone
butrc_proplot
settings are returned whether or notcontext
has changed them. This is used in the__init__
call toformat
. When a lookup returnsNone
,format
does not apply it.All unchanged settings return
None
. This is used during user calls toformat
.
Note
This is used by ProPlot internally but may also be useful for power users. It was invented to prevent successive calls to
format
from constantly looking up and re-applying unchanged settings. These gratuitous lookups increased runtime significantly, and resulted in successive calls toformat
overwriting the previous calls.Example
The below applies settings to axes in a specific figure using
context
.>>> import proplot as pplt >>> with pplt.rc.context(ticklen=5, metalinewidth=2): >>> fig, ax = pplt.subplots() >>> ax.plot(data)
The below applies settings to a specific axes using
format
, which usescontext
internally.>>> import proplot as pplt >>> fig, ax = pplt.subplots() >>> ax.format(ticklen=5, metalinewidth=2)