Click or drag to resize
NChartValueAxis Class
The NChartValueAxis class provides methods to display the value axis of the chart.
Inheritance Hierarchy
SystemObject
  NChart3D_UWPNChartValueAxis

Namespace:  NChart3D_UWP
Assembly:  NChart3D_UWP (in NChart3D_UWP.dll)
Syntax
public sealed class NChartValueAxis : INChartObject, 
	INChartAxis

The NChartValueAxis type exposes the following members.

Properties
  NameDescription
Public propertyAlwaysShowZero
Flag that determines whether zero is always on the axis. This flag makes sense if MinValue and MaxValue are both less or greater than zero and are beautified according to the data source. In this case if this flag is false it may happen that no zero will be on the axis (for example if MinValue = 11.5 and MaxValue = 19 the axis will probably start with 10 and end with 20 having 4 steps). With this flag set to true zero will always be on the axis so even with MinValue = 11.5 and MaxValue = 19 the axis will start with 0 and end with 20 having probably 5 steps or so. The default value is false.
Public propertyCaption
Caption of the axis.
Public propertyCaptionIn3D
Flag that determines whether the axis caption is in "perspective" screen (true) or is projected in the 2D screen (false). This flag only affects 3D-charts. The deafult value is true.
Public propertyChart
Chart the object belongs to. This property is assigned automatically whenever the object is assigned to the chart.
Public propertyColor
Color of the axis line.
Public propertyDataSource
Data source of the axis.
Public propertyDateStep
Time interval from one date tick to another in seconds. It is either obtained from the data source or, if not provided, calculated according to the MinDate and MaxDate to look beautiful. This property works in date mode only, if HasDates is true.
Public propertyDelegate
Delegate of the axis.
Public propertyFont
Font for the ticks' labels.
Public propertyHasDates
Flag indicating if axis displays dates instead of values (YES) or regular values (NO). The default value is NO.
Public propertyHasOffset
Flag that determines if there should be an offset on the axis. The offset is the spacing from the beginning of the axis to the first tick and from the last tick to the end of the axis. If this flag is true the spacing is half a step. If false spacing is zero.
Public propertyIsLogarithmic
Flag determining if axis has logarithmic scale (true) or linear scale (false). The default value is false. The base of scale's logarithm is controlled by LogarithmBase property.
Public propertyKind
Kind of axis.
Public propertyLabelsAlignment
Alignment of the axis labels relative to the axis ticks. The default value is NChartAxisLabelsAlignment.Center.
Public propertyLabelsAngle
Axis labels' rotation angle. See NChart.DrawIn3D. See LabelsIn3D.
Public propertyLabelsIn3D
Flag that determines whether the axis labels are in "perspective" screen (true) or are projected in the 2D screen (false). This flag only affects 3D-charts. The default value is true.
Public propertyLabelsLineBreakMode
Line break mode for axis labels. The default value is UILineBreakMode.ByWordWrapping.
Public propertyLabelsVisible
Flag that determines if the labels of ticks are visible (true) or not (false). The default value is true.
Public propertyLength
Length of axis in 3D scene units. This value is obtained from the data source or if not provided is assigned to 1. It has an effect for axes being displayed in 3D only. In 2D this value is ignored because axes fill the whole area available on the screen. One 3D scene unit is equal to half a screen size by initial zoom (so space of the 3D scene is actually nonlinear respective to the screen). Therefore by default all axes have equal length and form a kind of cube in 3D that is centered on the screen and is as big as half of the biggest screen's dimension. However if you want for example to make the Z-axis shorter than the others you can provide a length of 0.5 for it. It will therefore be twice as short as the others.
Public propertyLineDash
Dash of the axis' line.
Public propertyLineVisible
Flag that determines if the line of the axis is visible (true) or not (false). The default value is false.
Public propertyLogarithmBase
Base of logarithm for logarithmic scale. The default value is 10. This property takes effect if IsLogarithmic is set to true only.
Public propertyMajorTicks
Major ticks of the axis. Major ticks are spread from the minValue to the maxValue through step or if no MinValue and MaxValue are provided but a ticks array is provided the whole axis length is divided by the number of ticks and for each tick there is a major tick displayed. Major ticks can be labeled.
Public propertyMarks
Array of axis marks.
Public propertyMaxDate
Maximal date on the axis. It is obtained from the data source and, if needed, processed to look more beautiful. This property works in date mode only, if HasDates is true.
Public propertyMaxLabelLength
Maximal allowed label length in pixels. If 0, maximal label width is calculated automatically according to the length between neighbor ticks. The default value is 0.
Public propertyMaxValue
Maximal value on the axis. It is obtained from the data source and if needed processed to look more beautiful.
Public propertyMinDate
Minimal date on the axis. It is obtained from the data source and, if needed, processed to look more beautiful. This property works in date mode only, if HasDates is true.
Public propertyMinorTicks
Minor ticks of the axis. Minor ticks are displayed in the middle between two neighbor major ticks. See MajorTicks for details.
Public propertyMinTickSpacing
Minimal spacing between neighbor ticks in pixels (the tick is the center place for the tick label, a kind of milestone on the axis). According to this value some labels can be hidden, if there are too many of them. The default value is 50.
Public propertyMinValue
Minimal value on the axis. It is obtained from the data source and if needed processed to look more beautiful.
Public propertyPositionX
Coordinate controlling horizontal position of the axis. See also NChartAxisPositionCoord.
Public propertyPositionY
Coordinate controlling vertical position of the axis. See also NChartAxisPositionCoord.
Public propertyPositionZ
Coordinate controlling depth position of the axis. See also NChartAxisPositionCoord.
Public propertyShouldAutoFitZoomByMinTickSpacing
Flag determining if zoom of the axis should be automatically fit according to the current MinTickSpacing (true) or not (false). The default value is false. Set this flag to true if you want to zoom the chart so that the maximal number of points is visible with no skipping of ticks on the axis. Best practice is to set this flag and call CalcOptimalMinTickSpacing. If this flag is set to true, zoom of the axis is changed automatically by each chart's layout. Zoom you set manually before layout will be ignored. Auto fitting works in 2D mode only.
Public propertyShouldBeautifyMinAndMax
Flag that detemines whether min and max values on the axis should be beautified in case they are calculated (true) or not (false). The default vaule is true.
Public propertyStep
Step from one tick to another. It is either obtained from the data source or if not provided calculated according to the MinValue and MaxValue to look beautiful.
Public propertyTextColor
Color of the text for the ticks' labels.
Public propertyThickness
Thickness of the axis' line in pixels.
Public propertyTickCount
Number of ticks on the axis. It is the number of ticks in an array or the number of values between MinValue and MaxValue through step.
Public propertyTicks
Array of strings that are displayed as ticks on the axis. It is obtained from the data source or null if not provided.
Public propertyTinyTickIntervalsPerInterval
Number of tiny intervals the interval between two consecutive major ticks is split up into. Tiny intervals are bounded with the tiny ticks. The default value is 0, which means no tiny ticks are displayed. If for example this value is 10, that means each interval between two labels is split up into 10 sub-intervals and therefore should have 11 tiny ticks inside. However, only 8 tiny ticks will be visible, and 1th, 6th and 11th ticks will be discarded, because they potentially overlap with major/minor ticks (even if major/minor ticks are switched off).
Public propertyTinyTicks
Tiny ticks of the axis. Tiny ticks are displayed between consecutive major ticks. However there is a gap in tiny ticks where tiny ticks potentially overlap with major / minor ticks(even if major / minor ticks are switched off). See MajorTicks, MinorTicks and TinyTickIntervalsPerInterval for details.
Public propertyVisible
Flag that determines if the object is visible (true) or not (false). The default value is true.
Top
Methods
  NameDescription
