Click or drag to resize

AxisBase Class

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

Namespace:  Arction.Wpf.ChartingMVVM.Axes
Assembly:  Arction.Wpf.ChartingMVVM.LightningChart (in Arction.Wpf.ChartingMVVM.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 if user interaction is allowed. This is a dependency property.
(Inherited from UserInteractiveObject.)
Public propertyAutoDivSeparationPercent
Gets or sets labels gap in percents of their height when AutoDivSpacing is enabled. This is a dependency property.
Public propertyAutoDivSpacing
Gets or sets automatic division spacing. This is a dependency property.
Public propertyAutoFormatLabels
Gets or sets if automatically determines number of decimals or time format. This is a dependency property.
Public propertyAxisColor
Gets or sets axis line color. This is a dependency property.
Public propertyAxisThickness
Gets or sets thickness of the axis line. This is a dependency property.
Public propertyCanFreeze
Gets a value that indicates whether the object can be made unmodifiable.
(Inherited from Freezable.)
Public propertyCustomTicks
Gets or sets 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. This is a dependency property.
Public propertyCustomTicksEnabled
Gets or sets custom ticks on/off. Uses the ticks defined in CustomTicks property. This is a dependency property. If this is enabled, only major ticks are drawn, not minor.
Public propertyDateOriginDay
Gets or sets date origin day. Keep this as close as possible to your actual first date. This is a dependency property. Applies when using DateTime formatted axis.
Public propertyDateOriginMonth
Gets or sets date origin month. Keep this as close as possible to your actual first date. This is a dependency property. Applies when using DateTime formatted axis.
Public propertyDateOriginYear
Gets or sets date origin year. Keep this as close as possible to your actual first date. This is a dependency property. Applies when using DateTime formatted axis.
Public propertyDateTimeRange
Gets or sets the string presentation of axis range. This property is affects when ValueType is DateTime. This is a dependency property.
Public propertyDependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Public propertyDispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
Public propertyDivisionReduction
Gets or sets if divisions are reduced, when Automatic division spacing is not set, and divisions get too close to each other. This is a dependency property.
Public propertyHighlight
Gets or sets highlight style. Item can be highlighted by user interactive device or by code. This is a dependency property.
(Inherited from HighlightingItemBase.)
Public propertyIsFrozen
Gets a value that indicates whether the object is currently modifiable.
(Inherited from Freezable.)
Public propertyIsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
Public propertyKeepDivCountOnRangeChange
Gets or sets if division count prefer magnitude. This is a dependency property. When true, keeps division count instead of division magnitude, when axis min or max is changed. When false, keeps division magnitude instead instead of count.
Public propertyLabelsAngle
Gets or sets labels rotation angle, in degrees. This is a dependency property.
Public propertyLabelsColor
Gets or sets labels color. This is a dependency property.
Public propertyLabelsFont
Gets or sets labels font. This is a dependency property.
Public propertyLabelsNumberFormat
Gets or sets labels number format, used when ValueType is 'Number'. This is a dependency property.
Public propertyLabelsTimeFormat
Gets or sets labels number format, used when ValueType is 'Time'. This is a dependency property.
Public propertyLabelsVisible
Gets or sets labels visibility. This is a dependency property.
Public propertyLogBase
Gets or sets logarithmic base. Applies only when ScaleType is set to Logarithmic. This is a dependency property.
Public propertyLogLabelsType
Gets or sets logarithmic axis labels special formatting type. This is a dependency property.
Public propertyLogZeroClamp
Gets or sets zero clamp value. Values below this limit will get this limit value when logarithmic presentation is used. This is needed to handle 0 and values below that. This is a dependency property.
Public propertyMajorDiv
Gets or sets major tick interval (units / division). This is a dependency property.
Public propertyMajorDivCount
Gets or sets major division count. This is a dependency property.
Public propertyMajorDivTickStyle
Gets or sets major division ticks style. This is a dependency property.
Public propertyMajorGrid
Gets or sets grid at major divisions. This is a dependency property.
Public propertyMaximum
Gets or sets maximum axis value. This is a dependency property.
Public propertyMaximumDateTime
Gets or sets maximum axis value. Use this property when axis' ValueType is DateTime. This is a dependency property.
Public propertyMinimum
Gets or sets minimum axis value. This is a dependency property.
Public propertyMinimumDateTime
Gets or sets minimum axis value. Use this property when axis' ValueType is DateTime. This is a dependency property.
Public propertyMinorDivCount
Gets or sets minor division count. The count of divisions inside a major division. This is a dependency property.
Public propertyMinorDivTickStyle
Gets or sets minor division ticks style. This is a dependency property.
Public propertyMinorGrid
Gets or sets grid at minor divisions. This is a dependency property.
Public propertyScaleType
Gets or sets axis scale type. This is a dependency property.
Public propertyValueType
Gets or sets value type: time, numeric or coordinates. This is a dependency property.
Public propertyVisible
Gets or sets axis visibility. This is a dependency property.
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 methodClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
Public methodClone
Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values.
(Inherited from Freezable.)
Public methodCloneCurrentValue
Creates a modifiable clone (deep copy) of the Freezable using its current values.
(Inherited from Freezable.)
Public methodCoerceValue
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.
(Inherited from DependencyObject.)
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 a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Public methodFormatAxisValue
Format axis value to string.
Public methodFreeze
Makes the current object unmodifiable and sets its IsFrozen property to true.
(Inherited from Freezable.)
Public methodGetAsFrozen
Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Public methodGetCurrentValueAsFrozen
Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Public methodGetHashCode
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
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 methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
Public methodInvalidateCustomTicks
Sets new custom ticks to take effect instantly. Call this after you have added the ticks in code.
Public methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
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 methodReadLocalValue
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
Public methodRemoveHighlight
Removes forced highlighting.
(Inherited from HighlightingItemBase.)
Public methodSetCurrentValue
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
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 methodSetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
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 eventChanged
Occurs when the Freezable or an object it contains is modified.
(Inherited from Freezable.)
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 fieldStatic memberAutoDivSeparationPercentProperty
Identifies the AutoDivSeparationPercent dependency property.
Public fieldStatic memberAutoDivSpacingProperty
Identifies the AutoDivSpacing dependency property.
Public fieldStatic memberAutoFormatLabelsProperty
Identifies the AutoFormatLabels dependency property.
Public fieldStatic memberAxisColorProperty
Identifies the AxisColor dependency property.
Public fieldStatic memberAxisThicknessProperty
Identifies the AxisThickness dependency property.
Public fieldStatic memberCustomTicksEnabledProperty
Identifies the CustomTicksEnabled dependency property.
Public fieldStatic memberCustomTicksProperty
Identifies the CustomTicks dependency property.
Public fieldStatic memberDateOriginDayProperty
Identifies the DateOriginDay dependency property.
Public fieldStatic memberDateOriginMonthProperty
Identifies the DateOriginMonth dependency property.
Public fieldStatic memberDateOriginYearProperty
Identifies the DateOriginYear dependency property.
Public fieldStatic memberDateTimeRangeProperty
Identifies the DateTimeRange dependency property.
Public fieldStatic memberDivisionReductionProperty
Identifies the DivisionReduction dependency property.
Public fieldStatic memberKeepDivCountOnRangeChangeProperty
Identifies the KeepDivCountOnRangeChange dependency property.
Public fieldStatic memberLabelsAngleProperty
Identifies the LabelsAngle dependency property.
Public fieldStatic memberLabelsColorProperty
Identifies the LabelsColor dependency property.
Public fieldStatic memberLabelsFontProperty
Identifies the LabelsFont dependency property.
Public fieldStatic memberLabelsNumberFormatProperty
Identifies the LabelsNumberFormat dependency property.
Public fieldStatic memberLabelsTimeFormatProperty
Identifies the LabelsTimeFormat dependency property.
Public fieldStatic memberLabelsVisibleProperty
Identifies the LabelsVisible dependency property.
Public fieldStatic memberLogBaseProperty
Identifies the LogBase dependency property.
Public fieldStatic memberLogLabelsTypeProperty
Identifies the LogLabelsType dependency property.
Public fieldStatic memberLogZeroClampProperty
Identifies the LogZeroClamp dependency property.
Public fieldStatic memberMajorDivCountProperty
Identifies the MajorDivCount dependency property.
Public fieldStatic memberMajorDivProperty
Identifies the MajorDiv dependency property.
Public fieldStatic memberMajorDivTickStyleProperty
Identifies the MajorDivTickStyle dependency property.
Public fieldStatic memberMajorGridProperty
Identifies the MajorGrid dependency property.
Public fieldStatic memberMaximumDateTimeProperty
Identifies the MaximumDateTime dependency property.
Public fieldStatic memberMaximumProperty
Identifies the Maximum dependency property.
Public fieldStatic memberMinimumDateTimeProperty
Identifies the MinimumDateTime dependency property.
Public fieldStatic memberMinimumProperty
Identifies the Minimum dependency property.
Public fieldStatic memberMinorDivCountProperty
Identifies the MinorDivCount dependency property.
Public fieldStatic memberMinorDivTickStyleProperty
Identifies the MinorDivTickStyle dependency property.
Public fieldStatic memberMinorGridProperty
Identifies the MinorGrid dependency property.
Public fieldStatic memberScaleTypeProperty
Identifies the ScaleType dependency property.
Public fieldTag
Tag. Freely assignable object.
(Inherited from UserInteractiveObjectInt.)
Public fieldStatic memberValueTypeProperty
Identifies the ValueType dependency property.
Public fieldStatic memberVisibleProperty
Identifies the Visible dependency property.
Top
See Also