Perforce JViews Gantt JavaScript Reference: Class IlvChartViewProxy

Class IlvChartViewProxy

IlvObject
   |
   +--IlvPropertyStateManager
      |
      +--IlvFacesProxy
         |
         +--IlvSizedViewProxy
            |
            +--IlvBasicViewProxy
               |
               +--IlvChartViewProxy

Category:: Charts JSF component

JavaScript File:: IlvChartViewProxy.js

Description:: The IlvChartViewProxy is the proxy that handles an IlvChartView DHTML object.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvChartViewProxy(clientId, refNodeId, width, height, state)

Method Summary
Method Attributes	Method Name and Description
	addCapabilitiesLoadListener(listener) Adds a listener to be called when the capabilities have been loaded.
	addRequestParameters() Internal implementation.
	getBackgroundColor() Returns the background color of the generated image, if defined.
	getComponent() Returns the chart component to be displayed, if defined.
	getDataSourceId() Returns the identifier of the data source to be displayed, if defined.
	getDataWindow() Returns the visible window.
	getErrorMessage() Returns the message displayed when an error occurs while the image is loading.
	getImageMapGenerator() Returns the image map generator.
	getInteractor() Returns the current interactor set on this view.
	getInteractorId()
	getLegend() Internal implementation.
	getMaxZoomLevel() Returns the maximum zoom level available on the server side.
	getPopupMenu(popupMenu) Returns the specified contextual pop-up menu set on this view.
	getProject() Returns a chart designer project URL.
	getStateURL() Internal Implementation.
	getStyleSheet() Returns the style sheet (inline or URL).
	getStyleSheets() Returns the list of comma separated style sheets.
	getType() Returns the type of the chart, if set.
	getUpdateInterval() Returns the automatic update interval of the view.
	getVisibleWindow() Returns the visible window.
	getXVisibleRange() Returns the visible range along the x-axis.
	getXZoomFactor() Returns the factor used when calling the `zoomIn` and `zoomOut` methods on the x-axis.
	getYVisibleRange() Returns the visible range along the y-axis.
	getYZoomFactor() Returns the factor used when calling the `zoomIn` and `zoomOut` methods on the y-axis.
	IlvChartViewProxy. imageLoaded(chart) Internal implementation.
	isGenerateImageMap() Returns a Boolean indicating whether the component is generating an image map in addition to the image.
	isImageMapVisible() Returns the image map layer visibility.
	isResizable(resizable) Returns whether the managed view is resizable or not.
	performAction(actionName, params, udpateImage) Performs an action on the server side.
	performJSFAction(mb, params, udpateImage) Performs a predefined action that invokes the specified method binding.
	removeAdditionalParameter(name, updateImage) Removes an additional parameter previously added with the `setAdditionalParameters` method.
	removeCapabilitiesLoadListener(listener) Removes a listener installed with `addCapabilitiesLoadListener`.
	resetRange() Resets the visible range and data range.
	IlvChartViewProxy. restoreState(chart) Internal implementation.
	IlvChartViewProxy. saveState(chart) Internal implementation.
	setAccessible(accessible) Sets whether the managed view is accessible or not.
	setAdditionalParameters(name, value, updateImage) Installs an additional request parameter that will be added to all requests.
	setBackgroundColor(background, updateImage) Sets the background color of the generated image.
	setComponent(component, updateImage) Sets the component type to be displayed.
	setDataSourceId(dataSourceId, updateImage) Sets the identifier of the data source to be displayed by the chart.
	setErrorMessage(errMsg) Sets the message displayed when an error occurs while the image is loading.
	setGenerateImageMap(set, update) Instructs the component to generate an image map in addition to the image.
	setHotkeys(hotkeys) Sets the keyboard hotkeys for the view.
	setImageMapGenerator(imageMapGenerator) Sets the image map generator.
	setImageMapVisible(visible) Sets the image map layer visibility.
	setInteractor(interactor) Sets the current interactor on this view.
	setLegend(legend) Internal implementation.
	setOnCapabilitiesLoaded(evtListener) Sets the JavaScript code that will be executed when the capabilities are loaded.
	setOnImageLoaded(evtListener) Sets the JavaScript code that will be executed when the image is loaded.
	setOverview(overview) Internal implementation.
	setPopupMenu(popupMenu) Sets the specified contextual pop-up menu on this view.
	setProject(project, updateImage) The URL to a chart designer project.
	setResizable(resizable) Sets whether the managed view is resizable or not.
	setStateURL(state) Internal implementation.
	setStyleSheet(styleSheet, updateImage) Sets the cascading style sheets.
	setStyleSheets(styleSheets, updateImage) Sets the comma separated cascading style sheets.
	setType(type, updateImage) Sets the type of the chart to be displayed in this view.
	setUpdateInterval(rate) Changes the automatic update interval of the view.
	setVisibleWindow(xMin, xMax, yMin, yMax) Sets the visible window.
	setXVisibleRange(newMin, newMax) Sets the visible range along the x-axis and updates the image.
	setXZoomFactor(factor) Changes the factor used when calling the `zoomIn` and `zoomOut` methods on the x-axis.
	setYVisibleRange(newMin, newMax) Sets the visible range along the y-axis and updates the image.
	setYZoomFactor(factor) Changes the factor used when calling the `zoomIn` and `zoomOut` methods on the y-axis.
	startUpdateTimer() Starts the update timer that will query another image after a time interval.
	stopUpdateTimer() Stops the update timer.
	translateX(delta) Translates the chart area along the x-axis.
	translateY(delta) Translates the chart area along the y-axis.
	updateImage(updateCapabilities) Updates the chart image.
	zoomBy(xFactor, yFactor) Zooms the view to a specified factor by querying a new image from the server.
	zoomInX() Zooms the view along the x-axis by querying a new image from the server.
	zoomInY() Zooms the view in along the y-axis by querying a new image from the server.
	zoomOutX() Zooms the view out along the x-axis by querying a new image from the server.
	zoomOutY() Zooms the view out along the y-axis by querying a new image from the server.
	zoomToFit() Queries a new image showing all the data available from the the servlet that generates the image.

