Struct AxisLimits

Namespace

ScottPlot

Assembly

ScottPlot.dll

This object represents the rectangular visible area on a 2D coordinate system. It simply stores a CoordinateRect but has axis-related methods to act upon it.

public readonly struct AxisLimits : IEquatable<AxisLimits>

Implements

IEquatable<AxisLimits>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Extension Methods

DataSourceUtilities.BinarySearch<T, TList>(TList, int, int, T, IComparer<T>?)

DataSourceUtilities.GetClosestIndex<TValue, TList>(TList, TValue, IndexRange, IComparer<TValue>?)

Constructors

AxisLimits(CoordinateRange, CoordinateRange)

public AxisLimits(CoordinateRange xRange, CoordinateRange yRange)

Parameters

xRange CoordinateRange

yRange CoordinateRange

AxisLimits(CoordinateRect)

public AxisLimits(CoordinateRect rect)

Parameters

rect CoordinateRect

AxisLimits(Coordinates)

public AxisLimits(Coordinates coordinates)

Parameters

coordinates Coordinates

AxisLimits(IEnumerable<Coordinates3d>)

public AxisLimits(IEnumerable<Coordinates3d> coordinates)

Parameters

coordinates IEnumerable<Coordinates3d>

AxisLimits(IEnumerable<Coordinates>)

public AxisLimits(IEnumerable<Coordinates> coordinates)

Parameters

coordinates IEnumerable<Coordinates>

AxisLimits(IEnumerable<IPlottable>)

public AxisLimits(IEnumerable<IPlottable> plottables)

Parameters

plottables IEnumerable<IPlottable>

AxisLimits(double, double, double, double)

public AxisLimits(double left, double right, double bottom, double top)

Parameters

left double

right double

bottom double

top double

Properties

Bottom

public double Bottom { get; }

Property Value

double

Center

public Coordinates Center { get; }

Property Value

Coordinates

Default

public static AxisLimits Default { get; }

Property Value

AxisLimits

HasArea

public bool HasArea { get; }

Property Value

bool

HorizontalCenter

public double HorizontalCenter { get; }

Property Value

double

HorizontalRange

public CoordinateRange HorizontalRange { get; }

Property Value

CoordinateRange

HorizontalSpan

public double HorizontalSpan { get; }

Property Value

double

IsReal

public bool IsReal { get; }

Property Value

bool

IsRealX

public bool IsRealX { get; }

Property Value

bool

IsRealY

public bool IsRealY { get; }

Property Value

bool

Left

public double Left { get; }

Property Value

double

NoLimits

public static AxisLimits NoLimits { get; }

Property Value

AxisLimits

Rect

public CoordinateRect Rect { get; }

Property Value

CoordinateRect

Right

public double Right { get; }

Property Value

double

Top

public double Top { get; }

Property Value

double

Unset

public static AxisLimits Unset { get; }

Property Value

AxisLimits

VerticalCenter

public double VerticalCenter { get; }

Property Value

double

VerticalRange

public CoordinateRange VerticalRange { get; }

Property Value

CoordinateRange

VerticalSpan

public double VerticalSpan { get; }

Property Value

double

XRange

public CoordinateRange XRange { get; }

Property Value

CoordinateRange

YRange

public CoordinateRange YRange { get; }

Property Value

CoordinateRange

Methods

Contains(Coordinates)

public bool Contains(Coordinates pt)

Parameters

pt Coordinates

Returns

bool

Contains(double, double)

public bool Contains(double x, double y)

Parameters

x double

y double

Returns

bool

Equals(AxisLimits)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(AxisLimits other)

Parameters

other AxisLimits

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

Expanded(AxisLimits)

Return a new AxisLimits expanded to include the area defined by limits.

public AxisLimits Expanded(AxisLimits limits)

Parameters

limits AxisLimits

Returns

AxisLimits

Expanded(CoordinateRect)

Return a new AxisLimits expanded to include all corners of the given rect.

public AxisLimits Expanded(CoordinateRect rect)

Parameters

rect CoordinateRect

Returns

AxisLimits

Expanded(Coordinates)

Return a new AxisLimits expanded to include the given coordinates.

public AxisLimits Expanded(Coordinates coordinates)

Parameters

coordinates Coordinates

Returns

AxisLimits

Expanded(double, double)

Return a new AxisLimits expanded to include the given x and y.

public AxisLimits Expanded(double x, double y)

Parameters

x double

y double

Returns

AxisLimits

ExpandedToInclude(AxisLimits)

public AxisLimits ExpandedToInclude(AxisLimits otherLimits)

Parameters

otherLimits AxisLimits

Returns

AxisLimits

FromPoint(Coordinates)

public static AxisLimits FromPoint(Coordinates c)

Parameters

c Coordinates

Returns

AxisLimits

FromPoint(double, double)

public static AxisLimits FromPoint(double x, double y)

Parameters

x double

y double

Returns

AxisLimits

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

HorizontalOnly(double, double)

public static AxisLimits HorizontalOnly(double xMin, double xMax)

Parameters

xMin double

xMax double

Returns

AxisLimits

InvertedHorizontally()

public AxisLimits InvertedHorizontally()

Returns

AxisLimits

InvertedVertically()

public AxisLimits InvertedVertically()

Returns

AxisLimits

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

ToString(int)

public string ToString(int digits)

Parameters

digits int

Returns

string

VerticalOnly(double, double)

public static AxisLimits VerticalOnly(double yMin, double yMax)

Parameters

yMin double

yMax double

Returns

AxisLimits

WithPan(double, double)

public AxisLimits WithPan(double deltaX, double deltaY)

Parameters

deltaX double

deltaY double

Returns

AxisLimits

WithZoom(double, double)

public AxisLimits WithZoom(double fracX, double fracY)

Parameters

fracX double

fracY double

Returns

AxisLimits

WithZoom(double, double, double, double)

public AxisLimits WithZoom(double fracX, double fracY, double zoomToX, double zoomToY)

Parameters

fracX double

fracY double

zoomToX double

zoomToY double

Returns

AxisLimits

Operators

operator ==(AxisLimits, AxisLimits)

public static bool operator ==(AxisLimits a, AxisLimits b)

Parameters

a AxisLimits

b AxisLimits

Returns

bool

operator !=(AxisLimits, AxisLimits)

public static bool operator !=(AxisLimits a, AxisLimits b)

Parameters

a AxisLimits

b AxisLimits

Returns

bool