[FEATURE]: autorangePadding — Explicit Control and Introspection of Autorange Padding
Summary
When autorange: true is set on an axis, Plotly silently adds a padding fraction
around the data range. This padding is internally computed, never documented as a
configurable value, and impossible to query without using full_figure_for_development().
This issue proposes:
- A new per-axis layout attribute
autorangePadding to give users explicit control
over the padding fraction
- Exposure of the computed padding via
get_computed_values() for introspection
Problem Statement
Autorange padding causes subtle but persistent issues in several common workflows:
Problem 1 — Multi-figure axis alignment:
Two figures sharing a conceptual x-axis (e.g. a price chart above a volume chart)
will not align perfectly even when their data ranges are identical, because autorange
applies padding independently on each figure. There is no way to force consistent
padding without disabling autorange entirely.
Problem 2 — Controlled range extension:
A user wants autorange but needs extra space on one side for an annotation or legend.
Currently this is impossible without computing the full data range manually and setting
a fixed range — defeating the purpose of autorange.
Problem 3 — Range introspection in production:
Users who need the exact rendered axis range must use full_figure_for_development(),
which is explicitly documented as not for production use. There is no lightweight
alternative.
Proposed Solution
1. New Layout Attribute: autorangePadding
Set per axis as a fraction of the total data range:
fig.update_layout(
xaxis=dict(
autorange=True,
autorangePadding=0.05 # 5% padding each side — matches current default behavior
),
yaxis=dict(
autorange=True,
autorangePadding=0.0 # no padding — data fills axis edge to edge
)
)
Default value matches the current implicit behavior so all existing figures are
unaffected.
Asymmetric Padding
For cases where padding is only needed on one side:
fig.update_layout(
yaxis=dict(
autorange=True,
autorangePadding=dict(before=0.0, after=0.15) # extra headroom at top only
)
)
before = lower end of the axis, after = upper end, regardless of axis direction.
2. Introspection via get_computed_values()
computed = fig.get_computed_values(include=["axis_ranges", "autorange_padding"])
Returns:
{
"axis_ranges": {
"xaxis": [-0.5, 10.5],
"yaxis": [-4.35, 102.1]
},
"autorange_padding": {
"xaxis": {
"before": 0.05,
"after": 0.05,
"pixels": {"before": 18.4, "after": 18.4}
},
"yaxis": {
"before": 0.05,
"after": 0.05,
"pixels": {"before": 14.2, "after": 14.2}
}
}
}
Both fractional and pixel values are returned, making the result useful for
data-space alignment and pixel-space layout work respectively.
3. Companion Utility: match_axis_ranges() (Optional)
A natural extension that syncs axis ranges across multiple figures:
import plotly.utils as pu
pu.match_axis_ranges([fig1, fig2], axis="x")
Computes the union of both figures' data ranges and applies a consistent range to both
so they align exactly — the most common use case motivating this feature.
Relationship to get_computed_values()
This feature is a direct extension of the get_computed_values() proposal:
axis_ranges already proposes returning the final rendered range
autorange_padding extends that with a breakdown of how much of the range is
padding vs. actual data span
autorangePadding is the write-side complement to the read-side introspection
Together they give full round-trip control: set the padding you want, then verify
exactly what was applied.
Prior Art
| Tool |
Equivalent |
matplotlib |
ax.margins(x=0.05) sets padding; ax.get_xlim() returns final range |
Vega-Lite |
Explicit "padding" property on scale definitions |
D3.js |
scale.nice() and direct scale.domain() control |
Backward Compatibility
autorangePadding is a new optional attribute. Omitting it preserves current behavior exactly.
- No existing figures, layouts, or workflows are affected unless users explicitly opt in.
Acceptance Criteria
Related Issues
I am happy to discuss the naming convention for autorangePadding vs autorange_padding
to match the existing attribute style guide, and whether the match_axis_ranges()
utility belongs in this issue or a separate one.
[FEATURE]:
autorangePadding— Explicit Control and Introspection of Autorange PaddingSummary
When
autorange: trueis set on an axis, Plotly silently adds a padding fractionaround the data range. This padding is internally computed, never documented as a
configurable value, and impossible to query without using
full_figure_for_development().This issue proposes:
autorangePaddingto give users explicit controlover the padding fraction
get_computed_values()for introspectionProblem Statement
Autorange padding causes subtle but persistent issues in several common workflows:
Problem 1 — Multi-figure axis alignment:
Two figures sharing a conceptual x-axis (e.g. a price chart above a volume chart)
will not align perfectly even when their data ranges are identical, because autorange
applies padding independently on each figure. There is no way to force consistent
padding without disabling autorange entirely.
Problem 2 — Controlled range extension:
A user wants autorange but needs extra space on one side for an annotation or legend.
Currently this is impossible without computing the full data range manually and setting
a fixed range — defeating the purpose of autorange.
Problem 3 — Range introspection in production:
Users who need the exact rendered axis range must use
full_figure_for_development(),which is explicitly documented as not for production use. There is no lightweight
alternative.
Proposed Solution
1. New Layout Attribute:
autorangePaddingSet per axis as a fraction of the total data range:
Default value matches the current implicit behavior so all existing figures are
unaffected.
Asymmetric Padding
For cases where padding is only needed on one side:
before= lower end of the axis,after= upper end, regardless of axis direction.2. Introspection via
get_computed_values()Returns:
{ "axis_ranges": { "xaxis": [-0.5, 10.5], "yaxis": [-4.35, 102.1] }, "autorange_padding": { "xaxis": { "before": 0.05, "after": 0.05, "pixels": {"before": 18.4, "after": 18.4} }, "yaxis": { "before": 0.05, "after": 0.05, "pixels": {"before": 14.2, "after": 14.2} } } }Both fractional and pixel values are returned, making the result useful for
data-space alignment and pixel-space layout work respectively.
3. Companion Utility:
match_axis_ranges()(Optional)A natural extension that syncs axis ranges across multiple figures:
Computes the union of both figures' data ranges and applies a consistent range to both
so they align exactly — the most common use case motivating this feature.
Relationship to
get_computed_values()This feature is a direct extension of the
get_computed_values()proposal:axis_rangesalready proposes returning the final rendered rangeautorange_paddingextends that with a breakdown of how much of the range ispadding vs. actual data span
autorangePaddingis the write-side complement to the read-side introspectionTogether they give full round-trip control: set the padding you want, then verify
exactly what was applied.
Prior Art
matplotlibax.margins(x=0.05)sets padding;ax.get_xlim()returns final rangeVega-Lite"padding"property on scale definitionsD3.jsscale.nice()and directscale.domain()controlBackward Compatibility
autorangePaddingis a new optional attribute. Omitting it preserves current behavior exactly.Acceptance Criteria
autorangePaddingaccepted as a per-axis layout attribute (scalar or asymmetric dict)get_computed_values(include=["autorange_padding"])match_axis_ranges()utility considered as a follow-up or included in scopeRelated Issues
[FEATURE]: get_computed_values()([FEATURE]: Access values calculated / derived by plotly.js as part of plotting #5552)[FEATURE]: get_subplot_geometry()([FEATURE]: get_subplot_geometry() #5554)