Methods inherited from class IlvBasicViewProxy
getImageFormat, getMessageBox, getServletClass, getServletURL, getWaitingImage, init, setImageFormat, setMessageBox, setServletClass, setServletURL, setWaitingImage

Methods inherited from class IlvSizedViewProxy
afterLayoutHandler, getAbsoluteBounds, getBounds, getCreationSize, getHeight, getMinimumSize, getWidth, positionAfterLayout, registerResizeListener, resizeAfterLayout, setMinimumSize

Methods inherited from class IlvFacesProxy
dispose, getAbsoluteId, getJViewsDHTMLObject, getNodeCoords, getObject, getReferenceNode, setAbsoluteId, setJViewsDHTMLObject, setObject, setPageIdSupport, setReferenceNode, toHTML

Methods inherited from class IlvPropertyStateManager
getClientId, notify

Methods inherited from class IlvObject
getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility

Constructor Detail

IlvChartViewProxy

IlvChartViewProxy(clientId, refNodeId, width, height, state)

Parameters:: clientId; refNodeId; width; height; state

Method Detail

addCapabilitiesLoadListener

addCapabilitiesLoadListener(listener)

Adds a listener to be called when the capabilities have been loaded.

Parameters:

listener - The listener function, which must have the following parameters:

  view: The IlvChartView.

addRequestParameters

addRequestParameters()

Internal implementation.

getBackgroundColor

getBackgroundColor()

Returns the background color of the generated image, if defined.

Returns:: The image background color.

getComponent

getComponent()

Returns the chart component to be displayed, if defined.

Returns:: The chart component to be displayed.

getDataSourceId

getDataSourceId()

Returns the identifier of the data source to be displayed, if defined.

Returns:: The data source identifier.

getDataWindow

getDataWindow()

