README- UArtist
- UAxes
- UAxis
- UBounds
- UCategoryAxis
- UContourSet
- UDataError
- UDrawing
- UFigure
- UFormatter
- UGridSpec
- UHistogram
- UHitPoint
- ULayoutError
- ULegendPosition
- ULimits
- ULine2D
- ULineData
- ULineStroke
- UMaskError
- UMaskedArray
- UMaskedMatrix
- UPoint
- URect
- URgb
- URgba
- UScale
- USecondaryAxis
- USecondaryAxisAlignment
- USecondaryAxisLocation
- USeries
- UStreamplotSet
- UStyle
- USubFigure
- UViolinBandwidth
- UViolinSide
- UViolinStats
- Vasinh_scale
- Vaxis
- Vbounds
- Vbounds_from_points
- Vcategory
- Veng_formatter
- Vfigure
- Vfixed_formatter
- Vformat_str_formatter
- Vfunc_formatter
- Vgridspec
- Vindex_formatter
- Vlimits
- Vline_stroke
- Vlinear_scale
- Vlog_formatter
- Vlog_scale
- Vlogit_scale
- Vmasked_array
- Vmasked_matrix
- Vnull_formatter
- Vpercent_formatter
- Vplot_svg
- Vpoint
- Vrgb
- Vrgba
- Vscalar_formatter
- Vseries
- Vstr_method_formatter
- Vstyle
Lampese/mathplotlib/scene does not have a README file
LegendPosition
Legend placement is a public value shared with render backends.
Anchor
pub(all) enum Anchor {
Named(String)
Fraction(Double, Double)
}An axes anchor, measured within the space left by aspect shrinking.
Named accepts C, SW, S, SE, E, NE, N, NW, or W. Fraction stores a pair
relative to the original box: x=0 is left, y=0 is bottom. Finite values
outside [0, 1] place the active box outside the allocated rectangle.
Annotation
pub struct Annotation {
x : Double
y : Double
text_x : Double
text_y : Double
value : String
xycoords : String
textcoords : String
connector : String
arrow : Bool
arrowcolor : String
linewidth : Double
head_length : Double
head_width : Double
style : Style
}An annotation whose anchor and text may use display-relative coordinates.
Artist
pub(all) enum Artist {
Line(Array[Point], Style)
Scatter(Array[Point], Style)
PathCollection(PathCollection)
Bar(Array[Point], Style)
BarH(Array[Point], Style)
FillBetween(Array[Point], Array[Point], Style)
Polygon(Array[Point], Style)
CompoundPolygon(Array[Array[Point]], Style)
GouraudTriangle(Array[Point], Array[String])
HLine(Double, Style)
VLine(Double, Style)
AxLine(Point, Point, Style)
HSpan(Double, Double, Style)
VSpan(Double, Double, Style)
Text(Double, Double, String, Style)
Annotation(Annotation)
ErrorBar(Array[Point], Array[Double], Array[Double], Style)
Image(Array[Array[Double]], Double?, Double?, ColorMap)
ImageNorm(Array[Array[Double]], ColorNorm, ColorMap, ImageOrigin, (Double, Double, Double, Double)?, Double, ImageInterpolation)
ColorImage(Array[Array[Rgba]], ImageOrigin, (Double, Double, Double, Double)?, Double, ImageInterpolation)
Table(Table)
Pie(Array[Double], Array[String], Array[String], Double)
BoxPlot(Array[BoxStats], Bool, Style)
Quiver(Array[Point], Array[Point], Style)
Violin(Array[ViolinStats], Array[Double], Array[Double], Bool, ViolinSide, Bool, Bool, Bool, Style, Style, Double)
}A plotting primitive stored by a figure.
Axes
A handle to one independent plotting panel in a figure.
Axes::acorr
Plot and return a normalized autocorrelation sequence.
detrend receives an owned copy of the samples and must return an array of
the same length. Use detrend_mean for the common mean-removal case.
Axes::annotate
fn Axes::annotate(self : Axes, value : String, x : Double, y : Double, offset_x? : Double, offset_y? : Double, arrow? : Bool, color? : String, arrowcolor? : String, linewidth? : Double, head_length? : Double, head_width? : Double, fontsize? : Int, xycoords? : String, textcoords? : String, connector? : String) -> Unit raise DataErrorAdd text at a data point, optionally connected by an arrow.
Axes::apply_aspect
Apply aspect immediately, updating active position and datalim views.
Detached handles or unrepresentable transformed ranges raise DataError.
In datalim mode x_limits/y_limits expose the resolved view after this call.
test {
let fig = @scene.figure(width=400, height=200)
let ax = try! fig.add_axes(0.0, 0.0, 1.0, 1.0)
try! ax.plot([0.0, 1.0], [0.0, 1.0])
try! ax.set_xlim(0.0, 1.0)
try! ax.set_ylim(0.0, 1.0)
try! ax.set_aspect(1.0, adjustable="datalim")
try! ax.apply_aspect()
assert_eq(ax.get_xlim().unwrap().lower(), -0.5)
assert_eq(ax.get_position().unwrap().width(), 1.0)
}Axes::arrow
Draw one data-coordinate arrow from (x, y) by (dx, dy).
Axes::artists
Return this panel's artists in insertion order.
Axes::aspect_equal
Return whether this axes panel uses equal data scaling.
Axes::autoscale
Enable automatic limits and request them lazily. None preserves both flags.
Tight requests zero only the selected local margins; autoscale_view does not.
Axes::autoscale_view
Recompute selected automatic views now, using cached shared data intervals.
axis is a compatibility selector combined with scalex/scaley.
Axes::axhline
Add a horizontal reference line through the axes view.
Axes::axhspan
Fill the horizontal span between two y values across the axes.
Axes::axis_visible
Return whether this panel's primary axis decorations are visible.
Axes::axline
Draw an infinitely long line through one or two data points.
Axes::axvline
Add a vertical reference line through the axes view.
Axes::axvspan
Fill the vertical span between two x values across the axes.
Axes::bar
Add bars through the axes view.
Axes::bar_category
Add bars whose x coordinates are string categories.
Axes::bar_category_y
Add bars whose y coordinates are string categories.
Axes::barbs
Draw basic wind barbs for paired data-coordinate vectors.
Axes::barbs_with_options
fn Axes::barbs_with_options(self : Axes, xs : Array[Double], ys : Array[Double], us : Array[Double], vs : Array[Double], color? : String, linewidth? : Double, barb_length? : Double, label? : String, half_increment? : Double, full_increment? : Double, flag_increment? : Double, rounding? : Bool, flip? : Bool, fill_empty? : Bool, pivot? : String) -> Unit raise DataErrorDraw wind barbs with magnitude increments, pivot, flip, and calm-barb
options. The default increments match Matplotlib's half/full/flag values.
Axes::barh
Add horizontal bars through the axes view.
Axes::boxplot
Draw box-and-whisker plots for one or more value series.
Axes::broken_barh
Draw horizontal broken bars through the axes view.
Axes::clabel
fn Axes::clabel(self : Axes, contours : ContourSet, inline? : Bool, fontsize? : Int, color? : String) -> Unit raise DataErrorAdd one text label at a representative segment for each contour level.
Axes::clear
Clear this axes' artists and presentation state while retaining its panel
rectangle and shared-axis membership.
Axes::clear_checked
Reset this panel through the source-ordered coordinate clear lifecycle.
Already performed mutations remain observable if a checked provider fails.
Axes::color_cycle
Return a copy of the current property color cycle.
Axes::containers
Return composite containers created on this axes panel.
Axes::contour
fn Axes::contour(self : Axes, data : Array[Array[Double]], x? : Array[Double], y? : Array[Double], levels? : Array[Double], nlevels? : Int, color? : String, linewidth? : Double, label? : String, corner_mask? : Bool, locator? : Locator?, colors? : Array[String], linewidths? : Array[Double]) -> ContourSet raise DataErrorDraw contour lines over a regular rectangular grid on this axes.
Axes::contourf
Draw filled contour bands over a regular rectangular grid on this axes.
Axes::data_limits
Cached raw data limits, independent of viewport and displayed scale.
Axes::data_minpos
Cached minimum positive raw coordinate, including interior artist points.
Axes::ecdf
Plot and return an empirical cumulative distribution function.
Axes::errorbar
Add error bars through the axes view.
Axes::eventplot
Draw parallel event markers through the axes view.
Axes::fill
Fill a closed polygon through the axes view.
Axes::fill_between
Fill an area through the axes view.
Axes::fill_between_masked
fn Axes::fill_between_masked(self : Axes, xs : MaskedArray, lower : MaskedArray, upper : MaskedArray, color? : String, label? : String) -> Unit raise DataErrorFill between masked lower and upper arrays through the axes view.
Axes::fill_betweenx
Fill the area between two x series through the axes view.
Axes::fill_betweenx_masked
fn Axes::fill_betweenx_masked(self : Axes, ys : MaskedArray, left : MaskedArray, right : MaskedArray, color? : String, label? : String) -> Unit raise DataErrorFill between masked left and right arrays through the axes view.
Axes::get_adjustable
Return "box" or "datalim" for the aspect adjustment strategy.
test {
assert_eq(@scene.figure().axes().get_adjustable(), "box")
}Axes::get_anchor
Return the anchor in the same Named or Fraction form supplied by the caller.
test {
let ax = @scene.figure().axes()
assert_true(ax.get_anchor() is @scene.Anchor::Named("C"))
try! ax.set_anchor(@scene.Anchor::Fraction(0.25, 0.75))
assert_true(ax.get_anchor() is @scene.Anchor::Fraction(0.25, 0.75))
}Axes::get_aspect
Return the numeric y/x display scale ratio, or None for automatic aspect.
Matplotlib's "auto" maps to None and "equal" to Some(1.0).
test {
let ax = @scene.figure().axes()
assert_true(ax.get_aspect() is None)
ax.set_aspect_equal()
assert_eq(ax.get_aspect(), Some(1.0))
ax.set_aspect_auto()
assert_true(ax.get_aspect() is None)
}Axes::get_box_aspect
Return the physical box height/width constraint, or None if disabled.
test {
let ax = @scene.figure().axes()
assert_true(ax.get_box_aspect() is None)
try! ax.set_box_aspect(aspect=2.0)
assert_eq(ax.get_box_aspect(), Some(2.0))
}Axes::get_legend_handles_labels
Return the effective legend entries for this axes.
Axes::get_margins
Return the automatic (x, y) margins for this axes.
Axes::get_position
Return a normalized Figure rectangle with a lower-left origin.
The returned Rect stores (left, bottom, width, height), unlike rect(),
which returns the allocated display rectangle in pixels from the top left.
original=true returns the allocated position. The default active position
applies the same data/physical-aspect geometry as SVG rendering.
Autoscale margins, shared limits, and image bounds are resolved by the
existing renderer. Detached axes or nonpositive Figure dimensions return
None. SubFigure axes currently use coordinates of the root Figure.
Aspect-resolution failures return None; apply_aspect preserves DataError.
test {
let fig = @scene.figure(width=400, height=200)
let ax = try! fig.add_axes(0.25, 0.25, 0.5, 0.5)
try! ax.set_xlim(0.0, 1.0)
try! ax.set_ylim(0.0, 1.0)
ax.set_aspect_equal()
assert_eq(ax.get_position(original=true).unwrap().width(), 0.5)
assert_eq(ax.get_position().unwrap().width(), 0.25)
}Axes::get_xlim_checked
Read the resolved x viewport, propagating checked provider errors.
Axes::get_ylim_checked
Read the resolved y viewport, propagating checked provider errors.
Axes::grid
Configure major or minor grid lines for this axes panel.
which accepts "both", "x", "y", "major", or "minor".
axis selects "both", "x", or "y" with the default or major/minor mode.
The legacy which="x"/"y" selectors require the default axis="both".
Shared axes propagate the corresponding setting to their linked panels.
Axes::hexbin
fn Axes::hexbin(self : Axes, xs : Array[Double], ys : Array[Double], values? : Array[Double], gridsize? : Int, mincnt? : Int, cmap? : String, vmin? : Double, vmax? : Double, color? : String, label? : String, reduce? : String, edgecolor? : String, linewidth? : Double, bins? : String, extent? : Array[Double], marginals? : Bool, reduce_fn? : HexbinReducer?) -> Hexbin raise DataErrorBin points into a regular hexagonal grid and add filled polygons.
Axes::hist
Compute and draw a histogram on this axes panel.
Axes::hist2d
Compute and draw a rectangular two-dimensional histogram.
Axes::hlines
Draw horizontal line segments at the supplied y positions.
Axes::imshow
Add a scalar image through the axes view.
Axes::imshow_color
Alias for the typed RGBA axes entry point.
Axes::imshow_masked
fn Axes::imshow_masked(self : Axes, data : MaskedMatrix, vmin? : Double, vmax? : Double, cmap? : String, origin? : String, extent? : Array[Double], aspect? : String, alpha? : Double, interpolation? : String) -> Unit raise DataErrorAdd a masked scalar image through the axes view.
Axes::imshow_masked_with_colormap
Add a masked scalar image through the axes view using a custom colormap.
Axes::imshow_masked_with_norm
Add a masked scalar image through the axes view with explicit normalization.
Axes::imshow_masked_with_norm_and_colormap
Add a masked scalar image through the axes view with explicit normalization
and colormap objects.
Axes::imshow_rgb
Add an opaque RGB image through an axes handle.
Axes::imshow_rgb_channels
Add an RGB image from raw normalized three-channel pixels through axes.
Axes::imshow_rgba
Add a prevalidated RGBA image through an axes handle.
Axes::imshow_rgba_channels
Add an RGBA image from raw normalized four-channel pixels through axes.
Axes::imshow_with_colormap
Add a scalar image through the axes view using a colormap object.
Axes::imshow_with_norm
Add a scalar image through the axes view with an explicit normalization.
Axes::imshow_with_norm_and_colormap
Add a scalar image through the axes view with explicit normalization and
colormap objects.
Axes::is_attached
Return whether this handle still belongs to its figure's axes list.
Replacing a figure's subplot grid detaches its previous handles.
Removing a panel also detaches all handles that refer to it.
test {
let fig = @scene.figure()
let old = fig.axes()
assert_true(old.is_attached())
let panels = try! fig.subplots(1, 2)
assert_true(!old.is_attached())
assert_true(panels[0].is_attached())
}Axes::legend
Alias for set_legend matching the pyplot vocabulary.
Axes::legend_entries
Return the legend entries that would be rendered for this axes.
Axes::legend_position
Return this axes' legend anchor, initially UpperRight.
Axes::line
Add explicit line points through the axes view.
Axes::loglog
Add a plot with logarithmic x and y coordinates.
Axes::margins
Return the automatic margins as an (x, y) pair.
Axes::matshow
Display a two-dimensional matrix with zero-based row and column indices.
The first row is rendered at the top, x tick labels are placed above the
image, and one data unit has the same display size on both axes. The
interpolation accepts the same filter names as imshow.
Axes::pcolor
Draw scalar values as filled quadrilaterals on a rectangular grid.
Axes::pcolor_grid
Draw a scalar mesh on a two-dimensional coordinate grid.
Axes::pcolor_grid_masked
fn Axes::pcolor_grid_masked(self : Axes, data : MaskedMatrix, x : MaskedMatrix, y : MaskedMatrix, shading? : String, vmin? : Double, vmax? : Double, cmap? : String, antialiased? : Bool) -> Unit raise DataErrorDraw a masked scalar mesh through the axes view.
Axes::pcolor_masked
Draw a masked scalar mesh through the axes view.
Axes::pcolor_masked_with_norm_and_colormap
Draw a masked scalar mesh through the axes view with explicit objects.
Axes::pcolor_with_norm
Draw a scalar mesh through the axes view with explicit normalization.
Axes::pcolor_with_norm_and_colormap
Draw a scalar mesh through the axes view with explicit normalization.
Axes::pcolormesh
Draw a fast rectangular scalar mesh.
Axes::pcolormesh_grid
Draw a fast scalar mesh on a two-dimensional coordinate grid.
Axes::pcolormesh_grid_masked
fn Axes::pcolormesh_grid_masked(self : Axes, data : MaskedMatrix, x : MaskedMatrix, y : MaskedMatrix, shading? : String, vmin? : Double, vmax? : Double, cmap? : String, antialiased? : Bool) -> Unit raise DataErrorDraw a fast masked scalar mesh through the axes view.
Axes::pcolormesh_masked
Draw a masked rectangular scalar mesh through the axes view.
Axes::pcolormesh_masked_with_norm_and_colormap
Draw a masked rectangular mesh through the axes view with explicit objects.
Axes::pcolormesh_with_norm
Draw a fast scalar mesh through the axes view with explicit normalization.
Axes::pcolormesh_with_norm_and_colormap
Draw a fast scalar mesh through the axes view with explicit normalization.
Axes::pie
Draw a pie chart and return the normalized slice fractions.
Axes::plot
Add a line plot through the axes view.
Axes::plot_category
Add a line whose x coordinates are string categories.
Axes::plot_category_y
Add a line whose y coordinates are string categories.
Axes::plot_date
Plot date values on the default axes using Matplotlib day ordinals.
Axes::plot_date_units
Plot dates while retaining the distinction between naive and aware inputs.
Empty ordinary arrays do not choose a registry converter.
Axes::plot_line
Attach a typed Line with the existing equal-length initial plot contract.
Axes::plot_masked
fn Axes::plot_masked(self : Axes, xs : MaskedArray, ys : MaskedArray, color? : String, label? : String) -> Unit raise DataErrorPlot paired masked arrays through the axes view.
Axes::quiver
Draw arrows for a vector field sampled at paired x/y positions.
Axes::quiverkey
Draw a vector key arrow and label through the axes view.
Axes::rect
Return the allocated display rectangle in pixels, with a top-left origin.
This includes manual position updates but does not apply aspect shrinking.
The implicit default panel returns None until laid out or positioned.
Axes::relim
Rebuild cached data limits from the currently attached geometry.
This does not request a view update or enable autoscaling.
Optionally skip hidden registered Lines before querying their pending data.
Axes::relim_checked
Rebuild data limits in artist order, retaining a merged prefix on failure.
Axes::remove
Remove this panel from its Figure and any containing SubFigure.
Other handles to this panel become detached; its artists remain inspectable.
Repeated removal raises InvalidReference. figure() retains the source Figure
as provenance, and does not imply continued attachment.
test {
let fig = @scene.figure()
let ax = try! fig.add_axes(0.25, 0.25, 0.5, 0.5)
ax.set_title("removed")
try! ax.remove()
assert_true(!fig.to_svg().contains(">removed<"))
assert_eq(ax.title(), Some("removed"))
}Axes::request_autoscale_view
Schedule a lazy view update without enabling an axis or changing its viewport.
Axes::reset_position
Reset active to original, preserving the allocated position.
The next active-position read or draw reapplies the aspect constraint.
Detached handles raise DataError::InvalidReference.
test {
let ax = try! @scene.figure().add_axes(0.25, 0.25, 0.5, 0.5)
try! ax.set_position(0.0, 0.0, 0.25, 0.25, which="active")
try! ax.reset_position()
assert_eq(ax.get_position().unwrap().x(), 0.25)
}Axes::scatter
Add scatter points through the axes view.
Axes::scatter_category
Add scatter points whose x coordinates are string categories.
Axes::scatter_category_y
Add scatter points whose y coordinates are string categories.
Axes::scatter_collection
Add a per-point marker collection to this axes.
Axes::scatter_masked
fn Axes::scatter_masked(self : Axes, xs : MaskedArray, ys : MaskedArray, color? : String, label? : String) -> Unit raise DataErrorScatter paired masked arrays through the axes view.
Axes::secondary_xaxis
fn Axes::secondary_xaxis(self : Axes, forward : (Double) -> Double, inverse : (Double) -> Double, location? : SecondaryAxisLocation, transform? : Affine2D?) -> SecondaryAxis raise DataErrorAdd a secondary x axis derived from the primary x coordinate.
Axes::secondary_yaxis
fn Axes::secondary_yaxis(self : Axes, forward : (Double) -> Double, inverse : (Double) -> Double, location? : SecondaryAxisLocation, transform? : Affine2D?) -> SecondaryAxis raise DataErrorAdd a secondary y axis derived from the primary y coordinate.
Axes::semilogx
Add a plot with a logarithmic x coordinate and linear y coordinate.
Axes::semilogy
Add a plot with a linear x coordinate and logarithmic y coordinate.
Axes::set_adjustable
Choose whether fixed aspect shrinks the box or changes data limits.
mode is "box" (default) or "datalim". share updates direct x/y shared
siblings. datalim may overwrite fixed limits while retaining their direction
and automatic/explicit selection. Numeric two-axis sharing is rejected here, before
any changes, rather than failing during a later non-throwing draw.
clear retains the setting; new axes start with box adjustment.
test {
let ax = @scene.figure().axes()
try! ax.set_adjustable("datalim")
assert_eq(ax.get_adjustable(), "datalim")
ax.clear()
assert_eq(ax.get_adjustable(), "datalim")
}Axes::set_anchor
Place the aspect-constrained active box within its allocated rectangle.
The default is Named("C"). Named compass directions and finite Fraction
coordinates are accepted. Invalid anchors raise InvalidReference before
updating any panel. share=true updates direct x/y shared siblings.
With automatic aspect there is no free space, so the position is unchanged.
Clearing artists preserves the anchor, and new axes start at the center.
test {
let ax = try! @scene.figure(width=400, height=200).add_axes(
0.25, 0.25, 0.5, 0.5,
)
try! ax.set_xlim(0.0, 1.0)
try! ax.set_ylim(0.0, 1.0)
ax.set_aspect_equal()
try! ax.set_anchor(@scene.Anchor::Named("SW"))
assert_eq(ax.get_position().unwrap().x(), 0.25)
try! ax.set_anchor(@scene.Anchor::Fraction(1.0, 0.5))
assert_eq(ax.get_position().unwrap().x(), 0.5)
}Axes::set_aspect
Set the display size of one y data unit relative to one x data unit.
Values must be finite and positive; invalid input raises InvalidReference
without changing this panel or its shared siblings. With box adjustment,
the allocated box shrinks using the anchor, preserving data limits.
Datalim adjustment keeps the box and changes x or y view limits instead.
share=true updates the union of the panel's direct x/y shared siblings.
Use set_aspect_auto() for automatic aspect, or set_aspect_equal() for 1.
An optional anchor is validated and applied along with the ratio.
adjustable accepts "box" or "datalim"; omitted settings inherit this panel's
strategy and are propagated with share. The default anchor is the center.
test {
let fig = @scene.figure(width=400, height=200)
let ax = try! fig.add_axes(0.25, 0.25, 0.5, 0.5)
try! ax.set_xlim(0.0, 1.0)
try! ax.set_ylim(0.0, 1.0)
try! ax.set_aspect(2.0)
assert_eq(ax.get_aspect(), Some(2.0))
assert_eq(ax.get_position().unwrap().width(), 0.125)
assert_eq(ax.get_position(original=true).unwrap().width(), 0.5)
}Axes::set_aspect_auto
Restore automatic aspect handling for this axes panel.
share=true also restores the direct x/y shared siblings.
Axes::set_aspect_equal
Set an equal data aspect for this axes panel.
The SVG backend keeps one data unit equally sized on both axes and places
the resulting plot rectangle using the panel's anchor.
share=true also sets the direct x/y shared siblings to aspect 1.
Axes::set_axis_off
Hide the frame, ticks, labels, grid, and secondary axes for this panel.
Axes::set_axis_on
Show the frame, ticks, labels, grid, and secondary axes for this panel.
Axes::set_bounds
Set explicit limits for this panel.
Axes::set_box_aspect
Set the panel's physical height/width ratio, independently of data units.
Supply aspect=... with a positive finite value, or omit it to clear the box
constraint. Setting a value selects datalim adjustment; clearing it retains
the current strategy. This does not propagate to ordinary shared siblings.
clear retains the box ratio and new axes default to no constraint.
test {
let ax = try! @scene.figure(width=400, height=200).add_axes(
0.0, 0.0, 1.0, 1.0,
)
try! ax.set_box_aspect(aspect=1.0)
assert_eq(ax.get_position().unwrap().width(), 0.5)
assert_eq(ax.get_adjustable(), "datalim")
try! ax.set_box_aspect()
assert_eq(ax.get_position().unwrap().width(), 1.0)
}Axes::set_color_cycle
Replace the property color cycle used when a plot omits color.
Axes::set_legend
Replace this panel's legend entries.
Axes::set_legend_position
Anchor this axes' automatic or explicit legend to a panel corner.
Axes::set_margins
Set both automatic axis margins.
Axes::set_position
Set a normalized Figure rectangle (left, bottom, width, height).
which accepts both, original, or active. GridSpec membership is retained;
subplots_adjust restores grid placement. Manual panels keep their new
position through subplots_adjust. Zero sizes and positions outside the
Figure are allowed. Invalid values leave the state unchanged.
Negative sizes, non-finite coordinates, coordinate overflow, invalid which
values, and detached handles raise DataError::InvalidReference.
As in Matplotlib, an active-only value is overwritten by original and
aspect on the next active-position read or draw.
test {
let ax = @scene.figure(width=400, height=200).axes()
try! ax.set_position(0.25, 0.25, 0.5, 0.5)
let p = ax.get_position(original=true).unwrap()
assert_eq((p.x(), p.y(), p.width(), p.height()), (0.25, 0.25, 0.5, 0.5))
}Axes::set_prop_cycle
Matplotlib-style spelling for replacing the property cycle.
Axes::set_x_categories
Configure string categories on the x axis.
Axes::set_x_date
Set automatic date formatting on all axes sharing this x coordinate.
Axes::set_x_date_converter
Install copied converter defaults on every axis sharing this x coordinate.
Axes::set_x_date_format
Set an explicit date format on all axes sharing this x coordinate.
Axes::set_x_date_formatter
Set a copied date formatter on every axes sharing this x coordinate.
ConciseDateFormatter::as_formatter supplies batch labels and shared date text.
Axes::set_x_date_locator
Configure an explicit calendar locator on all axes sharing this x coordinate.
Axes::set_x_date_offset
Set the fixed UTC offset for date tick positions and labels on all shared x axes.
test {
let axes = @scene.figure().axes()
try! axes.set_x_date_offset(345)
assert_eq(axes.x_date_offset(), 345)
}Axes::set_x_date_timezone
Set a transition-aware timezone for all shared x axes.
Axes::set_x_formatter
Set the numeric formatter through this axes handle.
Axes::set_x_label
Set this panel's x-axis label.
Axes::set_x_limits
Set the x-axis limits through this axes handle.
Axes::set_x_locator
Set the numeric major locator through this axes handle.
Axes::set_x_margin
Set the automatic x-axis margin as a fraction of the data span.
Axes::set_x_minor_date_formatter
Configure the x minor date formatter on all shared axes.
Axes::set_x_minor_date_locator
Configure the x minor date locator on all shared axes.
Axes::set_x_minor_locator
Set the minor locator through this axes handle.
Axes::set_x_minor_named_formatter
Axes::set_x_named_formatter
Install the same live formatter on the shared x group, owned by this axes.
Axes::set_x_scale
Set the x-axis scale on this axes and all axes sharing its x coordinate.
Axes::set_x_tick_labels
Set fixed x-axis tick labels through this axes handle.
Axes::set_x_tick_labels_visible
Show or hide x tick labels on this panel without changing shared ticks.
Axes::set_x_tick_position
Set the x-axis tick label side for this panel.
Axes::set_x_ticks
Set fixed x-axis tick positions through this axes handle.
Axes::set_x_units
Change units with original shared-axis mutation and callback ordering.
Axes::set_xlim
Axes::set_xmargin
Matplotlib spelling for setting the automatic x-axis margin.
Axes::set_xscale
Matplotlib spelling for setting the x-axis scale.
Axes::set_xticklabels
Axes::set_xticks
Axes::set_y_categories
Configure string categories on the y axis.
Axes::set_y_date
Set automatic date formatting on all axes sharing this y coordinate.
Axes::set_y_date_converter
Install copied converter defaults on every axis sharing this y coordinate.
Axes::set_y_date_format
Set an explicit date format on all axes sharing this y coordinate.
Axes::set_y_date_formatter
Set a copied date formatter on every axes sharing this y coordinate.
Axes::set_y_date_locator
Configure an explicit calendar locator on all axes sharing this y coordinate.
Axes::set_y_date_offset
Set the fixed UTC offset for date tick positions and labels on all shared y axes.
test {
let axes = @scene.figure().axes()
try! axes.set_y_date_offset(-210)
assert_eq(axes.y_date_offset(), -210)
}Axes::set_y_date_timezone
Set a transition-aware timezone for all shared y axes.
Axes::set_y_formatter
Set the numeric formatter through this axes handle.
Axes::set_y_label
Set this panel's y-axis label.
Axes::set_y_limits
Set the y-axis limits through this axes handle.
Axes::set_y_locator
Set the numeric major locator through this axes handle.
Axes::set_y_margin
Set the automatic y-axis margin as a fraction of the data span.
Axes::set_y_minor_date_formatter
Configure the y minor date formatter on all shared axes.
Axes::set_y_minor_date_locator
Configure the y minor date locator on all shared axes.
Axes::set_y_minor_locator
Set the minor locator through this axes handle.
Axes::set_y_minor_named_formatter
Axes::set_y_named_formatter
Axes::set_y_scale
Set the y-axis scale on this axes and all axes sharing its y coordinate.
Axes::set_y_tick_labels
Set fixed y-axis tick labels through this axes handle.
Axes::set_y_tick_labels_visible
Show or hide y tick labels on this panel without changing shared ticks.
Axes::set_y_tick_position
Set the y-axis tick label side for this panel.
Axes::set_y_ticks
Set fixed y-axis tick positions through this axes handle.
Axes::set_y_units
Axes::set_ylim
Axes::set_ymargin
Matplotlib spelling for setting the automatic y-axis margin.
Axes::set_yscale
Matplotlib spelling for setting the y-axis scale.
Axes::set_yticklabels
Axes::set_yticks
Axes::spine
Return a handle to the selected spine.
Axes::spines
Return the four spines in left, right, bottom, top order.
Axes::spy
Plot the sparsity pattern of a rectangular scalar matrix.
Axes::stackplot
Draw a stacked area plot through the axes handle.
Axes::stairs
Draw a stepwise constant function through the axes view.
Axes::stem
Draw stems through the axes view.
Axes::step
Add a step plot through the axes view.
Axes::streamplot
fn Axes::streamplot(self : Axes, xs : Array[Double], ys : Array[Double], us : Array[Array[Double]], vs : Array[Array[Double]], density? : Double, density_x? : Double, density_y? : Double, color? : String, linewidth? : Double, max_steps? : Int, minlength? : Double, start_points? : Array[Point], maxlength? : Double, integration_direction? : String, broken_streamlines? : Bool, integration_max_step_scale? : Double, integration_max_error_scale? : Double, arrows? : Bool, arrow_size? : Double, num_arrows? : Int, arrowstyle? : String, label? : String) -> StreamplotSet raise DataErrorDraw streamlines and optionally vary line width and color over the grid.
Axes::streamplot_mesh
fn Axes::streamplot_mesh(self : Axes, x_grid : Array[Array[Double]], y_grid : Array[Array[Double]], us : Array[Array[Double]], vs : Array[Array[Double]], density? : Double, density_x? : Double, density_y? : Double, color? : String, linewidth? : Double, max_steps? : Int, minlength? : Double, start_points? : Array[Point], maxlength? : Double, integration_direction? : String, broken_streamlines? : Bool, integration_max_step_scale? : Double, integration_max_error_scale? : Double, arrows? : Bool, arrow_size? : Double, num_arrows? : Int, arrowstyle? : String, label? : String) -> StreamplotSet raise DataErrorDraw a streamline field from meshgrid-style two-dimensional coordinates.
Axes::streamplot_with_style_grids
fn Axes::streamplot_with_style_grids(self : Axes, xs : Array[Double], ys : Array[Double], us : Array[Array[Double]], vs : Array[Array[Double]], linewidths? : Array[Array[Double]], color_values? : Array[Array[Double]], density? : Double, density_x? : Double, density_y? : Double, color? : String, linewidth? : Double, cmap? : String, vmin? : Double, vmax? : Double, max_steps? : Int, minlength? : Double, start_points? : Array[Point], maxlength? : Double, integration_direction? : String, broken_streamlines? : Bool, integration_max_step_scale? : Double, integration_max_error_scale? : Double, arrows? : Bool, arrow_size? : Double, num_arrows? : Int, arrowstyle? : String, label? : String) -> StreamplotSet raise DataErrorDraw streamlines with optional grid-valued linewidth and color controls.
Axes::table
fn Axes::table(self : Axes, cell_text? : Array[Array[String]], cell_colours? : Array[Array[String]], cell_loc? : String, col_widths? : Array[Double], row_labels? : Array[String], row_colours? : Array[String], row_loc? : String, col_labels? : Array[String], col_colours? : Array[String], col_loc? : String, loc? : String, bbox? : Array[Double], edges? : String) -> Table raise DataErrorAdd a table through the axes view.
Axes::text
Add text through the axes view.
Axes::tricontour
fn Axes::tricontour(self : Axes, xs : Array[Double], ys : Array[Double], triangles : Array[Array[Int]], values : Array[Double], levels? : Array[Double], nlevels? : Int, color? : String, linewidth? : Double, label? : String, mask? : Array[Bool], locator? : Locator?, colors? : Array[String], linewidths? : Array[Double]) -> ContourSet raise DataErrorDraw contour lines over a validated triangular mesh.
Axes::tricontour_triangulation
fn Axes::tricontour_triangulation(self : Axes, mesh : Triangulation, values : Array[Double], levels? : Array[Double], nlevels? : Int, color? : String, linewidth? : Double, label? : String, locator? : Locator?, colors? : Array[String], linewidths? : Array[Double]) -> ContourSet raise DataErrorDraw contour lines from a validated triangulation.
Axes::tricontourf
fn Axes::tricontourf(self : Axes, xs : Array[Double], ys : Array[Double], triangles : Array[Array[Int]], values : Array[Double], levels? : Array[Double], nlevels? : Int, colors? : Array[String], cmap? : String, label? : String, extend_mode? : String, mask? : Array[Bool], locator? : Locator?) -> ContourSet raise DataErrorDraw filled contour bands over a validated triangular mesh.
Axes::tricontourf_triangulation
fn Axes::tricontourf_triangulation(self : Axes, mesh : Triangulation, values : Array[Double], levels? : Array[Double], nlevels? : Int, colors? : Array[String], cmap? : String, label? : String, extend_mode? : String, locator? : Locator?) -> ContourSet raise DataErrorDraw filled contour bands from a validated triangulation.
Axes::tripcolor
Fill triangle faces using the mean of their vertex scalar values.
Axes::tripcolor_triangulation
fn Axes::tripcolor_triangulation(self : Axes, mesh : Triangulation, values : Array[Double], vmin? : Double, vmax? : Double, cmap? : String, label? : String) -> Unit raise DataErrorFill faces from a validated triangulation using vertex or face values.
Axes::triplot
Draw triangle edges from vertices and explicit index triples.
Axes::triplot_triangulation
fn Axes::triplot_triangulation(self : Axes, mesh : Triangulation, color? : String, linewidth? : Double, label? : String) -> Unit raise DataErrorDraw each visible edge of a validated triangulation once.
Axes::unstale_view
Resolve shared pending requests before computing either coordinate.
Requests are consumed before callbacks, so an error does not restore them.
Axes::update_datalim
Extend cached data limits without requesting or enabling a view update.
A paired vertex mask is used after the source's any-finite early test.
Axes::update_x_category_units
Axes::update_x_date_units
Update x units from explicit naive/aware dates without adding an artist.
Axes::update_y_category_units
Axes::update_y_date_units
Axes::violin
fn Axes::violin(self : Axes, stats : Array[ViolinStats], positions? : Array[Double], width? : Double, widths? : Array[Double], horizontal? : Bool, side? : ViolinSide, showmeans? : Bool, showextrema? : Bool, showmedians? : Bool, color? : String, facecolor? : String, linecolor? : String, label? : String) -> Unit raise DataErrorDraw violins from precomputed density statistics on this axes panel.
Axes::violinplot
fn Axes::violinplot(self : Axes, data : Array[Array[Double]], positions? : Array[Double], width? : Double, widths? : Array[Double], horizontal? : Bool, side? : ViolinSide, showmeans? : Bool, showextrema? : Bool, showmedians? : Bool, quantiles? : Array[Array[Double]], points? : Int, bandwidth? : ViolinBandwidth, color? : String, facecolor? : String, linecolor? : String, label? : String) -> Array[ViolinStats] raise DataErrorCompute and draw Gaussian kernel-density violins from raw data.
Axes::vlines
Draw vertical line segments at the supplied x positions.
Axes::x_date_format
Return the explicit x-axis date format, if date mode is enabled.
test {
let axes = @scene.figure().axes()
try! axes.set_x_date_format("%Y-%m-%d")
assert_eq(axes.x_date_format(), Some("%Y-%m-%d"))
}Axes::x_date_offset
Return the fixed UTC offset used by this axes' x coordinate.
test {
assert_eq(@scene.figure().axes().x_date_offset(), 0)
}Axes::x_date_timezone
Return the transition-aware timezone used by the shared x axes, if any.
Axes::x_limits
Return explicit x limits, or a resolved datalim view after aspect application.
Axes::xaxis_date
Configure automatic date ticks on this axes' x axis.
Axes::xcorr
Plot and return a normalized cross-correlation sequence.
The same detrending function is applied independently to both input
sequences before correlation.
Axes::y_date_format
Return the explicit y-axis date format, if date mode is enabled.
test {
let axes = @scene.figure().axes()
try! axes.set_y_date_format("%H:%M")
assert_eq(axes.y_date_format(), Some("%H:%M"))
}Axes::y_date_offset
Return the fixed UTC offset used by this axes' y coordinate.
test {
assert_eq(@scene.figure().axes().y_date_offset(), 0)
}Axes::y_date_timezone
Return the transition-aware timezone used by the shared y axes, if any.
Axes::y_limits
Return explicit y limits, or a resolved datalim view after aspect application.
Container
A stable snapshot of the artists produced by one composite plotting call.
Container::artists
Return copies of the grouped artists in insertion order.
Container::kind
Return the container family.
ContainerKind
pub(all) enum ContainerKind {
Generic
Bar
ErrorBar
Stem
BoxPlot
Contour
Quiver
Violin
Pie
Stackplot
Streamplot
}The family of artists grouped by a plotting operation.
ContourSet
The result of a contour or filled-contour calculation.
ContourSet::allsegs
Return contour paths grouped by their level, like Matplotlib allsegs.
ContourSet::corner_mask
Return whether masked quadrilateral corners are clipped independently.
ContourSet::extend_mode
Return the filled-contour extension mode.
This corresponds to Matplotlib's extend property.
ContourSet::filled
Return whether this set contains filled bands.
ContourSet::layers
Return the representative layer value for each filled band.
ContourSet::levels
Return the contour levels in ascending order.
ContourSet::segment_levels
Return the level associated with each path returned by segments.
ContourSet::segments
Return the rendered contour paths, grouped in deterministic artist order.
Correlation
Lags and values returned by acorr or xcorr.
Ecdf
Figure
A backend-independent figure containing ordered axes panels.
Figure::acorr
Plot and return a normalized autocorrelation sequence.
detrend receives an owned copy of the samples and must return an array of
the same length. Use detrend_mean for the common mean-removal case.
Figure::add_axes
fn Figure::add_axes(self : Figure, left : Double, bottom : Double, width : Double, height : Double) -> Axes raise LayoutErrorAdd an axes panel at a normalized Figure rectangle.
The four arguments use Matplotlib's lower-left origin: left and bottom
locate the panel, while width and height describe its size. The panel
is independent from GridSpec and remains at this position after later
subplots_adjust calls. Zero width or height is allowed; negative sizes
and non-finite coordinates are rejected without changing the figure.
Rectangles may extend beyond the figure.
test {
let fig = @scene.figure(width=400, height=300)
let axes = try! fig.add_axes(0.1, 0.2, 0.5, 0.4)
let rect = axes.rect().unwrap()
assert_eq(
(rect.x(), rect.y(), rect.width(), rect.height()),
(40.0, 120.0, 200.0, 120.0),
)
}Figure::add_subfigure
Add a nested figure region at a GridSpec span.
Figure::add_subplot
Add a panel at a GridSpec span. A fresh figure reuses its default panel.
Figure::annotate
fn Figure::annotate(self : Figure, value : String, x : Double, y : Double, offset_x? : Double, offset_y? : Double, arrow? : Bool, color? : String, arrowcolor? : String, linewidth? : Double, head_length? : Double, head_width? : Double, fontsize? : Int, xycoords? : String, textcoords? : String, connector? : String) -> Unit raise DataErrorAdd text at a data point, optionally connected by an arrow.
offset_x and offset_y place the text relative to (x, y) in data
coordinates. When arrow is true, the arrow points from the text to the
annotated data point.
Figure::arrow
Draw one data-coordinate arrow from (x, y) by (dx, dy).
Figure::artists
Return artists from the default axes in insertion order.
Figure::autoscale
Restore automatic limits for one or both axes.
Figure::autoscale_view
Figure::axes
Return the first/default axes panel for this figure.
If all panels have been removed, create a 1-by-1 subplot.
Figure::axes_list
Return handles for all axes panels in creation order.
Figure::axhline
Draw a horizontal reference line in data coordinates.
Figure::axhspan
Fill the horizontal span between two y values across the axes.
Figure::axline
Draw an infinitely long line through one or two data points.
Figure::axvline
Draw a vertical reference line in data coordinates.
Figure::axvspan
Fill the vertical span between two x values across the axes.
Figure::bar
Add bars to the default axes.
Figure::bar_category
Add bars whose x coordinates are string categories to the default axes.
Figure::bar_category_y
Add horizontal bars whose y coordinates are string categories to the default axes.
Figure::barbs
Draw basic wind barbs for paired data-coordinate vectors.
Figure::barbs_with_options
fn Figure::barbs_with_options(self : Figure, xs : Array[Double], ys : Array[Double], us : Array[Double], vs : Array[Double], color? : String, linewidth? : Double, barb_length? : Double, label? : String, half_increment? : Double, full_increment? : Double, flag_increment? : Double, rounding? : Bool, flip? : Bool, fill_empty? : Bool, pivot? : String) -> Unit raise DataErrorDraw wind barbs with magnitude increments, pivot, flip, and calm-barb
options. The default increments match Matplotlib's half/full/flag values.
Figure::barh
Figure::boxplot
Draw box-and-whisker plots for one or more value series.
Figure::broken_barh
Draw horizontal broken bars from (start, width) ranges.
Figure::clabel
fn Figure::clabel(self : Figure, contours : ContourSet, inline? : Bool, fontsize? : Int, color? : String) -> Unit raise DataErrorAdd one text label at a representative segment for each contour level.
inline removes a small gap from the representative segment before the
text is added. fontsize controls the SVG text style.
Figure::clear
Clear all axes, artists, legends, and colorbars while retaining the
figure's dimensions and subplot layout.
Figure::clear_checked
Execute the checked Axes clear lifecycle once per retained panel.
The panel-preserving Figure convenience contract remains unchanged.
Figure::color_cycle
Return the default axes panel's property color cycle.
Figure::colorbar
Add a scalar colorbar to this figure.
Figure::colorbars
Return colorbars in insertion order.
Figure::containers
Return composite containers created on the default axes panel.
Figure::contour
fn Figure::contour(self : Figure, data : Array[Array[Double]], x? : Array[Double], y? : Array[Double], levels? : Array[Double], nlevels? : Int, color? : String, linewidth? : Double, label? : String, corner_mask? : Bool, locator? : Locator, colors? : Array[String], linewidths? : Array[Double]) -> ContourSet raise DataErrorDraw contour lines over a regular rectangular grid.
Figure::contourf
Draw filled contour bands over a regular rectangular grid.
Figure::delaxes
Remove axes from this Figure, preserving the order of remaining panels.
This also removes membership in nested SubFigures. The current selection
falls back to the most recently selected surviving panel. Removing the
last panel leaves the Figure empty until axes() or gca() is requested.
Foreign or detached handles raise InvalidReference before any state changes.
Figure-level colorbars are independent and remain registered.
test {
let fig = @scene.figure()
let ax = fig.axes()
try! fig.delaxes(ax)
assert_eq(fig.axes_list().length(), 0)
assert_true(!ax.is_attached())
assert_true(fig.gca().is_attached())
}Figure::ecdf
Plot and return an empirical cumulative distribution function.
Figure::errorbar
Add a line with optional symmetric x/y error bars.
An empty error array disables that direction; otherwise its length must
match the x/y sample count.
Figure::eventplot
Draw parallel event markers for one or more sequences of positions.
Figure::explicit_bounds
Return explicit limits from the default axes, if present.
Figure::fill
Fill a closed polygon from paired x/y coordinates.
Figure::fill_between
Fill the area between two y series.
Figure::fill_between_masked
fn Figure::fill_between_masked(self : Figure, xs : MaskedArray, lower : MaskedArray, upper : MaskedArray, color? : String, label? : String) -> Unit raise DataErrorFill between masked lower and upper arrays. Any combined mask creates a
gap in the filled region.
Figure::fill_betweenx
Fill the area between two x series sampled at y positions.
Figure::fill_betweenx_masked
fn Figure::fill_betweenx_masked(self : Figure, ys : MaskedArray, left : MaskedArray, right : MaskedArray, color? : String, label? : String) -> Unit raise DataErrorFill between masked left and right arrays sampled at y positions.
Figure::gca
Return the most recently selected surviving axes.
An empty Figure receives a new 1-by-1 subplot using its current bounds.
axes() remains the separate first/default-panel convenience API.
test {
let fig = @scene.figure()
let panels = try! fig.subplots(1, 2)
panels[1].set_title("last")
assert_eq(fig.gca().title(), Some("last"))
try! panels[1].remove()
panels[0].set_title("remaining")
assert_eq(fig.gca().title(), Some("remaining"))
}Figure::get_adjustable
Return the first/default panel's adjustment strategy.
test {
assert_eq(@scene.figure().get_adjustable(), "box")
}Figure::get_anchor
Return the first/default panel's anchor, creating a panel if necessary.
test {
assert_true(@scene.figure().get_anchor() is @scene.Anchor::Named("C"))
}Figure::get_aspect
Return the first/default panel's numeric aspect, or None for auto.
test {
let fig = @scene.figure()
fig.set_aspect_equal()
assert_eq(fig.get_aspect(), Some(1.0))
}Figure::get_box_aspect
Return the first/default panel's box constraint, creating a panel if needed.
test {
assert_true(@scene.figure().get_box_aspect() is None)
}Figure::get_legend_handles_labels
Return the effective legend entries for the default axes.
Figure::grid
Configure major or minor grid lines on the default axes panel.
Figure::grid_cells
Compute subplot rectangles for a regular grid on this figure.
Figure::grid_spec
Construct a regular subplot grid using this figure's display dimensions.
Figure::height
Return the figure height in display units.
Figure::hexbin
fn Figure::hexbin(self : Figure, xs : Array[Double], ys : Array[Double], values? : Array[Double], gridsize? : Int, mincnt? : Int, cmap? : String, vmin? : Double, vmax? : Double, color? : String, label? : String, reduce? : String, edgecolor? : String, linewidth? : Double, bins? : String, extent? : Array[Double], marginals? : Bool, reduce_fn? : HexbinReducer) -> Hexbin raise DataErrorBin points into a regular hexagonal grid and add filled polygons.
Figure::hist
Compute a histogram and add its bars to the figure.
Figure::hist2d
Compute a rectangular two-dimensional histogram and draw it as a mesh.
Figure::hlines
Draw horizontal line segments at the supplied y positions.
Figure::imshow
Add a two-dimensional scalar image. Non-finite cells use the colormap's
bad color (transparent by default). interpolation accepts the Matplotlib
filter names "nearest" (the default), "none", "bilinear",
"bicubic", "spline16", "spline36", "hanning", "hamming",
"hermite", "kaiser", "quadric", "catrom", "gaussian",
"bessel", "mitchell", "sinc", "lanczos", "blackman",
"auto", and "antialiased", ignoring case. On linear axes, "none"
embeds original-resolution pixels, while the filtered modes rasterize to
the display size before embedding the PNG. "auto" and "antialiased"
choose nearest for integer or large upscales and Hanning otherwise.
test {
let fig = @scene.figure()
fig.imshow([[0.0, 1.0]], interpolation="none")
assert_true(fig.to_svg().contains("data:image/png;base64,"))
}Figure::imshow_color
Alias for the typed RGBA entry point.
Figure::imshow_masked
fn Figure::imshow_masked(self : Figure, data : MaskedMatrix, vmin? : Double, vmax? : Double, cmap? : String, origin? : String, extent? : Array[Double], aspect? : String, alpha? : Double, interpolation? : String) -> Unit raise DataErrorAdd a masked scalar image. Explicitly masked cells are converted to NaN and
therefore follow the colormap's bad-color/transparent-cell policy.
Figure::imshow_masked_with_colormap
Add a masked scalar image using a custom colormap object.
Figure::imshow_masked_with_norm
Add a masked scalar image with an explicit normalization.
Figure::imshow_masked_with_norm_and_colormap
Add a masked scalar image with explicit normalization and colormap objects.
Figure::imshow_rgb
Add an opaque RGB image. Alpha is filled with one before it enters the
backend-neutral scene model.
Figure::imshow_rgb_channels
Add an RGB image from raw normalized three-channel pixels.
Figure::imshow_rgba
Add a prevalidated RGBA image. Pixels are placed with the same extent,
origin, aspect, and shared-axis behavior as scalar imshow.
Figure::imshow_rgba_channels
Add an RGBA image from raw normalized four-channel pixels.
Figure::imshow_with_colormap
Add a scalar image using a custom or builtin colormap object.
Figure::imshow_with_norm
Add a scalar image with an explicit linear or logarithmic normalization.
Figure::imshow_with_norm_and_colormap
Add a scalar image with explicit normalization and colormap objects.
Figure::legend
Set legend entries on the default axes.
Figure::legend_entries
Return the legend entries that would be rendered for the default axes.
Figure::legend_position
Return the legend anchor on the default axes.
Figure::line
Add a line plot from explicit points to the default axes.
Figure::loglog
Add a plot with logarithmic x and y coordinates to the default axes.
Figure::margins
Return the default axes' automatic margins.
Figure::matshow
Display a two-dimensional matrix on the default axes panel.
Figure::pcolor
Draw scalar values as filled quadrilaterals on a rectangular grid.
When supplied, x and y contain cell boundaries and therefore have one
more value than the number of columns and rows. Empty coordinates use an
integer grid. Source masked or non-finite cells are omitted from the
polygon set; values rejected by a normalization use the colormap bad color
when one is configured.
Figure::pcolor_grid
Draw a scalar mesh on a two-dimensional coordinate grid.
flat expects corner grids with shape (rows + 1, columns + 1);
nearest expects center grids with the same shape as data and derives
cell edges from neighboring centers. gouraud expects vertex grids with
the same shape as data and linearly interpolates vertex colors across
each cell. auto selects flat when the corner shape is supplied and
nearest otherwise.
Figure::pcolor_grid_masked
fn Figure::pcolor_grid_masked(self : Figure, data : MaskedMatrix, x : MaskedMatrix, y : MaskedMatrix, shading? : String, vmin? : Double, vmax? : Double, cmap? : String, antialiased? : Bool) -> Unit raise DataErrorDraw a masked scalar mesh on a two-dimensional coordinate grid.
The data, X, and Y matrices must be rectangular. A masked data cell is
omitted by pcolor_grid_masked; pcolormesh_grid_masked maps it through
the colormap's bad color when one is configured. A masked coordinate
vertex omits every cell that depends on that vertex.
Figure::pcolor_masked
Draw a scalar mesh, omitting masked and non-finite cells entirely.
Figure::pcolor_masked_with_norm_and_colormap
Draw a masked scalar mesh with an explicit normalization and colormap.
Figure::pcolor_with_norm
Draw a scalar mesh with an explicit normalization and named colormap.
Figure::pcolor_with_norm_and_colormap
Draw a scalar mesh using an explicit normalization and colormap object.
Figure::pcolormesh
Draw a rectangular scalar mesh with 1D cell boundaries. Masked or
non-finite cells use the colormap's bad color, which is transparent by default.
Figure::pcolormesh_grid
Draw a fast scalar mesh on a two-dimensional coordinate grid.
Figure::pcolormesh_grid_masked
fn Figure::pcolormesh_grid_masked(self : Figure, data : MaskedMatrix, x : MaskedMatrix, y : MaskedMatrix, shading? : String, vmin? : Double, vmax? : Double, cmap? : String, antialiased? : Bool) -> Unit raise DataErrorDraw a fast masked scalar mesh on a two-dimensional coordinate grid.
Figure::pcolormesh_masked
Draw a masked rectangular scalar mesh.
Figure::pcolormesh_masked_with_norm_and_colormap
Draw a masked rectangular mesh with explicit normalization and colormap.
Figure::pcolormesh_with_norm
Draw a fast scalar mesh with an explicit normalization and named colormap.
Figure::pcolormesh_with_norm_and_colormap
Draw a fast scalar mesh using an explicit normalization and colormap.
Figure::pie
Draw a pie chart and return the normalized slice fractions.
Figure::plot
Add a line plot from paired x/y samples.
Figure::plot_category
Add a line whose x coordinates are string categories to the default axes.
Figure::plot_category_y
Add a line whose y coordinates are string categories to the default axes.
Figure::plot_date
Plot date values on the default axes.
Figure::plot_date_units
Figure::plot_line
Figure::plot_masked
fn Figure::plot_masked(self : Figure, xs : MaskedArray, ys : MaskedArray, color? : String, label? : String) -> Unit raise DataErrorPlot paired masked arrays. The combined mask creates gaps in the line.
Figure::quiver
Draw arrows for a vector field sampled at paired x/y positions.
Figure::quiverkey
Draw a vector key arrow and label in data coordinates.
Figure::sca
Select axes in this Figure, returning the selected handle.
Foreign or detached handles raise InvalidReference without changing state.
Selection does not change creation or SVG drawing order.
test {
let fig = @scene.figure()
let panels = try! fig.subplots(1, 2)
panels[0].set_title("first")
ignore(try! fig.sca(panels[0]))
assert_eq(fig.gca().title(), Some("first"))
assert_eq(fig.axes_list().length(), 2)
}Figure::scatter
Add a scatter plot to the default axes.
Figure::scatter_category
Add scatter points whose x coordinates are string categories to the default axes.
Figure::scatter_category_y
Add scatter points whose y coordinates are string categories to the default axes.
Figure::scatter_collection
Add a per-point marker collection to the default axes.
Figure::scatter_masked
fn Figure::scatter_masked(self : Figure, xs : MaskedArray, ys : MaskedArray, color? : String, label? : String) -> Unit raise DataErrorScatter paired masked arrays. Any mask in either input suppresses the point.
Figure::secondary_xaxis
fn Figure::secondary_xaxis(self : Figure, forward : (Double) -> Double, inverse : (Double) -> Double, location? : SecondaryAxisLocation, transform? : Affine2D?) -> SecondaryAxis raise DataErrorAdd a secondary x axis to the default axes panel.
Figure::secondary_yaxis
fn Figure::secondary_yaxis(self : Figure, forward : (Double) -> Double, inverse : (Double) -> Double, location? : SecondaryAxisLocation, transform? : Affine2D?) -> SecondaryAxis raise DataErrorAdd a secondary y axis to the default axes panel.
Figure::semilogx
Add a plot with a logarithmic x coordinate to the default axes.
Figure::semilogy
Add a plot with a logarithmic y coordinate to the default axes.
Figure::set_adjustable
Set the first/default panel's adjustment strategy, preserving gca selection.
test {
let fig = @scene.figure()
try! fig.set_adjustable("datalim")
assert_eq(fig.axes().get_adjustable(), "datalim")
}Figure::set_anchor
Set the first/default panel's anchor while preserving the current selection.
Invalid anchors are rejected before creating a panel in an empty Figure.
test {
let fig = @scene.figure()
try! fig.set_anchor(@scene.Anchor::Named("NE"))
assert_true(fig.axes().get_anchor() is @scene.Anchor::Named("NE"))
}Figure::set_aspect
Set numeric aspect on the first/default panel, preserving gca selection.
test {
let fig = @scene.figure()
try! fig.set_aspect(0.5)
assert_eq(fig.axes().get_aspect(), Some(0.5))
}Figure::set_aspect_auto
Restore automatic aspect handling on the default axes panel.
Figure::set_aspect_equal
Set equal data scaling on the default axes panel.
Figure::set_axis_off
Hide axis decorations on the default axes panel while retaining artists.
Figure::set_axis_on
Show axis decorations on the default axes panel.
Figure::set_bounds
Set explicit data limits for the default axes.
Figure::set_box_aspect
Set or clear the first/default panel's physical box constraint.
Invalid input is rejected before creating a panel in an empty Figure.
test {
let fig = @scene.figure()
try! fig.set_box_aspect(aspect=0.5)
assert_eq(fig.axes().get_box_aspect(), Some(0.5))
}Figure::set_color_cycle
Replace the property color cycle on the default axes panel.
Figure::set_legend
Set legend entries on the default axes.
Figure::set_legend_position
Set the legend anchor on the default axes.
Figure::set_margins
Set both automatic margins on the default axes.
Figure::set_prop_cycle
Matplotlib-style spelling for replacing the property cycle.
Figure::set_title
Set the figure title.
Figure::set_x_categories
Configure string categories on the default x axis.
Figure::set_x_date_converter
Figure::set_x_date_formatter
Set a date formatter on the default x axis, including shared axes.
Figure::set_x_date_locator
Configure an explicit calendar locator on the default axes' x coordinate.
Figure::set_x_date_offset
Set the fixed UTC offset for date tick positions and labels on the default x axis.
test {
let figure = @scene.figure()
try! figure.set_x_date_offset(120)
assert_eq(figure.x_axis().date_offset_minutes(), 120)
}Figure::set_x_date_timezone
Set a transition-aware timezone for the default x axis.
Figure::set_x_formatter
Set the numeric formatter on the default x axis.
Figure::set_x_label
Set the x-axis label on the default axes.
Figure::set_x_limits
Set x-axis limits on the default axes, preserving their direction.
Figure::set_x_locator
Set the numeric major locator on the default x axis.
Figure::set_x_margin
Set the automatic x-axis margin on the default axes.
Figure::set_x_minor_date_formatter
fn Figure::set_x_minor_date_formatter(self : Figure, formatter : DateFormatter) -> Unit raise DataErrorConfigure the default x minor date formatter.
Figure::set_x_minor_date_locator
Configure the default x minor date locator.
Figure::set_x_minor_locator
Set the minor locator on the default x axis.
Figure::set_x_minor_named_formatter
Figure::set_x_named_formatter
Figure::set_x_scale
Set the x-axis scale on the default axes.
Figure::set_x_tick_labels
Set fixed x-axis tick labels on the default axes.
Figure::set_x_tick_position
Set the x-axis tick label side on the default axes panel.
Figure::set_x_ticks
Set fixed x-axis tick positions on the default axes.
Figure::set_xlim
Figure::set_xmargin
Matplotlib spelling for setting the automatic x-axis margin.
Figure::set_xscale
Matplotlib spelling for setting the x-axis scale.
Figure::set_xticklabels
Figure::set_xticks
Figure::set_y_categories
Configure string categories on the default y axis.
Figure::set_y_date_converter
Figure::set_y_date_formatter
Set a date formatter on the default y axis, including shared axes.
Figure::set_y_date_locator
Configure an explicit calendar locator on the default axes' y coordinate.
Figure::set_y_date_offset
Set the fixed UTC offset for date tick positions and labels on the default y axis.
test {
let figure = @scene.figure()
try! figure.set_y_date_offset(-480)
assert_eq(figure.y_axis().date_offset_minutes(), -480)
}Figure::set_y_date_timezone
Set a transition-aware timezone for the default y axis.
Figure::set_y_formatter
Set the numeric formatter on the default y axis.
Figure::set_y_label
Set the y-axis label on the default axes.
Figure::set_y_limits
Set y-axis limits on the default axes, preserving their direction.
Figure::set_y_locator
Set the numeric major locator on the default y axis.
Figure::set_y_margin
Set the automatic y-axis margin on the default axes.
Figure::set_y_minor_date_formatter
fn Figure::set_y_minor_date_formatter(self : Figure, formatter : DateFormatter) -> Unit raise DataErrorConfigure the default y minor date formatter.
Figure::set_y_minor_date_locator
Configure the default y minor date locator.
Figure::set_y_minor_locator
Set the minor locator on the default y axis.
Figure::set_y_minor_named_formatter
Figure::set_y_named_formatter
Figure::set_y_scale
Set the y-axis scale on the default axes.
Figure::set_y_tick_labels
Set fixed y-axis tick labels on the default axes.
Figure::set_y_tick_position
Set the y-axis tick label side on the default axes panel.
Figure::set_y_ticks
Set fixed y-axis tick positions on the default axes.
Figure::set_ylim
Figure::set_ymargin
Matplotlib spelling for setting the automatic y-axis margin.
Figure::set_yscale
Matplotlib spelling for setting the y-axis scale.
Figure::set_yticklabels
Figure::set_yticks
Figure::spine
Return a selected spine on the default axes panel.
Figure::spines
Return the default axes panel's four spines.
Figure::spy
Plot the sparsity pattern of a rectangular scalar matrix.
Figure::stackplot
Draw a stacked area plot and return one filled artist per input series.
baseline accepts "zero", "sym", "wiggle", or
"weighted_wiggle". Colors cycle when fewer colors than series are given;
an empty color array uses the axes property cycle.
test {
let fig = @scene.figure()
let artists = try! fig.stackplot(
[0.0, 1.0, 2.0],
[[1.0, 2.0, 1.0], [2.0, 1.0, 2.0]],
colors=["#123456", "#abcdef"],
)
assert_eq(artists.length(), 2)
assert_eq(fig.artists().length(), 2)
}Figure::stairs
Draw a stepwise constant function from values and bin edges.
Figure::stem
Draw stems from a baseline to each scalar head.
Figure::step
Add a step plot with pre, post, or mid transition semantics.
Figure::streamplot
fn Figure::streamplot(self : Figure, xs : Array[Double], ys : Array[Double], us : Array[Array[Double]], vs : Array[Array[Double]], density? : Double, density_x? : Double, density_y? : Double, color? : String, linewidth? : Double, max_steps? : Int, minlength? : Double, start_points? : Array[Point], maxlength? : Double, integration_direction? : String, broken_streamlines? : Bool, integration_max_step_scale? : Double, integration_max_error_scale? : Double, arrows? : Bool, arrow_size? : Double, num_arrows? : Int, arrowstyle? : String, label? : String) -> StreamplotSet raise DataErrorDraw streamlines for a regular vector field on 1D x/y grids.
Figure::streamplot_mesh
fn Figure::streamplot_mesh(self : Figure, x_grid : Array[Array[Double]], y_grid : Array[Array[Double]], us : Array[Array[Double]], vs : Array[Array[Double]], density? : Double, density_x? : Double, density_y? : Double, color? : String, linewidth? : Double, max_steps? : Int, minlength? : Double, start_points? : Array[Point], maxlength? : Double, integration_direction? : String, broken_streamlines? : Bool, integration_max_step_scale? : Double, integration_max_error_scale? : Double, arrows? : Bool, arrow_size? : Double, num_arrows? : Int, arrowstyle? : String, label? : String) -> StreamplotSet raise DataErrorDraw a streamline field from meshgrid-style two-dimensional coordinates.
Figure::streamplot_with_style_grids
fn Figure::streamplot_with_style_grids(self : Figure, xs : Array[Double], ys : Array[Double], us : Array[Array[Double]], vs : Array[Array[Double]], linewidths? : Array[Array[Double]], color_values? : Array[Array[Double]], density? : Double, density_x? : Double, density_y? : Double, color? : String, linewidth? : Double, cmap? : String, vmin? : Double, vmax? : Double, max_steps? : Int, minlength? : Double, start_points? : Array[Point], maxlength? : Double, integration_direction? : String, broken_streamlines? : Bool, integration_max_step_scale? : Double, integration_max_error_scale? : Double, arrows? : Bool, arrow_size? : Double, num_arrows? : Int, arrowstyle? : String, label? : String) -> StreamplotSet raise DataErrorDraw streamlines and optionally vary line width and color over the grid.
Empty style grids use the scalar color and linewidth values. Color
values are mapped through cmap after linear normalization.
Figure::subfigures
Return all nested figure regions registered on this Figure.
Figure::subplot_bounds
Return the current normalized bounds as (left, bottom, right, top).
Initial bounds correspond to the figure's 56-pixel margin on each side.
Figure::subplots
Create axes panels arranged in row-major order.
The boolean sharing arguments preserve the original convenience API and
correspond to the All or None GridSpec modes. Use
subplots_with_grid for row- or column-level sharing.
Figure::subplots_adjust
fn Figure::subplots_adjust(self : Figure, left? : Double, bottom? : Double, right? : Double, top? : Double, wspace? : Double, hspace? : Double) -> Unit raise LayoutErrorAdjust subplot bounds and spacing, including already-created nested axes.
Bounds are fractions of the figure width/height, measured from the bottom
left. wspace controls horizontal gaps and hspace vertical gaps, as
fractions of the average panel size. Existing grid constructors retain
their horizontal hspace / vertical vspace names. Explicit grid spacing
takes precedence over figure spacing. Unspecified values are preserved.
Bounds must be finite with left < right and bottom < top; they may extend
beyond the figure. Spacing must be finite and nonnegative. Invalid calls
leave the existing layout untouched. Initial spacing remains 0.1.
test {
let fig = @scene.figure(width=400, height=300)
let axes = try! fig.subplots(1, 2)
try! fig.subplots_adjust(
left=0.25,
bottom=0.25,
right=0.75,
top=0.75,
wspace=0.5,
)
assert_eq(fig.subplot_bounds(), (0.25, 0.25, 0.75, 0.75))
match axes[0].rect() {
Some(rect) => assert_eq(rect.width(), 80.0)
None => fail("expected a subplot rectangle")
}
}Figure::subplots_with_grid
Create axes sequentially, retaining each coordinate's construction target.
Figure::table
fn Figure::table(self : Figure, cell_text? : Array[Array[String]], cell_colours? : Array[Array[String]], cell_loc? : String, col_widths? : Array[Double], row_labels? : Array[String], row_colours? : Array[String], row_loc? : String, col_labels? : Array[String], col_colours? : Array[String], col_loc? : String, loc? : String, bbox? : Array[Double], edges? : String) -> Table raise DataErrorAdd a table to the figure's default axes.
Figure::text
Add text at a data coordinate.
Figure::to_drawing
Render once and capture in-panel Line/scatter datum anchors for interaction.
Point indices refer to the unfiltered source order, before Line step expansion.
Anchors do not describe marker pixel coverage; hit tolerance is caller-chosen.
Figure::to_svg
Render a figure with the default SVG backend.
Figure::to_svg_checked
Render SVG, reporting aspect-resolution failures through DataError.
Datalim views are resolved for all panels before any are committed.
The non-throwing to_svg() convenience aborts if this checked call fails.
test {
let fig = @scene.figure(width=400, height=200)
let ax = try! fig.add_axes(0.0, 0.0, 1.0, 1.0)
try! ax.plot([0.0, 1.0], [0.0, 1.0])
try! ax.set_xlim(0.0, 1.0)
try! ax.set_ylim(0.0, 1.0)
try! ax.set_aspect(1.0, adjustable="datalim")
let svg = try! fig.to_svg_checked()
assert_true(svg.contains("points=\"100,200 300,0\""))
}Figure::tricontour
fn Figure::tricontour(self : Figure, xs : Array[Double], ys : Array[Double], triangles : Array[Array[Int]], values : Array[Double], levels? : Array[Double], nlevels? : Int, color? : String, linewidth? : Double, label? : String, mask? : Array[Bool], locator? : Locator, colors? : Array[String], linewidths? : Array[Double]) -> ContourSet raise DataErrorDraw contour lines over a validated triangular mesh.
Figure::tricontour_triangulation
fn Figure::tricontour_triangulation(self : Figure, mesh : Triangulation, values : Array[Double], levels? : Array[Double], nlevels? : Int, color? : String, linewidth? : Double, label? : String, locator? : Locator, colors? : Array[String], linewidths? : Array[Double]) -> ContourSet raise DataErrorDraw contour lines from a validated triangulation.
Figure::tricontourf
fn Figure::tricontourf(self : Figure, xs : Array[Double], ys : Array[Double], triangles : Array[Array[Int]], values : Array[Double], levels? : Array[Double], nlevels? : Int, colors? : Array[String], cmap? : String, label? : String, extend_mode? : String, mask? : Array[Bool], locator? : Locator) -> ContourSet raise DataErrorDraw filled contour bands over a validated triangular mesh.
Figure::tricontourf_triangulation
fn Figure::tricontourf_triangulation(self : Figure, mesh : Triangulation, values : Array[Double], levels? : Array[Double], nlevels? : Int, colors? : Array[String], cmap? : String, label? : String, extend_mode? : String, locator? : Locator) -> ContourSet raise DataErrorDraw filled contour bands from a validated triangulation.
Figure::tripcolor
Fill triangle faces using vertex means or one scalar per face.
Figure::tripcolor_triangulation
fn Figure::tripcolor_triangulation(self : Figure, mesh : Triangulation, values : Array[Double], vmin? : Double, vmax? : Double, cmap? : String, label? : String) -> Unit raise DataErrorFill faces from a validated triangulation using vertex or face values.
Figure::triplot
Draw triangle edges from vertices and explicit index triples.
Use triangulation and triplot_triangulation when the faces should be
generated automatically and reused.
Figure::triplot_triangulation
fn Figure::triplot_triangulation(self : Figure, mesh : Triangulation, color? : String, linewidth? : Double, label? : String) -> Unit raise DataErrorDraw each visible edge of a validated triangulation once.
Figure::violin
fn Figure::violin(self : Figure, stats : Array[ViolinStats], positions? : Array[Double], width? : Double, widths? : Array[Double], horizontal? : Bool, side? : ViolinSide, showmeans? : Bool, showextrema? : Bool, showmedians? : Bool, color? : String, facecolor? : String, linecolor? : String, label? : String) -> Unit raise DataErrorDraw violins from precomputed density statistics.
Figure::violinplot
fn Figure::violinplot(self : Figure, data : Array[Array[Double]], positions? : Array[Double], width? : Double, widths? : Array[Double], horizontal? : Bool, side? : ViolinSide, showmeans? : Bool, showextrema? : Bool, showmedians? : Bool, quantiles? : Array[Array[Double]], points? : Int, bandwidth? : ViolinBandwidth, color? : String, facecolor? : String, linecolor? : String, label? : String) -> Array[ViolinStats] raise DataErrorCompute and draw Gaussian kernel-density violins from raw data.
Figure::vlines
Draw vertical line segments at the supplied x positions.
Figure::x_axis
Return the x-axis object from the default axes.
Figure::x_date_timezone
Return the transition-aware timezone used by the default x axis, if any.
Figure::x_label
Return the optional x-axis label from the default axes.
Figure::x_limits
Return explicit x limits, or the resolved datalim view, on the default axes.
Figure::x_margin
Return the default axes' automatic x-axis margin.
Figure::xaxis_date
Configure date ticks on the default axes' x coordinate.
Figure::xcorr
Plot and return a normalized cross-correlation sequence.
The same detrending function is applied independently to both input
sequences before correlation.
Figure::y_axis
Return the y-axis object from the default axes.
Figure::y_date_timezone
Return the transition-aware timezone used by the default y axis, if any.
Figure::y_label
Return the optional y-axis label from the default axes.
Figure::y_limits
Return explicit y limits, or the resolved datalim view, on the default axes.
Figure::y_margin
Return the default axes' automatic y-axis margin.
Hexbin
HexbinReducer
A user supplied reducer for values collected in one hexbin cell.
HexbinReducer::apply
Histogram
Histogram counts and bin edges produced by Figure::hist.
Histogram::artists
Return copies of the bar artists generated for the histogram bins.
ImageInterpolation
pub(all) enum ImageInterpolation {
Nearest
NoInterpolation
Bilinear
Bicubic
Spline16
Spline36
Hanning
Hamming
Hermite
Kaiser
Quadric
Catrom
Gaussian
Bessel
Mitchell
Sinc
Lanczos
Blackman
Auto
Antialiased
}The sampling policy used when an image is mapped to the SVG display area.
Nearest draws source cells as vector rectangles. NoInterpolation embeds
source pixels in a PNG on linear axes; nonlinear axes use the same cell
geometry as Nearest. The remaining modes use a display-sized PNG on
linear axes and fall back to source-cell geometry on nonlinear axes.
ImageOrigin
pub(all) enum ImageOrigin {
Upper
Lower
}The vertical orientation used when mapping matrix rows to data space.
LegendEntry
A labeled visual entry displayed inside an axes legend.
LegendKind
pub(all) enum LegendKind {
Line
Marker
Patch
}The visual sample used by one legend entry.
Line2D
pub struct Line2D {
// private fields
}A stable Line data handle with copied originals and lazy converted views.
Line2D::data_values_checked
Read x then y, preserving the possibility of two different generations.
Line2D::get_color
Return the original color spelling, without resolving a color-cycle token.
Line2D::get_xdata
Borrow the copied original x input without converting it.
Line2D::path_values_checked
Borrow cached path vertices as flat [x0,y0,...] Float64 storage.
Processed coordinate queries remain unexpanded; default shares XY storage.
Line2D::recache_checked
Rebuild one generation. Conversion side effects survive a later failure.
Line2D::remove
Remove this exact attached Line without recomputing limits or legend state.
Line2D::set_alpha
Equal alpha values are a complete no-op, including the sign of stored zero.
Line2D::set_color
Validate a source color and preserve its spelling for later drawing.
Line2D::set_dashes
Snapshot numeric dashes as an immutable tuple-input profile. Validation of
unusual numeric patterns remains draw-late, as for captured rc patterns.
Line2D::set_drawstyle
Change the path construction mode without eagerly converting coordinates.
Line2D::set_gapcolor
Validate first, then retain the raw optional spelling and always mark stale.
Line2D::set_linestyle
Line2D::set_linewidth
Set linewidth and refresh scaling of its captured unscaled dash metadata.
Line2D::set_visible
Change drawing visibility without invalidating data or requesting new limits.
Line2D::set_xdata
Copy new x originals and invalidate only x; limits are updated separately.
Line2D::x_values_checked
Borrow the current generation's x view, refreshing only when x is invalid.
Line2D::xy_values_checked
Borrow flat interleaved [x0,y0,x1,y1,...] Float64 storage.
Line2D::y_values_checked
LineData
Original coordinate kind is independent of the Axis's current converter.
PathCollection
A collection of marker paths with per-point styles.
This is the data model used by the collection form of scatter. Colors are
CSS-compatible strings and sizes are marker areas; a size of s is
rendered with radius sqrt(s) in SVG display units.
PathCollection::length
Return the number of markers in this collection.
PathCollection::points
Return a copy of the collection's data points.
PathCollection::styles
Return a copy of the per-point styles.
SecondaryAxis
pub struct SecondaryAxis {
label : String?
// private fields
}A coordinate axis whose values are derived from a primary axis.
SecondaryAxis::alignment
SecondaryAxis::apply_aspect
Synchronize limits using the currently installed context, without scale reset.
SecondaryAxis::clear_formatter
Clear both major formatter roles and restore explicit plain numeric labels.
SecondaryAxis::clear_locator
Explicit convenience extension restoring the legacy parent-grid sampler.
SecondaryAxis::clear_minor_locator
SecondaryAxis::clear_minor_named_formatter
SecondaryAxis::clear_named_formatter
SecondaryAxis::formatter_axis_binding
SecondaryAxis::formatter_offset_label_checked
fn SecondaryAxis::formatter_offset_label_checked(self : SecondaryAxis, values : Array[Double], view? : Limits) -> String raise DataErrorSecondaryAxis::formatter_tick_locations_checked
fn SecondaryAxis::formatter_tick_locations_checked(self : SecondaryAxis, minor? : Bool) -> FormatterLocations raise DataErrorSecondaryAxis::formatter_warnings
SecondaryAxis::location
SecondaryAxis::minor_locator
SecondaryAxis::minor_named_formatter
SecondaryAxis::minor_overlap_removal
SecondaryAxis::minor_tick_labels_checked
fn SecondaryAxis::minor_tick_labels_checked(self : SecondaryAxis, values : Array[Double], view? : Limits) -> Array[String] raise DataErrorSecondaryAxis::minor_tick_values_checked
SecondaryAxis::named_formatter
SecondaryAxis::position
Return the requested numerical location without changing active geometry.
SecondaryAxis::prepare_draw
Draw maps parent limits through the OLD child context before checking scale.
SecondaryAxis::reset_functions
Store identity limit functions, corresponding to source set_functions(None).
The same parent-name gate applies to the already installed transform.
SecondaryAxis::set_alignment
fn SecondaryAxis::set_alignment(self : SecondaryAxis, alignment : SecondaryAxisAlignment) -> Unit raise DataErrorChange only the visible decoration side, independently of the location.
SecondaryAxis::set_formatter
SecondaryAxis::set_functions
fn SecondaryAxis::set_functions(self : SecondaryAxis, forward : (Double) -> Double, inverse : (Double) -> Double) -> Unit raise DataErrorReplace the functions used to map parent limits. A matching parent scale
name retains the installed transform and ticker objects until a name change.
Functions remain assigned if the later scale synchronization raises.
SecondaryAxis::set_label
SecondaryAxis::set_location
fn SecondaryAxis::set_location(self : SecondaryAxis, location : SecondaryAxisLocation, transform? : Affine2D?) -> Unit raise DataErrorChange the requested location. Positioning is deferred to an aspect stage.
SecondaryAxis::set_locator
Install a locator in the secondary axis' own coordinates and stable context.
SecondaryAxis::set_minor_locator
Install a minor locator in the stable secondary Axis context.
SecondaryAxis::set_minor_named_formatter
fn SecondaryAxis::set_minor_named_formatter(self : SecondaryAxis, formatter : BaseFormatter) -> UnitSecondaryAxis::set_minor_overlap_removal
SecondaryAxis::set_named_formatter
SecondaryAxis::set_tick_count
Select the legacy parent-grid sampler only while no explicit locator owns ticks.
SecondaryAxis::set_tick_label_size
SecondaryAxis::set_ticks
SecondaryAxis::tick_group_is_null
SecondaryAxis::tick_label_size
SecondaryAxis::tick_labels_checked
fn SecondaryAxis::tick_labels_checked(self : SecondaryAxis, values : Array[Double], view? : Limits) -> Array[String] raise DataErrorSecondaryAxis::tick_values_checked
SecondaryAxis::ticks
Return a copy of the currently retained explicit set_ticks positions.
SecondaryAxisAlignment
pub(all) enum SecondaryAxisAlignment {
Top
Bottom
Left
Right
}Decoration side, independent of the requested secondary-axis location.
SecondaryAxisLocation
pub(all) enum SecondaryAxisLocation {
Top
Bottom
Left
Right
Position(Double)
}Location of a secondary coordinate axis.
Spine
A handle to one of an axes panel's four spines.
Spine::bounds
Return optional data-coordinate bounds for this spine.
Spine::clear_bounds
Remove an explicit spine interval.
Spine::position
Return this spine's positioning mode.
Spine::set_bounds
Restrict a spine to a finite data-coordinate interval.
Spine::set_color
Set the spine stroke color.
Spine::set_linewidth
Set the spine stroke width.
Spine::set_position
Set this spine's positioning mode.
Spine::set_visible
Set whether this spine is rendered.
Spine::side
Return the side represented by this spine handle.
SpinePosition
pub(all) enum SpinePosition {
Axes
Data(Double)
Outward(Double)
}Positioning modes supported by an axes spine.
SpineSide
pub(all) enum SpineSide {
Left
Right
Bottom
Top
}The four standard borders around an axes panel.
StreamplotSet
The line and arrow artists produced by one streamplot call.
The arrays contain copies of the artists added to the owning axes, so the
returned value can be inspected without changing the figure.
StreamplotSet::arrows
Return the arrow artists generated by this result.
StreamplotSet::lines
Return the streamline artists generated by this result.
SubFigure
A nested figure region backed by a parent Figure and a SubplotSpec span.
SubFigure axes are regular scene Axes owned by the parent Figure, so they
participate in the same SVG render and retain the parent GridSpec's live
ratio updates.
SubFigure::add_subfigure
Add a child nested figure region inside this SubFigure.
SubFigure::add_subplot
Add an Axes owned by the parent Figure to this nested region.
SubFigure::axes_list
Return attached axes created directly through this SubFigure handle.
SubFigure::clear
Clear this nested region's axes and title.
SubFigure::clear_checked
Clear each panel in this retained nested region through the same checked path.
SubFigure::delaxes
Remove axes created directly through this SubFigure.
Axes in another region or a child SubFigure raise InvalidReference.
test {
let fig = @scene.figure()
let grid = try! fig.grid_spec(1, 1)
let sub = fig.add_subfigure(try! grid.cell_spec(0, 0))
let ax = try! sub.subplots(1, 1)[0]
try! sub.delaxes(ax)
assert_eq(sub.axes_list().length(), 0)
assert_eq(fig.axes_list().length(), 0)
}SubFigure::get_axes
Matplotlib-compatible alias for axes_list.
SubFigure::rect
Return the current display rectangle of this nested figure.
SubFigure::set_title
Set the nested figure title.
SubFigure::subfigures
Return child nested figures registered on this SubFigure.
SubFigure::subplot_spec
Return the GridSpec span occupied by this nested figure.
SubFigure::subplots
Create a regular nested grid and add all of its axes.
SubFigure::subplots_with_grid
Create nested axes according to a GridSpec's sharing constraints.
SubFigure::suptitle
Matplotlib-compatible alias for set_title.
SubFigureData
type SubFigureDataState retained by a SubFigure handle and consumed by the renderer.
Table
A table laid out in normalized axes coordinates.
TableCell
pub struct TableCell {
row : Int
column : Int
text : String
facecolor : String
edgecolor : String
align : String
visible_edges : String
}One cell in a table artist.
TriFinder
A point-to-triangle lookup built from a validated triangulation.
find returns the index of the first visible triangle containing the
query point. Points outside the mesh, points in masked faces, and
non-finite query coordinates return -1, matching Matplotlib's
TriFinder sentinel convention.
TriFinder::find
Find the index of the first visible triangle containing (x, y).
The return value is -1 when the point is outside the triangulation, lies
in a masked face, or has a non-finite coordinate. Points on a shared edge
use the first visible face in mesh order, making the result deterministic.
Triangulation
A validated triangular mesh with derived edges and face neighbors.
triangulation accepts explicit triangle indices or constructs a
deterministic Delaunay triangulation when the indices are omitted.
Triangulation::edges
Return each visible mesh edge once as a pair of vertex indices.
Triangulation::find_triangle
Return the index of the triangle containing a point, or -1 outside the
mesh. This is a convenience wrapper around get_trifinder().find.
Triangulation::get_masked_triangles
Return a deep copy containing only unmasked triangle faces.
Triangulation::get_trifinder
Return a point finder for this triangulation.
Triangulation::is_delaunay
Whether the mesh was generated automatically from the vertices.
Triangulation::mask
Return a copy of the per-face mask. An empty mask means every face is
visible.
Triangulation::neighbors
Return one neighbor index for each opposite triangle side, or -1 for a
boundary edge or a masked face.
Triangulation::triangles
Return a deep copy of the triangle index triples.
Triangulation::x
Return a copy of the mesh x coordinates.
Triangulation::y
Return a copy of the mesh y coordinates.
ViolinBandwidth
pub(all) enum ViolinBandwidth {
Scott
Silverman
Fixed(Double)
}Bandwidth rules used by the Gaussian kernel density estimate.
ViolinSide
pub(all) enum ViolinSide {
Both
Low
High
}Select which side of a violin body is filled around its position.
ViolinStats
Kernel-density and summary statistics used to draw one violin.
ViolinStats::coords
Return the coordinates sampled by the density estimate.
ViolinStats::vals
Return the density values sampled at coords.
detrend_linear
Remove the least-squares line from correlation samples.
The sample index (0 .. n - 1) is used as the independent variable. For
fewer than two samples the input is returned unchanged.
detrend_mean
Remove the arithmetic mean from correlation samples.
The returned array always has the same length as the input. Empty input is
returned unchanged; the correlation entry points reject empty samples
before invoking this function.
detrend_none
Leave correlation samples unchanged while returning an owned copy.
This is the default detrending function for acorr and xcorr.
figure
Create an empty figure with one default axes panel.
hexbin_reducer
Wrap a callable reducer for use with hexbin(reduce_fn=...).
legend_entry
Construct a legend entry with a line sample by default.
path_collection
Construct a marker collection with broadcastable colors and sizes.
streamplot_set
Construct a streamplot result from its line and arrow artists.
triangulation
Construct a triangular mesh. If triangles is empty, a Delaunay mesh is
generated from the input vertices. A mask marks faces that remain in the
mesh data but are excluded from edges and neighbors.
trifinder
Construct a finder from a triangulation, copying the mesh data so later
changes to caller-owned arrays cannot affect lookup results.
violin_stats
fn violin_stats(values : Array[Double], points? : Int, bandwidth? : ViolinBandwidth, quantiles? : Array[Double]) -> ViolinStats raise DataErrorCompute the statistics and Gaussian density for one violin series.
Source Files
- additional_axes.mbt
- adjustable.mbt
- anchor.mbt
- annotation.mbt
- artist_model.mbt
- artists.mbt
- aspect.mbt
- autoscale.mbt
- autoscale_data.mbt
- axes.mbt
- axes_clear.mbt
- axes_state.mbt
- axis_data.mbt
- barbs.mbt
- box_aspect.mbt
- boxplot.mbt
- category.mbt
- collections.mbt
- color_cycle.mbt
- colorbar_api.mbt
- container.mbt
- contour.mbt
- correlation.mbt
- date.mbt
- date_converter.mbt
- date_formatter.mbt
- date_minor.mbt
- discrete.mbt
- ecdf.mbt
- errorbar.mbt
- figure.mbt
- fill_between.mbt
- hexbin.mbt
- image.mbt
- image_color.mbt
- image_extent.mbt
- layout.mbt
- legend.mbt
- lifecycle.mbt
- line2d.mbt
- line_color.mbt
- line_color_names.mbt
- line_drawstyle_error.mbt
- line_drawstyle_step.mbt
- line_gapcolor_inverse.mbt
- line_style_error.mbt
- line_style_numeric.mbt
- line_units.mbt
- masked.mbt
- masked_image.mbt
- masked_mesh.mbt
- matplotlib_compat.mbt
- matshow.mbt
- named_formatter.mbt
- pcolor.mbt
- pcolor_grid.mbt
- pie.mbt
- position.mbt
- quiver.mbt
- reference.mbt
- scale.mbt
- secondary_axis.mbt
- secondary_formatter.mbt
- secondary_functions.mbt
- secondary_lifecycle.mbt
- secondary_minor.mbt
- secondary_numeric_context.mbt
- secondary_position.mbt
- shared_axes.mbt
- shared_members.mbt
- spines.mbt
- spy.mbt
- stackplot.mbt
- statistics.mbt
- step.mbt
- streamplot.mbt
- streamplot_arrows.mbt
- streamplot_mesh.mbt
- subfigure.mbt
- svg.mbt
- table.mbt
- tri_finder.mbt
- triangle.mbt
- triangulation.mbt
- units.mbt
- violin.mbt
Apache-2.0
Updated 4 hours ago
6 downloads