Table of Contents

Class AxisXYBase

Namespace
LightningChartLib.WinForms.Charting.Axes
Assembly
LightningChart.WinForms.Charting.NET4.dll

XY view axis base class.

[TypeConverter(typeof(ExpandableObjectConverter))]
public class AxisXYBase : AxisBase, IChartNode, IDisposable, IHighlightingItem
Inheritance
AxisXYBase
Implements
Derived
Inherited Members

Constructors

AxisXYBase()

Constructor for Form designer's list editor.

public AxisXYBase()

Properties

AllowScaling

Axis min and max values adjust by user. Draws scale nibs in the ends of the axis.

public bool AllowScaling { get; set; }

Property Value

bool

AllowScrolling

Axis scrolling by user. Drag from axis line.

public bool AllowScrolling { get; set; }

Property Value

bool

AllowSeriesDragDrop

Allow series adding to this axis by dragging it from other axis of this chart or from another chart's axis. Once the drag drop operation is complete, the series is removed from the axis/chart where the drag begun and the series is assigned for the target axis.

public bool AllowSeriesDragDrop { get; set; }

Property Value

bool

DragSnapToDiv

Axis scrolling or scaling snaps to divisions.

public bool DragSnapToDiv { get; set; }

Property Value

bool

EndPointLabelsVisible

Defines if labels are shown at minimum and maximum axis values.

public bool EndPointLabelsVisible { get; set; }

Property Value

bool

EndPointMajorTickThreshold

summary P:LightningChartLib.WinForms.Charting.Axes.AxisXYBase.EndPointMajorTickThreshold 
public int EndPointMajorTickThreshold { get; set; }

Property Value

int

GridStripColor

Grid strip color. Views AxisLayout.AxisGridStrips property must define the strips to be used in order for this color to have any effect.

public Color GridStripColor { get; set; }

Property Value

Color

LabelTicksGap

Gap between labels and ticks. Value is in pixels.

public double LabelTicksGap { get; set; }

Property Value

double

OwnerView

Owner view.

[Browsable(false)]
public ViewXY OwnerView { get; }

Property Value

ViewXY

PanningEnabled

Panning is enabled.

public bool PanningEnabled { get; set; }

Property Value

bool

PreferEndPointLabelsOverNearbyMajorTick

Defines if end point labels should be always visible, and nearby major tick labels should be hidden instead of the axis end point labels.

public bool PreferEndPointLabelsOverNearbyMajorTick { get; set; }

Property Value

bool

RangeRevertEnabled

Range revert enabled. Disable this if you don't want the RangeRevert operation to effect this axis.

public bool RangeRevertEnabled { get; set; }

Property Value

bool

Remarks

RangeRevert operation must be defined in ZoomPanOptions.

RangeRevertMaximum

Range revert maximum. Sets axis Maximum to this value when Range revert operation is applied with mouse, or called by code.

public double RangeRevertMaximum { get; set; }

Property Value

double

RangeRevertMinimum

Range revert minimum. Sets axis Minimum to this value when Range revert operation is applied with mouse, or called by code.

public double RangeRevertMinimum { get; set; }

Property Value

double

Reversed

Set true if you want to have low values higher and the high values lower on the graph.

public bool Reversed { get; set; }

Property Value

bool

ScaleNibs

Scale nib appearance.

public AxisDragNib ScaleNibs { get; set; }

Property Value

AxisDragNib

ZoomOrigin

Gets or sets zoom origin.

public double ZoomOrigin { get; set; }

Property Value

double

ZoomingEnabled

Zooming is enabled.

public bool ZoomingEnabled { get; set; }

Property Value

bool

Methods

Construct()

Initialize members. Implementation differs with WPF slightly.

protected override void Construct()

CreateScaleNib()

Create scale nib.

protected virtual void CreateScaleNib()

Dispose(bool)

Dispose.

protected override void Dispose(bool disposing)

Parameters

disposing bool
LightningChartLib.WinForms.Charting.Axes.AxisXYBase

GetActiveAxisArea()

Get active axis area (in PX).

public RectangleXY GetActiveAxisArea()

Returns

RectangleXY

Axis active rectangle with absolute coordinates [PX].

GetMajorTicks()

Get major ticks for current axis range.

public double[] GetMajorTicks()

Returns

double[]

Major tick positions, in ascending order.

Remarks

Does not return CustomTicks, but always recalculates automatic ticks (AutoDivSpacing enabled) or user defined interval ticks from axis range.

IsPositionOver(int, int, bool)

Defines if mouse is over an item.

public override bool IsPositionOver(int x, int y, bool useDIP = false)

Parameters

x int

Mouse X-coordinate.

y int

Mouse Y-coordinate.

useDIP bool

Use DIP instead of pixels as parameters.

Returns

bool

True if mouse is over item, false otherwise.

OnDeserialized(StreamingContext)

OnDeserialized is called just after the object has been deserialized

[OnDeserialized]
protected void OnDeserialized(StreamingContext context)

Parameters

context StreamingContext

Context

SetProperCursor()

Set proper cursor. Default for dragging is hand and for resize SizeAll.

public override void SetProperCursor()

StoreRangeRevertValues(double, double)

Store Revert values, minimum and maximum at same time.

public void StoreRangeRevertValues(double minimum, double maximum)

Parameters

minimum double

Minimum

maximum double

Maximum