dundas.controls.ChartViewportSettings Class

 

Inheritance Hierarchy

 
Class
   dundas.controls.ChartViewportSettings
 

Constructors

 
  Name Description
init Initializes the viewport settings for one dimension of a chart viewport.
 
 

Properties

 
  Name Description
axisType Gets or sets the axis type the viewport is relative to.
endValue Gets the axis value where the viewport ends.
isAutoZoomedToEnd Gets or sets a value indicating whether the scrollbar is initially scrolled to the end when automatically zooming into a specified range of the axis.
isScrollBarVisible Gets or sets a value indicating whether the scrollbar is visible for panning along this viewport when zoomed in.
maxVisibleCategories Gets or sets the maximum number of categories to display at a time when categorical data is changed, with the rest accessed by scrolling.
maxVisibleRange Gets or sets a value identifying a range of values along the axis to automatically zoom into, with the rest accessed by scrolling.
maxVisibleRangePromise Gets or sets a jQuery.Promise returning a start date or array of two dates identifying a range of values along the axis to automatically zoom into.
scrollBarThumbFill Gets or sets the brush used to fill the scrollbar track.
scrollBarTrackFill Gets or sets the brush used to fill the scrollbar track.
scrollBarWidth Gets or sets the size perpendicular to the axis of the scroll bar in pixels.
startValue Gets the axis value where the viewport ends.
 
 

Methods

 
  Name Description
clearHistory Clears zoom history.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
invalidate Ensures the data control is re-drawn using the current data and settings at the next best time made available by the browser. This method is normally called automatically when needed.
scroll Scrolls the viewport maintaining the same zoom level to include the positions of the specified values.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
toString Creates a string representation of this instance.
undoZoom Returns to the last zoom level and position before a change in the zoom level was made. If no previous zoom level is available, the viewport is zoomed out to display the entire chart.
zoom Zooms into the chart so that the visible parts of the axis starts and ends at the positions of the specified values.