Returns the visible window. This method returns an object with four properties: xMin, xMax, yMin, yMax. This value is valid only when the capabilities have been loaded.

getErrorMessage

getErrorMessage()

Returns the message displayed when an error occurs while the image is loading.

Returns:: The message displayed when an error occurs while the image is loading.

getImageMapGenerator

getImageMapGenerator()

Returns the image map generator. If the generateImageMap property is true,
this generator will be invoked to dynamically create the image map. The result could be a class name or a value binding expression.

Returns:: The image map generator.

getInteractor

getInteractor()

Returns the current interactor set on this view.

Returns:: The interactor set on this view.

getInteractorId

getInteractorId()

getLegend

getLegend()

Internal implementation.

getMaxZoomLevel

getMaxZoomLevel()

Returns the maximum zoom level available on the server side. The value is valid only when the capabilities of the server have been loaded.

getPopupMenu

getPopupMenu(popupMenu)

Returns the specified contextual pop-up menu set on this view.

Parameters:: popupMenu

Returns:: The contextual pop-up menu.

getProject

getProject()

Returns a chart designer project URL.

Returns:: The project.

getStateURL

getStateURL()

Internal Implementation. Returns a string that contains the encoded parameters of the managed view.

getStyleSheet

getStyleSheet()

Returns the style sheet (inline or URL).

Returns:: The style sheet.

getStyleSheets

getStyleSheets()

Returns the list of comma separated style sheets. The order is prioritized (the last CSS has the highest priority).

Returns:: The list of comma separated style sheets.

getType

getType()

Returns the type of the chart, if set.

Returns:: The type of the chart.

getUpdateInterval

getUpdateInterval()

Returns the automatic update interval of the view.

Returns:: The automatic update interval of the view.

getVisibleWindow

getVisibleWindow()

Returns the visible window. This method returns an object with four properties: xMin, xMax, yMin, yMax. This value is valid only when the capabilities have been loaded.

getXVisibleRange

getXVisibleRange()

Returns the visible range along the x-axis. This method returns an object with two properties: min, max. This value is valid only when the capabilities have been loaded.

getXZoomFactor

getXZoomFactor()

Returns the factor used when calling the zoomIn and zoomOut methods on the x-axis.

getYVisibleRange

getYVisibleRange()

Returns the visible range along the y-axis. This method returns an object with two properties: min, max. This value is valid only when the capabilities have been loaded.

getYZoomFactor

getYZoomFactor()

Returns the factor used when calling the zoomIn and zoomOut methods on the y-axis.

imageLoaded

<static> IlvChartViewProxy.imageLoaded(chart)

Internal implementation.

Parameters:: chart

isGenerateImageMap

isGenerateImageMap()

Returns a Boolean indicating whether the component is generating an image map in addition to the image.

isImageMapVisible

isImageMapVisible()

Returns the image map layer visibility.

Returns:: The visibility flag of the image map.

isResizable

isResizable(resizable)

Returns whether the managed view is resizable or not.

Parameters:: resizable - The resizable flag.

performAction

performAction(actionName, params, udpateImage)

Performs an action on the server side. This method requests a new image from the server. Optionally, new capabilities can also be requested from the server before the image is retrieved. Additional parameters are sent in the request so that an action can be performed on the server side before the capabilities and image are generated. This allows you to define a new type of interaction on the image. To implement the action on the server side, you must implement the IlvChartServerAction interface and register the action with an instance of IlvChartServletSupport. An action is defined by a name and a list of parameters.

Parameters:: actionName - The name of the action.; params - The parameters of the action as an array of strings.; udpateImage - true to update the capabilities and the image, false to update just the capabilities.

performJSFAction

performJSFAction(mb, params, udpateImage)

Performs a predefined action that invokes the specified method binding.

This action is executed before the image generation.
The signature of the method must be void methodName (IlvChart, String[]) where the first parameter is the IlvChart instance used to draw the chart and the second parameter is the array of action parameters. The action must only change the IlvChart instance as only the image is refreshed (the JSF components are not).

