Struct GSPos

pub struct GSPos {
    pub i: Range<usize>,
    pub j: Range<usize>,
    pub sharex: Option<usize>,
    pub sharey: Option<usize>,
}

A single subplot’s position in a gridspec.

The position is specified by two integer ranges representing a 2D slice of the gridspec.

This type also allows for shared axes to be specified in the context of a series of positions as a pair of integers: A given integer k refers to the Axes object corresponding to the k-th position in the series; the first is for the X-axis and the second is for the Y-axis.

The object

GSPos { i: 0..3, j: 2..3, sharex: Some(0), sharey: None }

specifies a subplot covering the first three rows and second column of a grid, sharing its X-axis with the first subplot in an implied sequence and its Y-axis with no other.

Fields

i: Range<usize>

Vertical slice.

j: Range<usize>

Horizontal slice.

sharex: Option<usize>

Index of the Axes object with which to share the X-axis.

sharey: Option<usize>

Index of the Axes object with which to share the Y-axis.

Implementations

impl GSPos

pub fn new(i: Range<usize>, j: Range<usize>) -> Self

Create a new GSPos without any shared axes.

pub fn new_shared( i: Range<usize>, j: Range<usize>, sharex: Option<usize>, sharey: Option<usize>, ) -> Self

Create a new GSPos with shared axes.

pub fn share(self, axis: Axis2, target: Option<usize>) -> Self

Set the axis sharing.

pub fn sharex(self, target: Option<usize>) -> Self

Set the X-axis sharing.

pub fn sharey(self, target: Option<usize>) -> Self

Set the Y-axis sharing.

Trait Implementations

impl Clone for GSPos

fn clone(&self) -> GSPos

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GSPos

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GSPos

fn eq(&self, other: &GSPos) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GSPos

impl StructuralPartialEq for GSPos