Public methodAddMark
Add axis mark.
Public methodCalcOptimalMinTickSpacing
Calculate optimal value for MinTickSpacing. Use this method if you want to get MinTickSpacing that corresponds to the actual lengths of axis ticks' labels. You should call this method _after_ the UpdateData call of the chart, because this method operates with the data obtained from data source. If you call it before the data are updated, the result will be wrong.
Public methodEquals (Inherited from Object.)
Public methodFitZoomByMinTickSpacing
Fit the zoom according to the current MinTickSpacing. Use this method if you want to zoom the chart so that the maximal number of points is visible with no skipping of ticks on the axis. This method requires frame of the chart to be determined. So if you call this method before the chart's layout, it will fail. If you want the axes to be automatically zoomed according to the MinTickSpacing, use the flag ShouldAutoFitZoomByMinTickSpacing.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodRemoveAllMarks
Remove all axis marks.
Public methodRemoveMark
Remove axis mark.
Public methodToString (Inherited from Object.)
Public methodZoomToRegion(Single, Single, Single, Single)
Zoom to given region by specifying the least and the greatest values that should be visible on the axis. If the axis has array of ticks indices in this array can be used. Use this method after you updated data of the chart with UpdateData call.
Public methodZoomToRegion(DateTimeOffset, DateTimeOffset, Single, Single)
Zoom to given region by specifying the earliest and the latest dates that should be visible on the axis. This method works in date mode only, if property HasDates is true. Use this method after you updated data of the chart with UpdateData call.
Top
See Also