Click or drag to resize

AxisBase Class

LightningChart .NET Help
Base class for X- and Y-axes.
Inheritance Hierarchy

Namespace:  Arction.WinForms.Charting.Axes
Assembly:  Arction.WinForms.Charting.LightningChart (in Arction.WinForms.Charting.LightningChart.dll) Version: 10.3.1
Syntax
[SerializableAttribute]
public class AxisBase : HighlightingItemBase

The AxisBase type exposes the following members.

Properties
  NameDescription
Public propertyAllowUserInteraction
Gets or sets whether allow user interaction.
(Inherited from UserInteractiveObject.)
Public propertyAutoDivSeparationPercent
Labels gap in percents of their height when AutoDivSpacing is enabled.
Public propertyAutoDivSpacing
Automatic division spacing.
Public propertyAutoFormatLabels
Automatically determines number of decimals or time format.
Public propertyAxisColor
Axis line color.
Public propertyAxisThickness
Thickness of the axis line.
Public propertyCustomTicks
Custom axis ticks. Allows uneven major division spacing and label text setting. Note that to see the ticks you must set CustomAxisTicksEnabled property to true.
Public propertyCustomTicksEnabled
Custom ticks on/off. Uses the ticks defined in CustomTicks property. If this is enabled, only major ticks are drawn, not minor.
Public propertyDateOriginDay
Date origin day. Keep this as close as possible to your actual first date. Applies when using DateTime formatted axis.
Public propertyDateOriginMonth
Date origin month. Keep this as close as possible to your actual first date. Applies when using DateTime formatted axis.
Public propertyDateOriginYear
Date origin year. Keep this as close as possible to your actual first date. Applies when using DateTime formatted axis.
Public propertyDateTimeRange
Gets or sets the string presentation of axis range. This property effects when ValueType is DateTime.
Public propertyDivisionReduction
Reduce divisions when Automatic division spacing is not set, and divisions get too close to each other.
Public propertyHighlight
Gets or sets highlight style. Item can be highlighted by user interactive device or by code.
(Inherited from HighlightingItemBase.)
Public propertyKeepDivCountOnRangeChange
When true, keeps division count instead of division magnitude, when axis min or max is changed. When false, keeps division magnitude instead of count.
Public propertyLabelsAngle
Labels rotation angle, in degrees.
Public propertyLabelsColor
Labels color.
Public propertyLabelsFont
Labels font.
Public propertyLabelsNumberFormat
Labels number format, used when ValueType is 'Number'.
Public propertyLabelsTimeFormat
Labels number format, used when ValueType is 'Time'.
Public propertyLabelsVisible
Defines if labels are visible or not.
Public propertyLogBase
Logarithmic base. Applies only when ScaleType is set to Logarithmic.
Public propertyLogLabelsType
Logarithmic axis labels special formatting type.
Public propertyLogZeroClamp
Values below this limit will get this limit value when logarithmic presentation is used. This is needed to handle 0 and values below that.
Public propertyMajorDiv
Major tick interval (units / division).
Public propertyMajorDivCount
Major division count.
Public propertyMajorDivTickStyle
Major division ticks style.
Public propertyMajorGrid
Grid at major divisions.
Public propertyMaximum
Maximum axis value.
Public propertyMaximumDateTime
Maximum axis value. Use this property when axis' ValueType is DateTime.
Public propertyMinimum
Minimum axis value.
Public propertyMinimumDateTime
Minimum axis value. Use this property when X axis' ValueType is DateTime.
Public propertyMinorDivCount
Minor division count. The count of divisions inside a major division.
Public propertyMinorDivTickStyle
Minor division ticks style.
Public propertyMinorGrid
Grid at minor divisions.
Public propertyScaleType
Axis scale type.
Public propertyValueType
Value type: time, numeric or coordinates.
Public propertyVisible
Defines if axis is visible or not.
Top
Methods
  NameDescription
Public methodAxisValueToDateTime
Converts axis value to DateTime. The returned value uses value origin set by DateOrigin properties.
Public methodStatic memberCalculateUserFriendlyScaleRange
Calculates user friendly scale range. Fits the decimals so that they got values of 1, 2 and 5.
Public methodDateTimeToAxisValue
Converts a DateTime object to value on this axis. The returned value uses value origin set by DateOrigin properties.
Public methodDispose
Release all resources used by this instance.
(Inherited from ChartNode.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFormatAxisValue
Format axis value to string.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLabelsFormat
Get last used label format string. "E" is for 10 base log. "e" is for Neper base log. "" is for custom label format (unknown for chart). Consider using String.Format(returned format string) to format values.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInvalidateCustomTicks
Sets new custom ticks to take effect instantly. Call this after you have added the ticks in code.
Public methodIsHighlighted
returns true if the object is highlighted.
(Inherited from HighlightingItemBase.)
Public methodIsPositionOver
Defines if position is over an item.
(Inherited from UserInteractiveObject.)
Public methodRemoveHighlight
Removes forced highlighting.
(Inherited from HighlightingItemBase.)
Public methodSetDateOrigin
Set DateOriginYear, DateOriginMonth and DateOriginDay all at same time.
Public methodSetDateTimeRange
Set date time range. This effects when ValueType is DateTime.
Public methodSetHighlight
Highlights the object.

This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set.

(Inherited from HighlightingItemBase.)
Public methodSetProperCursor
Set proper drag cursor. Default is hand.
(Inherited from UserInteractiveObject.)
Public methodSetRange
Set axis range.
Public methodTimeString
Converts time value to string by given format. Handles also negative values and formats having more than three second fractions.
Public methodToString
Item to string.
(Inherited from HighlightingItemBase.)
Top
Events
  NameDescription
Public eventFormatValueLabel
Event to format axis tick value to custom string.
Public eventHighlightedStateChanged
Event telling that highlighted state has changed. Contains information of the new state.
(Inherited from HighlightingItemBase.)
Public eventMouseClick
Mouse button has been clicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDoubleClick
Mouse button has been doubleclicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDown
Mouse button has been pressed down.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOff
Mouse has been moved outside of object.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOn
Mouse has been moved over object.
(Inherited from UserInteractiveObject.)
Public eventMouseUp
Mouse button has been released.
(Inherited from UserInteractiveObject.)
Public eventRangeChanged
Range has changed (Minimum and/or Maximum value).
Top
Fields
  NameDescription
Public fieldTag
Tag. Freely assignable object.
(Inherited from UserInteractiveObjectInt.)
Top
See Also