BCGSuite for MFC
CBCGPChartAxisX

Detailed Description

The CBCGPChartAxisX implements specific X axis features.

The library automatically creates two X axes with BCGP_CHART_X_PRIMARY_AXIS and BCGP_CHART_X_SECONDARY_AXIS IDs so you can obtain them using CBCGPChartVisualObject::GetChartAxis method.

+ Inheritance diagram for CBCGPChartAxisX:

Public Member Functions

 CBCGPChartAxisXConstructs X axis.
 
 IsDisplayDataBetweenTickMarksTells whether data points on X axis are displayed on tick marks, or between tick marks.
 
 ResetResets an axis to a default state.
 
- Public Member Functions inherited from CBCGPChartAxis
 AddScaleBreakAdds a new scale break.
 
 CalcMinMaxDisplayedValuesCalled to calculate minimum and maximum displayed values.
 
 CanBeScrolledTells whether an axis can be scrolled.
 
 CanShowScrollBarSpecifies whether an axis can display a scroll bar.
 
 CanUseScaleBreaksTells whether an axis can display scale breaks.
 
 EnableAllUnitsOnFixedIntervalSpecifies whether partially visible data points for a fixed interval width should be drawn.
 
 EnableIndependentZoomEnables or disables independent zoom.
 
 EnableMajorUnitIntervalInterlacingEnables major unit interlacing.
 
 EnableScaleBreaksEnables or disables axis scale breaks.
 
 EnableScrollEnables or disables axis scrolling.
 
 EnableZoomEnables or disables axis zooming.
 
 GenerateScaleBreaksGenerates scale breaks.
 
 GetAxisGapGets the distance between two axes that share the same perpendicular axis.
 
 GetAxisPosGets axis start and end points in client coordinates.
 
 GetAxisRectGets an axis rectangle.
 
 GetAxisSizeCalculates axis size in pixels.
 
 GetBottomOffsetGets axis offset from the bottom or left side of the diagram area.
 
 GetBoundingRectReturns bounding rectangle of this axis and its perpendicular axis.
 
 GetBoundingRectsReturns a list of bounding rectangles formed by this axis and its perpendicular axes.
 
 GetCrossValuePosReturns current cross value.
 
 GetCustomPerpendicularAxisReturns a pointer to custom perpendicular axis.
 
 GetDisplayUnitsReturns displayed units.
 
 GetFirstInterlacedIntervalIndexReturns first interlaced interval index.
 
 GetFixedIntervalWidthReturns fixed interval width.
 
 GetFixedIntervalWidthScaledReturns fixed interval width in device units taking into account DPI settings.
 
 GetIndexedSeriesReturns indexed series.
 
 GetInterlaceStepReturns interlace step.
 
 GetLabelDistanceReturns distance between axis labels and the axis line.
 
 GetLogScaleBaseReturns current logarithmic scale base.
 
 GetMajorTickMarkLenReturns size, in pixels, of major tick marks.
 
 GetMajorUnitReturns major axis unit.
 
 GetMaxDisplayedValueReturns maximum displayed value.
 
 GetMaxScrollValueReturns maximum scroll value.
 
 GetMaxZoomInFactorReturns maximal zoom factor.
 
 GetMinDisplayedValueReturns minimum displayed value.
 
 GetMinorUnitCountReturns minor unit count.
 
 GetMinScrollValueReturns minimum scroll value.
 
 GetRightOffsetAsNumberOfValuesConverts offset in pixels to offset in values, taking into account the current zoom level.
 
 GetRightOffsetInPixelsReturns offset from the right bound of plot area in pixels.
 
 GetScaleBreakCountReturns a number of scale breaks.
 
 GetScaleBreaksOptionsReturns scale break options.
 
 GetScrollBarRectReturns bounding rectangle of scroll bar.
 
 GetSplitBottomReturns a pointer to a next split axis located at the bottom of this axis.
 
 GetSplitTopReturns a pointer to a next split axis located at the top of this axis.
 
 GetTopOffsetReturns a top offset for an axis.
 
 GetValuesPerIntervalReturns a number of values per interval.
 
 HasSeriesTells whether there is at least one series, which is displayed on an axis.
 
 HitTestRetrieves hit test info for an axis.
 
 IsAllUnitsOnFixedIntervalTells whether partially visible data points for a fixed interval width should be drawn.
 
 IsAlwaysShowScrollBarTells whether a scroll bar has an "always visible" flag set.
 
 IsAxisVisibleTells whether an axis is visible, or not.
 
 IsFixedDisplayRangeTells whether an axis displays some predefined fixed range.
 
 IsFixedIntervalWidthTells whether an axis works in "fixed interval width" mode.
 
 IsFixedMajorUnitTells whether a fixed major unit is specified.
 
 IsFixedMaximumDisplayValueTells whether a fixed maximum displayed value has been specified.
 
 IsFixedMinimumDisplayValueTells whether a fixed minimum displayed value has been specified.
 
 IsIndependentZoomEnabledTells whether the independent zoom option is turned on or off.
 
 IsIndexedSeriesTells whether an axis works in "indexed" mode.
 
 IsMajorGridLinesVisibleTells whether an axis displays major grid lines, or not.
 
 IsMajorUnitIntervalInterlacingEnabledTells whether major unit interlacing is enabled.
 
 IsMinorGridLinesVisibleTells whether an axis displays minor grid lines, or not.
 
 IsScaleBreakEnabledTells whether scale breaks feature is enabled or not.
 
 IsScrollEnabledTells whether an axis can be scrolled.
 
 IsVerticalTells whether an axis is vertical or horizontal.
 
 IsZoomedTells whether an axis is zoomed.
 
 IsZoomEnabledTells whether zoom is enabled for an axis.
 
 OnDrawCalled to draw an axis.
 
 OnDrawAxisLabelsCalled to draw axis labels.
 
 OnDrawAxisName3DCalled to draw axis name for 3D chart.
 
 OnDrawMajorGridLinesCalled to draw major grid lines.
 
 OnDrawMinorGridLinesCalled to draw minor grid lines.
 
 OnDrawScaleBreaksCalled to draw a scale break.
 
 OnDrawScrollBarCalled to draw a scroll bar.
 
 OnFillUnitIntervalsCalled to fill major unit intervals with alternative color.
 
 PointFromValueGiven a value in axis units calculates a point in client coordinates.
 
 RemoveAllBreaksRemoves all scale breaks that have been added manually.
 
 RemoveCustomAxisCalled for a custom axis when it's about to be removed from the chart.
 
 ScrollToScrolls an axis to the specified value.
 
 SetAlwaysShowScrollBarEnables an axis to always show a scroll bar.
 
 SetAutoDisplayRangeSets automating display range (scaling).
 
 SetAutoIntervalWidthSets automatic interval width mode.
 
 SetAxisOffsetsSets axis offsets.
 
 SetCustomPerpendicularAxisSpecifies a perpendicular axis for an axis.
 
 SetDisplayDataBetweenTickMarksCauses data points to be displayed between tick marks.
 
 SetDisplayUnitsSets display units.
 
 SetFirstInterlacedIntervalIndexSets index of first interlaced interval.
 
 SetFixedDisplayRangeSets fixed display range.
 
 SetFixedIntervalWidthSets "fixed interval" mode.
 
 SetFixedMajorUnitSets fixed major unit.
 
 SetFixedMaximumDisplayValueSets fixed maximum displayed value.
 
 SetFixedMinimumDisplayValueSets fixed minimum displayed value.
 
 SetFixedUnitCountSets a value that fixes the number of displayed major units.
 
 SetIndexedSeriesSets indexed series.
 
 SetInterlaceStepSets interlace step value.
 
 SetLogScaleEnables or disables logarithmic scale for the axis.
 
 SetMajorTickMarkLenSets length, in pixels, of major tick marks.
 
 SetMaximumValueSets the maximum value on an axis.
 
 SetMaxZoomInFactorSets maximal zoom factor.
 
 SetMinAllowedMajorUnitSets minimal allowed major unit value.
 
 SetMinimumValueSets the minimum value on an axis.
 
 SetMinorTickMarkLenSets length, in pixels, of minor tick marks.
 
 SetMinorUnitCountSets the minor unit count.
 
 SetMinThumbSizeSets minimum thumb size.
 
 SetRightOffsetInPixelsSets offset of last displayed value in pixels for charts in "fixed interval" mode.
 
 SetScrollBarSizeSets scroll bar size.
 
 SetScrollRangeDefines a scroll range for an axis.
 
 SetVerticalSets axis orientation.
 
 ShowMajorGridLinesShows or hides major grid lines.
 
 ShowMinorGridLinesShows or hides minor grid lines.
 
 ShowScrollBarEnables an axis to display a scroll bar.
 
 SplitSplits an axis creating an additional custom axis.
 
 UnZoomSets zoom 100% on an axis.
 
 ValueFromPointGiven a point in client coordinates calculates corresponding axis value.
 
 ZoomZooms an axis.
 

