ChartDirector 6.0 (Ruby Edition)

WebChartViewer


WebChartViewer is the server side counterpart to the browser side Javascript JsChartViewer. It generates the necessary HTML tags to allow the JsChartViewer to support programming track cursors and using mouse clicks and drags to control zooming and scrolling. Its accepts AJAX chart update requests from JsChartViewer and responses to it. Many of the JsChartViewer attributes can be set or get on the server side through WebChartViewer.

MethodInheritedDescription
WebChartViewer(Self)Creates a new WebChartViewer object.
getRequest(Self)Gets the ActionController::AbstractRequest object used to create the WebChartViewer.
getId(Self)Gets the id of the WebChartViewer object.
setImageUrl(Self)Sets the URL used by the <IMG> tag to load the chart image.
getImageUrl(Self)Gets the URL used by the <IMG> tag to load the chart image.
setImageMap(Self)Sets the image map associated with the chart.
getImageMap(Self)Gets the image map associated with the chart.
setChartModel(Self)Sets the Javascript Chart Model of the chart for the purpose of support track cursors.
getChartModel(Self)Gets the Javascript Chart Model of the chart.
setChartMetrics(Self)Sets the chart metrics of the chart.
getChartMetrics(Self)Gets the chart metrics of the chart.
renderHTML(Self)Generates the HTML tags necessary to represent the chart, image map, and the JsChartViewer state.
partialUpdateChart(Self)Generates the response to a partial chart update request.
isPartialUpdateRequest(Self)Checks if the current HTTP Request is a partial update request (AJAX request) sent using JsChartViewer.partialUpdate.
isFullUpdateRequest(Self)Checks if the current HTTP request is a full update request containing information from a JsChartViewer.
isStreamRequest(Self)Checks if the current HTTP request is a stream update request sent using JsChartViewer.streamUpdate.
isAttachmentRequest(Self)Checks if the current partial update request (AJAX request) is an attachment request sent using JsChartViewer.partialUpdateAsAttachment.
isViewPortChangedEvent(Self)Checks if the JsChartViewer.ViewPortChanged event has occurred.
getSenderClientId(Self)Gets the id of the JsChartViewer that sends the current HTTP request.
setViewPortLeft(Self)Sets the position of the left side of the viewport.
getViewPortLeft(Self)Gets the position of the left side of the viewport.
setViewPortTop(Self)Sets the position of the top side of the viewport.
getViewPortTop(Self)Gets the position of the top side of the viewport.
setViewPortWidth(Self)Sets the width of the viewport.
getViewPortWidth(Self)Gets the width of the viewport.
setViewPortHeight(Self)Sets the height of the viewport.
getViewPortHeight(Self)Gets the height of the viewport.
setMouseUsage(Self)Sets the mouse usage mode.
getMouseUsage(Self)Gets the mouse usage mode.
setZoomDirection(Self)Sets the zoom direction for mouse zoom in/out actions.
getZoomDirection(Self)Gets the zoom direction for mouse zoom in/out actions.
setScrollDirection(Self)Sets the scroll direction for mouse scroll actions.
getScrollDirection(Self)Gets the scroll direction for mouse scroll actions.
setZoomInRatio(Self)Sets the magnification ratio for each zoom in click of the mouse.
getZoomInRatio(Self)Gets the magnification ratio for each zoom in click of the mouse.
setZoomOutRatio(Self)Sets the magnification ratio for each zoom out click of the mouse.
getZoomOutRatio(Self)Gets the magnification ratio for each zoom out click of the mouse.
setZoomInWidthLimit(Self)Sets the viewport width at maximum zoom in.
getZoomInWidthLimit(Self)Gets the viewport width at maximum zoom in for mouse zoom in actions.
setZoomOutWidthLimit(Self)Sets the viewport width at maximum zoom out.
getZoomOutWidthLimit(Self)Gets the viewport width at maximum zoom out for mouse zoom out actions.
setZoomInHeightLimit(Self)Sets the viewport height at maximum zoom in.
getZoomInHeightLimit(Self)Gets the viewport height at maximum zoom in for mouse zoom in actions.
setZoomOutHeightLimit(Self)Sets the viewport height at maximum zoom out.
getZoomOutHeightLimit(Self)Gets the viewport height at maximum zoom out for mouse zoom out actions.
setMinimumDrag(Self)Sets the minimum mouse drag distance before it is considered as an intentional drag.
getMinimumDrag(Self)Gets the minimum mouse drag distance before it is considered as an intentional drag.
setSelectionBorderWidth(Self)Sets the border width of the zoom selection box.
getSelectionBorderWidth(Self)Gets the border width of the zoom selection box.
setSelectionBorderColor(Self)Sets the border color of the zoom selection box as an HTML color.
getSelectionBorderColor(Self)Gets the border color of the zoom selection box.
setZoomInCursor(Self)Sets the mouse cursor to be used when the mouse is used for zoom in.
getZoomInCursor(Self)Gets the mouse cursor to be used when the mouse is used for zoom in.
setZoomOutCursor(Self)Sets the mouse cursor to be used when the mouse is used for zoom out.
getZoomOutCursor(Self)Gets the mouse cursor to be used when the mouse is used for zoom out.
setNoZoomCursor(Self)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.
getNoZoomCursor(Self)Gets the mouse cursor to be used when the mouse is used for zoom in/out, but the zoom in/out limits has been reached.
setScrollCursor(Self)Sets the mouse cursor to be used when the mouse is used for scrolling.
getScrollCursor(Self)Gets the mouse cursor to be used when the mouse is used for scrolling.
setCustomAttr(Self)Sets a custom attribute.
getCustomAttr(Self)Gets a custom attribute.
setFullRange(Self)Defines the full range of a viewport data scale.
getValueAtViewPort(Self)Converts a viewport coordinate to a value of the specified data scale.
getViewPortAtValue(Self)Converts a value of the specified data scale to a viewport coordinate.
syncLinearAxisWithViewPort(Self)Synchronizes a linear Axis with the part of the data scale in viewport.
syncLogAxisWithViewPort(Self)Synchronizes a logarithmic Axis with the part of the data scale in viewport.
syncDateAxisWithViewPort(Self)Synchronizes a date/time Axis with the part of the data scale in viewport.