Parameters:: mb - The method binding to invoke.; params - The action parameters as a array of Strings.; udpateImage - true to update capabilities and the image, false to update just the capabilities.

Since:: JViews 8.0

removeAdditionalParameter

removeAdditionalParameter(name, updateImage)

Removes an additional parameter previously added with the setAdditionalParameters method.

Parameters:: name; updateImage

removeCapabilitiesLoadListener

removeCapabilitiesLoadListener(listener)

Removes a listener installed with addCapabilitiesLoadListener.

Parameters:: listener - The listener to remove.

resetRange

resetRange()

Resets the visible range and data range. The corresponding ranges will be updated only when the capabilities have been reloaded.

restoreState

<static> IlvChartViewProxy.restoreState(chart)

Internal implementation.

Parameters:: chart

saveState

<static> IlvChartViewProxy.saveState(chart)

Internal implementation.

Parameters:: chart

setAccessible

setAccessible(accessible)

Sets whether the managed view is accessible or not.

Parameters:: accessible - The accessible flag.

setAdditionalParameters

setAdditionalParameters(name, value, updateImage)

Installs an additional request parameter that will be added to all requests. You can remove it by calling the removeParameter method. Installed parameters will be appended as &key=value to all requests.

Parameters:: name - The key to set.; value - The value to set.; updateImage - Set whether to update image.

setBackgroundColor

setBackgroundColor(background, updateImage)

Sets the background color of the generated image.

Parameters:: background - The image background color to set.; updateImage - Flag to request a new image from the servlet that generates the image.

setComponent

setComponent(component, updateImage)

Sets the component type to be displayed. Acceptable values are 'chart' to display the entire chart or 'area' to display only the plot area of the chart.

Parameters:: component - The component type.; updateImage - true if the image is to be updated, false otherwise.

setDataSourceId

setDataSourceId(dataSourceId, updateImage)

Sets the identifier of the data source to be displayed by the chart.

Parameters:: dataSourceId - The data source identifier.; updateImage - Flag to request a new image from the servlet that generates the image.

setErrorMessage

setErrorMessage(errMsg)

Sets the message displayed when an error occurs while the image is loading.

Parameters:: errMsg

setGenerateImageMap

setGenerateImageMap(set, update)

Instructs the component to generate an image map in addition to the image.

Parameters:: set - Set whether to generate an image map.; update - Set whether to update image.

setHotkeys

setHotkeys(hotkeys)

Sets the keyboard hotkeys for the view.

Parameters:: hotkeys - The hotkeys to set.

setImageMapGenerator

setImageMapGenerator(imageMapGenerator)

Sets the image map generator. If the generateImageMap property is true,
this generator will be invoked to dynamically create the image map. The parameter could be a class name or a value binding expression.

Parameters:: imageMapGenerator - The imageMapGenerator to set.

setImageMapVisible

setImageMapVisible(visible)

Sets the image map layer visibility.

Parameters:: visible - The visibility flag of the image map.

setInteractor

setInteractor(interactor)

Sets the current interactor on this view.

Parameters:: interactor - The interactor to set on the view, or null to remove the current interactor.

setLegend

setLegend(legend)

Internal implementation.

Parameters:: legend

setOnCapabilitiesLoaded

setOnCapabilitiesLoaded(evtListener)

Sets the JavaScript code that will be executed when the capabilities are loaded.

Parameters:: evtListener

setOnImageLoaded

setOnImageLoaded(evtListener)

Sets the JavaScript code that will be executed when the image is loaded.

Parameters:: evtListener

setOverview

setOverview(overview)

Internal implementation.

Parameters:: overview

setPopupMenu

setPopupMenu(popupMenu)

Sets the specified contextual pop-up menu on this view.

Parameters:: popupMenu - The contextual pop-up menu.

setProject

setProject(project, updateImage)

The URL to a chart designer project.

Parameters:: project - The project to set.; updateImage

setResizable

setResizable(resizable)

Sets whether the managed view is resizable or not.

