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.

DashboardViewportSettings Class

Hide navigation
RSS
Modified on Thu, 31 May 2012 02:13 PM Categorized as Library Reference
Click to return to: Documentation | Designing Dashboards | DV Controls | Chart | Chart Properties


Provides settings for zooming and panning the chart viewport.

Properties

Common

ImageImageProperty Name [Script Name]TypeDescription
Maximum Visible Points [MaxVisiblePoints]intThe maximum number of visible points per series to allow when data is changed, or zero to not zoom in automatically.
[Size]doubleA positive value between 0 (exclusive) and 1 (inclusive) representing the size of the visible portion of the axes, relative to their full length.
[StartPosition]doubleThe axis position between 0 (inclusive) and 1 (exclusive) that defines the beginning of the visible portion of the axes.
ImageUndo Zoom Button Tooltip [UndoZoomButtonToolTipText]stringThe text displayed when the user hovers over the scrollbar's undo zoom button with their mouse.

Tip: The start position and size are relative to the axes of the chart. To convert these axis positions to values or vice versa, use the methods provided on DashboardAxis.

Appearance

ImageImageProperty Name [Script Name]TypeDescription
ImageImageEasing Duration [EasingDuration]TimeSpanThe length of the animation displayed when zooming in or out.
ImageEasing Enabled [IsEasingEnabled]boolIndicates whether chart elements are animated along this dimension when zooming in or out.
ImageImageEasing Function [EasingFunction]DashboardEasingFunctionThe easing function used while animating chart elements when zooming in or out.
ImageScrollbar Thickness [ScrollBarThickness]doubleThe width or height of the scrollbar in pixels that represents a size perpendicular to the axis.
Scrollbar Visible [IsScrollBarVisible]boolDetermines if the scrollbar is visible for panning along this viewport when zoomed in.

Layout

ImageImageProperty Name [Script Name]TypeDescription
ImageScrollbar Position [ScrollBarPosition]DashboardAxisTypeThe axis type along which to position the scrollbar.

Methods

Zoom

Zooms the viewport of the chart into the area specified along one dimension of the chart, and saves the current zoom state in case the zooming is undone.

  • Zoom( double startPosition, double size )

Parameters:
  • startPosition: A viewport start position relative to the axes along this dimension between zero (inclusive) and one (exclusive).
  • size: The viewport size in coordinates relative to an axis between zero (exclusive) and one (inclusive).

Tip: The parameters are relative to the axes of the chart. To convert data values to these axis positions, use the methods provided on DashboardAxis.

Exceptions:
  • ArgumentOutOfRangeException: Thrown if startPosition is not both greater than zero and less than or equal to one; or if size is less than zero.

UndoZoom

Undoes the last zoom operation caused by calling Zoom or zooming interactively using the chart cursor.

  • UndoZoom()

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.