Public Attributes

 m_arCategoriesArray of strings that contains a set of categories to be displayed on X axis as major tick mark labels.
 
- Public Attributes inherited from CBCGPChartAxis
 m_axisLabelsFormatDefines appearance of axis labels.
 
 m_axisLabelTypeDefines location of axis labels.
 
 m_axisLineFormatSpecifies an axis line style.
 
 m_axisNameFormatDefines appearance of axis name.
 
 m_bAlwaysVisibleForces an axis to be visible, even it does not have any related series.
 
 m_bDisplayAxisNameSpecifies whether an axis name should be displayed, or not.
 
 m_bFormatAsDatePuts an axis to "date/time" mode.
 
 m_bReverseOrderTells an axis to display data in reverse order.
 
 m_brIntervalSpecifies alternative color for major unit interval interlacing.
 
 m_bVisibleSpecifies whether an axis is visible or not.
 
 m_crossTypeSpecifies cross type for an axis.
 
 m_dblCrossOtherAxisValueSpecifies a value on a perpendicular axis where this axis crosses it.
 
 m_dblLabelDistanceSpecifies distance between axis labels and axis line.
 
 m_majorGridLineFormatFormats major grid lines.
 
 m_majorTickMarkTypeSpecifies major tick mark type.
 
 m_minorGridLineFormatFormats minor grid lines.
 
 m_minorTickMarkTypeSpecifies minor tick mark type.
 
 m_nAxisIDSpecifies axis ID.
 
 m_nMaxTotalLinesSpecifies how many major units an axis can display.
 
 m_strAxisNameSpecifies axis name.
 
 m_strDataFormatFormats axis labels.
 
 m_szMaxFixedLabelSizeDeclares maximal axis label size.
 

Protected Member Functions

 CBCGPChartAxisXConstructs X axis.
 
- Protected Member Functions inherited from CBCGPChartAxis
 CBCGPChartAxisConstructs and initializes a chart axis object.
 
 CBCGPChartAxisConstructs and initializes a chart axis object.
 
 OnDrawScrollBarCalled to draw a scroll bar.
 

Additional Inherited Members

- Protected Attributes inherited from CBCGPChartAxis
 m_nMajorTickMarkLenSpecifies length of major tick marks.
 
 m_nMinorTickMarkLenSpecifies length of minor tick marks.