416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
This is the support page for the legacy Dundas Dashboard application. For assistance with the current Dundas BI application please click here.
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

DashboardAxis Class

Hide navigation
RSS
Modified on Fri, 07 Sep 2012 12:59 PM Categorized as Library Reference
Click to return to: Documentation | Designing Dashboards | DV Controls | Chart | Chart Properties


Represents an axis on a chart.

DashboardAxis is a DashboardControl.

Properties

Common

ImageImageProperty Name [Script Name]TypeDescription
[ActualScales]DashboardActualScaleCollectionGets the actual scales displayed along this axis, which may include automatic scale breaks.

Note: This value is not updated until the Axis Updated Interaction is triggered for this axis.
ImageAuto Margin Enabled [HasAutoMargin]boolIndicates whether margins are added to both sides of the range of data on each scale.

Note: Margins are based on the Default Interval property, and are only added to quantity-based scales if their Minimum and Maximum properties are set to Auto (null in script). Margins are not added to X axes if Visibility is set to Collapsed, or if Remove Gaps is set to True and the margins would take up half of the length of the axis or more.
Auto Margin Intervals [HasMarginIntervals]boolDetermines if axis labels, tick marks and grid lines are added within the automatic margins of the axis.
ImageAuto Margin Mode [AutoMarginMode]DashboardAxisMarginModeDetermines how automatic margins are added to the axis scales.
[AxisType]DashboardAxisTypeGets the type of the axis, which determines on which side of the chart it is displayed on rectangular charts.
[Chart]DashboardChartGets the chart this axis is associated with.
[Dimension]DashboardAxisDimensionGets the dimension of the axis, which determines its purpose and its direction when rendered on the chart.
[IsUpdatePending]boolGets a value indicating whether automatically-calculated values are out of date on this axis and its scales. If an update is pending, the values are not up-to-date until the Axis Updated Interaction is triggered for this axis.
[Location]DashboardAxisRectangularLocationGets the rendered location of this axis on a rectangular chart.
Reversed [IsReversed]boolIndicates whether the rendered axis origin is reversed (the minimum and maximum are switched).

Note: Reversing an axis causes the X or Y axis that is adjacent to it to switch sides to follow the origin.
Scale [Scale]DashboardScaleBaseThe scale used to position data values and axis elements along this axis.

Appearance

ImageImageProperty Name [Script Name]TypeDescription
ImageLabels [Labeling]DashboardAxisLabelSettingsThe settings to apply to the axis labels.
ImageMajor Grid Lines [MajorGrid]DashboardAxisGridLineSettingsThe settings to apply to the major grid lines intersecting each scale.
ImageMajor Tick Marks [MajorTick]DashboardAxisTickMarkSettingsThe settings to apply to the major tick marks on each scale.
ImageImageMinor Grid Lines [MinorGrid]DashboardAxisGridLineSettingsThe settings to apply to the minor grid lines intersecting each scale.
ImageImageMinor Tick Marks [MinorTick]DashboardAxisTickMarkSettingsThe settings to apply to the minor tick marks on each scale.
ImageScale Breaks [ScaleBreak]DashboardScaleBreakSettingsSettings to apply to the scale breaks on Y axes.
ImageStroke [Stroke]DashboardBrushThe brush used to draw the axis line.
ImageStroke Pattern [StrokePattern]DashboardLinePatternTypeThe stroke pattern applied to the axis line.
ImageStroke Thickness [StrokeThickness]doubleThe thickness of the axis line in pixels.

Exceptions:

Layout

