WPFChartViewer

The WPFChartViewer control is a WPF control for viewing ChartDirector charts. It is a subclass of the WPF Canvas. Apart from displaying the charts, its main functions are to support advanced user interactions with the charts, including:

Hot Spot Support

The WPFChartViewer control displays tooltips and fires "hot spot mouse events" for hot spots when the mouse is moving or clicking on the hot spot. In the event handler, it provides information about the hot spot that triggers the event.

The hot spots, with attributes and tool tips, are defined using standard HTML image map format. The BaseChart.getHTMLImageMap method can be used to automatically generate image maps for charts. You may also add your own custom hot spots by appending additional image map to the image map generated by BaseChart.getHTMLImageMap.
Programmable Track Cursor Support

The WPFChartViewer control includes special methods and events for supporting programmable track cursors. It also manages the dynamic layer for drawing track cursors and other dynamic contents on the chart image.
Zoom and Scroll Support

The WPFChartViewer control includes special methods and events for supporting using mouse clicks and drags to control the "viewport". There are also methods for synchronizing the axis scales with the viewport.

The followings are members specific to the WPFChartViewer control. Members inherited from the WPF Canvas are omitted. Please refer to Microsoft documentation for members of the WPF Canvas.

Properties

Name	Description
Chart	Gets or sets a BaseChart object to be used with the WPFChartViewer.
ChartSizeMode	Determine the sizing method of the chart image.
ImageMap	Gets or sets the image map that defines the hot spots on the chart image.
CDMLToolTipPrefix	Gets or sets the CDML tooltip prefix.
ChartMouseX	Gets the mouse x-coordinate in the chart pixel coordinate system.
ChartMouseY	Gets the mouse y-coordinate in the chart pixel coordinate system.
PlotAreaMouseX	Gets the mouse x-coordinate on the plot area in the chart pixel coordinate system.
PlotAreaMouseY	Gets the mouse y-coordinate on the plot area in the chart pixel coordinate system.
ViewPortLeft	Gets or sets the position of the left side of the viewport.
ViewPortTop	Gets or sets the position of the top side of the viewport.
ViewPortWidth	Gets or sets the width of the viewport.
ViewPortHeight	Gets or sets the height of the viewport.
MouseUsage	Gets or sets the mouse usage mode.
ZoomDirection	Gets or sets the zoom direction for mouse zoom in/out actions.
ScrollDirection	Gets or sets the scroll direction for mouse scroll actions.
ZoomInRatio	Gets or sets the magnification ratio for each zoom in click of the mouse.
ZoomOutRatio	Gets or sets the magnification ratio for each zoom out click of the mouse.
MouseWheelZoomRatio	Gets or sets the magnification ratio for each mouse wheel event.
ZoomInWidthLimit	Gets or sets the viewport width at maximum zoom in.
ZoomOutWidthLimit	Gets or sets the viewport width at maximum zoom out.
ZoomInHeightLimit	Gets or sets the viewport height at maximum zoom in.
ZoomOutHeightLimit	Gets or sets the viewport height at maximum zoom out.
MinimumDrag	Gets or sets the minimum mouse drag distance before it is considered as an intentional drag.
SelectionBorderWidth	Gets or sets the border width of the zoom selection box.
SelectionBorderColor	Gets or sets the border color of the zoom selection box as a System.Windows.Media.Color.
HotSpotCursor	Gets or sets the cursor that is displayed when the mouse cursor is over a normal hot spot.
ZoomInCursor	Gets or sets the mouse cursor to be used when the mouse is used for zoom in.
ZoomOutCursor	Gets or sets the mouse cursor to be used when the mouse is used for zoom out.
NoZoomCursor	Gets or sets the mouse cursor to be used when the mouse is used for zoom in/out, but the zoom in/out limits has been reached.
ScrollCursor	Gets or sets the mouse cursor to be used when the mouse is used for scrolling.
UpdateInterval	Gets or sets the minimum gap interval between two ViewPortChanged events in milliseconds.
IsMouseOnPlotArea	Checks if the mouse cursor is on the extended plot area.
IsMouseDragging	Checks if the mouse is dragging on the plot area.
IsInMouseMoveEvent	Checks if the current code is executing in a WinChartViewer.MouseMoveChart event or WinChartViewer.MouseMovePlotArea event handler.
IsInViewPortChangedEvent	Checks if the current code is executing in a ViewPortChanged event.
Note: Properties inherited from System.Windows.Controls.Canvas are omitted.

Methods

Name	Description
setPlotAreaMouseMargin	Sets all margins (left, right, top, and bottom) of the plot area mouse event region to the same value.
setPlotAreaMouseMargin2	Sets the margins of the plot area mouse event region.
removeDynamicLayer	Calls BaseChart.removeDynamicLayer when the specified event occurs.
updateDisplay	Updates the display.
validateViewPort	Ensures the viewport left, top, width and height are within valid ranges and adjusts them if necessary.
updateViewPort	Triggers the ViewPortChanged event.
setFullRange	Defines the full range of a viewport data scale.
updateFullRangeH	Updates the full range of a horizontal viewport data scale.
updateFullRangeV	Updates the full range of a vertical viewport data scale.
getValueAtViewPort	Converts a viewport coordinate to a value of the specified data scale.
getViewPortAtValue	Converts a value of the specified data scale to a viewport coordinate.
syncLinearAxisWithViewPort	Synchronizes a linear Axis with the part of the data scale in viewport.
syncLogAxisWithViewPort	Synchronizes a logarithmic Axis with the part of the data scale in viewport.
syncDateAxisWithViewPort	Synchronizes a date/time Axis with the part of the data scale in viewport.
setDPI	Sets the DPI (scale factor) of the chart on the screen.
getDPI	Gets the DPI (scale factor) of the chart on the screen.
Note: Methods inherited from System.Windows.Controls.Canvas are omitted.

Events

Name	Description
MouseMoveChart	This event occurs when the mouse cursor moves over the chart.
MouseLeaveChart	This event occurs when the mouse cursor leaves the chart.
MouseMovePlotArea	This event occurs when the mouse cursor moves over the extended plot area.
MouseLeavePlotArea	This event occurs when the mouse cursor leaves the extended plot area.
ClickHotSpot	This event occurs when the mouse clicks on a hot spot on the chart image.
MouseEnterHotSpot	This event occurs when the mouse cursor enters a hot spot on the chart image.
MouseMoveHotSpot	This event occurs when the mouse cursor moves over a hot spot on the chart image.
MouseLeaveHotSpot	This event occurs when the mouse cursor leaves a hot spot on the chart image.
MouseDownHotSpot	This event occurs when the mouse cursor is over a hot spot on the chart image and the mouse button is pressed.
MouseUpHotSpot	This event occurs when the mouse cursor is over a hot spot on the chart image and the mouse button is released.
ViewPortChanged	This event occurs when the viewport is changed through mouse actions, or when WPFChartViewer.updateViewPort is called.
SelectionChanged	This event occurs when the user is selecting a region on the chart using "drag to select" mouse actions.
Note: Events inherited from System.Windows.Controls.Canvas are omitted.