Parameters:: resizable - The resizable flag.

setStateURL

setStateURL(state)

Internal implementation. Sets the current view state of this view. This string will be processed to extract the parameters of the managed view.

Parameters:: state - The state string.

setStyleSheet

setStyleSheet(styleSheet, updateImage)

Sets the cascading style sheets. It can be a URL, a filename, or the style sheet string.

Parameters:: styleSheet - The style sheets.; updateImage - Flag to request a new image from the generating image servlet.

setStyleSheets

setStyleSheets(styleSheets, updateImage)

Sets the comma separated cascading style sheets. Each element can be a URL, a filename, or the style sheet string. The order is prioritized (the last CSS has the highest priority).

Parameters:: styleSheets - The list of comma separated style sheets.; updateImage - Flag to request a new image from the generating image servlet.

setType

setType(type, updateImage)

Sets the type of the chart to be displayed in this view. Valid values are 'Cartesian', 'radar', 'polar' and 'pie'. If the updateImage flag is set to true, a new image will be requested.

Note that this method will reinitialize the scales and the grids of the server side chart.

Parameters:: type - The new chart type.; updateImage - Flag to request a new image from the servlet that generates the image.

Deprecated:
Beginning with JViews 8.1 set the type in a style sheet and use the setStyleSheet(styleSheet, updateImage) method.

setUpdateInterval

setUpdateInterval(rate)

Changes the automatic update interval of the view.

Parameters:: rate - The new interval in seconds. An interval of zero stops the automatic update.

setVisibleWindow

setVisibleWindow(xMin, xMax, yMin, yMax)

Sets the visible window.

Parameters:: xMin - The minimum value along the x-axis.; xMax - The maximum value along the y-axis.; yMin - The minimum value along the x-axis.; yMax - The maximum value along the y-axis.

setXVisibleRange

setXVisibleRange(newMin, newMax)

Sets the visible range along the x-axis and updates the image.

Parameters:: newMin - The new minimum bound.; newMax - The new maximum bound.

setXZoomFactor

setXZoomFactor(factor)

Changes the factor used when calling the zoomIn and zoomOut methods on the x-axis. The default value is 2.

Parameters:: factor

setYVisibleRange

setYVisibleRange(newMin, newMax)

Sets the visible range along the y-axis and updates the image.

Parameters:: newMin - The new minimum bound.; newMax - The new maximum bound.

setYZoomFactor

setYZoomFactor(factor)

Changes the factor used when calling the zoomIn and zoomOut methods on the y-axis. The default value is 2.

Parameters:: factor

startUpdateTimer

startUpdateTimer()

Starts the update timer that will query another image after a time interval.

stopUpdateTimer

stopUpdateTimer()

Stops the update timer.

translateX

translateX(delta)

Translates the chart area along the x-axis.

Parameters:: delta - The delta to apply, expressed as a float value.

translateY

translateY(delta)

Translates the chart area along the y-axis.

Parameters:: delta - The delta to apply expressed as a float value.

updateImage

updateImage(updateCapabilities)

Updates the chart image.

Parameters:: updateCapabilities - Whether update the capabilities when the image is loaded or not.

zoomBy

zoomBy(xFactor, yFactor)

Zooms the view to a specified factor by querying a new image from the server.

Parameters:: xFactor - The zoom factor on the x-axis.; yFactor - The zoom factor on the y-axis.

zoomInX

zoomInX()

Zooms the view along the x-axis by querying a new image from the server. The zoom factor is defined by means of the setXZoomFactor() method.

zoomInY

zoomInY()

Zooms the view in along the y-axis by querying a new image from the server. The zoom factor is defined by means of the setYZoomFactor() method.

zoomOutX

zoomOutX()

Zooms the view out along the x-axis by querying a new image from the server.

zoomOutY

zoomOutY()

Zooms the view out along the y-axis by querying a new image from the server.

zoomToFit

zoomToFit()

Queries a new image showing all the data available from the the servlet that generates the image.