ImageImageProperty Name [Script Name]TypeDescription
Crossing Position [CrossingPosition]DashboardAxisCrossingPositionThe position along this axis where intersecting axes should cross. (This property is applicable only for the first axis along a dimension.)
Crossing Value [CrossingValue]stringThe text representation of the value used to position intersecting axes along this axis if Crossing Position is set to Value. (This property is applicable only for the first axis along a dimension.)
ImageImageMarks Next To Axis [AreElementsNextToAxis]boolDetermines if tick marks and labels are displayed along this axis or along the outside of the plotting area when this axis is positioned inside.
ImageMaximum Margin Size [MaximumMarginSize]DashboardUnitLengthThe size of the margin added to the maximum of the axis, in addition to Auto Margins and space reserved by certain chart types.
ImageMinimum Margin Size [MinimumMarginSize]DashboardUnitLengthThe size of the margin added to the minimum of the axis, in addition to Auto Margins and space reserved by certain chart types.
ImageImageMultiple Axis Margin [AxisMargin]doubleThe margin in pixels reserved between this axis and the axis following it in its parent collection. (Only applies with multiple axes.)
ImageTitle Rotation [TitleRotation]DashboardAxisTitleRotationThe axis title rotation to apply to vertical axis titles.
ImageImageTitle Margin [TitleMargin]doubleThe margin in pixels reserved between the title and the other axis elements.
ImageZ-Index [ZIndex]intThe z-index, which determines which elements are drawn over others if they overlap. A higher value places an element on top.

Text

ImageImageProperty Name [Script Name]TypeDescription
ImageFont Brush [Foreground]DashboardBrushThe brush used to paint text.
ImageFont Family [FontFamily]DashboardFontFamilyThe name of the font used for text.
ImageFont Size [FontSize]doubleThe size of the font (in pixels) used for text.
ImageFont Style [FontStyle]DashboardFontStyleThe style the font used for text.
ImageFont Weight [FontWeight]DashboardFontWeightThe weight the font used for text.
Title [Title]stringThe axis title.

Methods

AxisPositionToValue

Gets the data value for a given position along the axis.

  • object AxisPositionToValue( double axisPosition )

Parameters:
  • axisPosition: The axis position relative to the unreversed X or Y dimension. If this is a Y axis, 0 is the start at the bottom of the plotting area and 1 is at the top of the plotting area. If this is an X axis, 0 is the start at the left of the plotting area and 1 is the end at the right of the plotting area. The axis position is relative to the entire length of the axis, even if zoomed in so that only part of it is visible.

Return Value: The data value represented by the specified axis position; or null if none exists.

Exceptions:

PixelPositionToValue

Gets the data value the given pixel position represents along the axis.

  • object PixelPositionToValue( double pixelPosition )

Parameters:
  • pixelPosition: A visual position along this axis relative to the chart in pixels.

Return Value: The data value represented by the specified pixel position; or null if none exists.

ValueToAxisPosition

Gets the axis-relative position for a given data value.

  • double ValueToAxisPosition( object dataValue )

Parameters:
  • dataValue: The data value.

Return Value: The position value relative to the range of the axis between 0.0 and 1.0 used to represent the specified data value, or double.NaN if none exists. The axis position is relative to the unreversed X or Y dimension. If this is a Y axis, 0 is the start at the bottom of the plotting area and 1 is at the top of the plotting area. If this is an X axis, 0 is at the left of the plotting area and 1 is at the right of the plotting area. The axis position is relative to the entire length of the axis, even if zoomed in so that only part of it is visible.

ValueToPixelPosition

Gets the pixel position for the specified data value along the axis.


Parameters:
  • dataValue: The data value.

Return Value: The visual position of dataValue in pixels as a DashboardAxisPixelPosition relative to the chart.

Interactions

Updated

The Updated interaction lets you respond to changes to the data displayed along the axis and its scales.

ImageThis is an Advanced property.

Arguments:


This interaction can be triggered by changes in the values of data points or the number of data points, and happens after a short delay to ensure that all data point changes are handled together efficiently. The following properties may have changed automatically when this interaction is triggered, which can be accessed in script:
The IsUpdatePending property can be used to determine if this interaction has yet to be triggered.

Related topics




Click to return to: Documentation | Designing Dashboards | DV Controls | Chart | Chart Properties

About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2014 Dundas Data Visualization, Inc.