Table of Contents

Class AxisRoundBase

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

Base class for round axes.

[TypeConverter(typeof(ExpandableObjectConverter))]
public abstract class AxisRoundBase : HighlightingItemBase, IChartNode, IDisposable, IHighlightingItem
Inheritance
AxisRoundBase
Implements
Derived
Inherited Members

Constructors

AxisRoundBase()

Constructor.

protected AxisRoundBase()

AxisRoundBase(ViewRoundBase)

Constructor.

protected AxisRoundBase(ViewRoundBase owner)

Parameters

owner ViewRoundBase
param owner M:LightningChartLib.WinForms.Charting.Axes.AxisRoundBase.#ctor(LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase)

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

AmplitudeAxisRenderedAngle

Angle in degrees the amplitude axis line is drawn at.

[Browsable(false)]
public double AmplitudeAxisRenderedAngle { get; }

Property Value

double

Remarks

Changes in this value can be observed using AmplitudeAxisAngleChanged event.

AngularAxisAutoDivSpacing

If false considers AngularAxisMajorDivCount, if true calculates number of grid lines on angular axis.

public bool AngularAxisAutoDivSpacing { get; set; }

Property Value

bool

AngularAxisCircleVisible

Angular axis circle visible.

public bool AngularAxisCircleVisible { get; set; }

Property Value

bool

AngularAxisMajorDivCount

Specifies the number of major grid lines on angular axis if auto div spacing is set to false.

public int AngularAxisMajorDivCount { get; set; }

Property Value

int

Remarks

Note that minimum value is two.

AngularAxisRenderedAngle

Angle in degrees the angular axis circle is drawn at.

[Browsable(false)]
public double AngularAxisRenderedAngle { get; }

Property Value

double

Remarks

Changes in this value can be observed using AngularAxisAngleChanged event.

AngularLabelsVisible

Angular label visible.

public bool AngularLabelsVisible { get; set; }

Property Value

bool

AngularUnitDisplay

Displayed angular unit. Default is degrees.

public AngularUnits AngularUnitDisplay { get; set; }

Property Value

AngularUnits

AntiAliasing

Anti-aliased draw. Drawing anti-aliased draws the axis with smooth edges, but will increase CPU/GPU overhead.

public bool AntiAliasing { get; set; }

Property Value

bool

AutoFormatLabels

Automatically format labels.

public bool AutoFormatLabels { get; set; }

Property Value

bool

AxisColor

Axis line color.

public Color AxisColor { get; set; }

Property Value

Color

AxisThickness

Thickness of the axis line.

public int AxisThickness { get; set; }

Property Value

int

GridAngular

Angular grid options.

public GridOptionsAngular GridAngular { get; set; }

Property Value

GridOptionsAngular

GridVisibilityOrder

Defines if the grid should be drawn behind or top of series information and axes.

public GridVisibilityOrder GridVisibilityOrder { get; set; }

Property Value

GridVisibilityOrder

LabelTicksGap

Gap between labels and ticks in pixels.

public double LabelTicksGap { get; set; }

Property Value

double

LabelsFont

Labels font

public Font LabelsFont { get; set; }

Property Value

Font

MarginOuter

Outer margin around this axis. Distance from the outmost axis item to the edge of the background. The item is either the axis line or label, depending on TickMarkLocation property.

public int MarginOuter { get; set; }

Property Value

int

ScaleNibs

Scale nib appearance.

public AxisDragNib ScaleNibs { get; set; }

Property Value

AxisDragNib

TickMarkLocation

Tick mark location.

public RoundGridTickmarkLocation TickMarkLocation { get; set; }

Property Value

RoundGridTickmarkLocation

Title

Axis title.

public RoundAxisTitle Title { get; set; }

Property Value

RoundAxisTitle

Units

Axis units.

public RoundAxisTitle Units { get; set; }

Property Value

RoundAxisTitle

Visible

Defines if axis is visible or not.

public bool Visible { get; set; }

Property Value

bool

Methods

AngleToString(SupplyCustomAngleStringEventArgs)

Convert angle to string.

protected void AngleToString(SupplyCustomAngleStringEventArgs args)

Parameters

args SupplyCustomAngleStringEventArgs

Arguments

Construct()

Create members.

protected virtual void Construct()

CreateGridOptionsAngular()

Create new angular grid options.

protected virtual void CreateGridOptionsAngular()

CreateLabelsFont()

Create labels' font.

protected abstract void CreateLabelsFont()

Dispose(bool)

Clean up any resources being used.

protected override void Dispose(bool disposing)

Parameters

disposing bool

True if managed resources should be disposed, otherwise false.

IsPositionOver(int, int, bool)

Check if mouse is over item.

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

Parameters

x int

X-coordinate.

y int

Y-coordinate.

useDIP bool

Use DIP instead of pixels as parameters.

Returns

bool
returns M:LightningChartLib.WinForms.Charting.Axes.AxisRoundBase.IsPositionOver(System.Int32,System.Int32,System.Boolean)

RebuildAngularGrid()

Rebuilds angular grid, ticks and labels

protected void RebuildAngularGrid()

SetProperCursor()

Set proper cursor.

public override void SetProperCursor()

ValueToCoord(IPointRound, bool)

Converts given point to screen coordinates.

public abstract PointFloat ValueToCoord(IPointRound value, bool useDIP = true)

Parameters

value IPointRound

Value of the given view. Actual interpretation depends on view type.

useDIP bool

Defines if the produced coordinates are to be in DIPs (Device independent pixels) or in actual pixels

Returns

PointFloat

Screen coordinates of the given point.

Events

AmplitudeAxisAngleChanged

Event that reports that the amplitude axis angle has changed.

public event AxisRoundBase.AngleChangedEventHandler AmplitudeAxisAngleChanged

Event Type

AxisRoundBase.AngleChangedEventHandler

AngularAxisAngleChanged

Event that reports that the angular axis angle has changed.

public event AxisRoundBase.AngleChangedEventHandler AngularAxisAngleChanged

Event Type

AxisRoundBase.AngleChangedEventHandler

SupplyCustomAngleString

Event to format angle as a custom string.

public event AxisRoundBase.SupplyCustomAngleStringEventHandler SupplyCustomAngleString

Event Type

AxisRoundBase.SupplyCustomAngleStringEventHandler