Skip to main content
Index Overview
PREV CLASS NEXT CLASS FRAMES NO FRAMES
 

Class IlvChartZoomInteractor 

IlvObject
   |
   +--IlvInteractor
      |
      +--IlvChartZoomInteractor
Category:
Charts component
JavaScript File:
IlvChartZoomInteractor.js
Description:
An interactor to zoom in and out the visible range of an IlvChart DHTML component.
Constructor Summary
Constructor Attributes Constructor Name and Description
 
IlvChartZoomInteractor(actionName)
Method Summary
Method Attributes Method Name and Description
 
addRectangleDraggedListener(listener)
Adds a listener that is called every time a rectangle was dragged.
 
getColor()
Returns the color of the dragged rectangle.
 
getLineWidth()
Returns the line width of the dragged rectangle.
 
getRectangle()
Returns the bounds of the dragged rectangle.
 
isXZoomAllowed()
Returns whether a zoom along the x-axis is allowed.
 
isYZoomAllowed()
Returns whether a zoom along the y-axis is allowed.
 
keyPress(e)
Handles key up events.
 
mouseDown(e)
Handles the 'down' events of the mouse.
 
mouseDrag(e)
Handles the 'move' events of the mouse.
 
mouseUp(e)
Handles the 'up' events of the mouse.
 
removeRectangleDraggedListener(listener)
Removes a listener installed with addRectangleDraggedListener.
 
setColor(color)
Sets the color of the dragged rectangle.
 
setLineWidth(lineWidth)
Sets the line width of the dragged rectangle.
 
setXZoomAllowed(allowed)
Sets whether a zoom along the x-axis is allowed.
 
setYZoomAllowed(allowed)
Sets whether a zoom along the y-axis is allowed.
 
startDragging(e)
Starts the drag.
 
stopDragging(e)
Ends the drag.
 
whileDragging(e)
When dragging.
Methods inherited from class IlvInteractor
getCursor, getMenuModelId, getMessage, getView, setCursor, setMenuModelId, setMessage, setView
Methods inherited from class IlvObject
dispose, getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility
Constructor Detail
IlvChartZoomInteractor
IlvChartZoomInteractor(actionName)
Parameters:
actionName - The name of the associated server action.
Method Detail
addRectangleDraggedListener
addRectangleDraggedListener(listener)
Adds a listener that is called every time a rectangle was dragged. The listener object should be a function with one parameter: event. The event parameter contains six attributes: left, top, width, and height that describe the dragged rectangle in the view coordinate system. The fifth parameter is corner, which is the index of the corner where the rectangle was started (0 for top-left, 1 for bottom-left, 2 for bottom-right, and 3 for top-right). The last parameter is mouseEvent, which contains the mouse event that generated the end drag.
Parameters:
listener - The listener to set.
getColor
getColor()
Returns the color of the dragged rectangle.
getLineWidth
getLineWidth()
Returns the line width of the dragged rectangle.
getRectangle
getRectangle()
Returns the bounds of the dragged rectangle.
Returns:
An object with four properties: left, top, width, and height. These properties represent the bounds of the dragged rectangle expressed in the coordinates of the browser window.
isXZoomAllowed
isXZoomAllowed()
Returns whether a zoom along the x-axis is allowed.
isYZoomAllowed
isYZoomAllowed()
Returns whether a zoom along the y-axis is allowed.
keyPress
keyPress(e)
Handles key up events.
Parameters:
e - The mouse event.
mouseDown
mouseDown(e)
Handles the 'down' events of the mouse.
Parameters:
e - The mouse event.
mouseDrag
mouseDrag(e)
Handles the 'move' events of the mouse.
Parameters:
e - The mouse event.
mouseUp
mouseUp(e)
Handles the 'up' events of the mouse.
Parameters:
e - The mouse event.
removeRectangleDraggedListener
removeRectangleDraggedListener(listener)
Removes a listener installed with addRectangleDraggedListener.
Parameters:
listener - The listener to remove.
setColor
setColor(color)
Sets the color of the dragged rectangle.
Parameters:
color - The new color.
setLineWidth
setLineWidth(lineWidth)
Sets the line width of the dragged rectangle.
Parameters:
lineWidth - The line width to set.
setXZoomAllowed
setXZoomAllowed(allowed)
Sets whether a zoom along the x-axis is allowed.
Parameters:
allowed - Set whether a zoom along the x-axis is allowed
setYZoomAllowed
setYZoomAllowed(allowed)
Sets whether a zoom along the y-axis is allowed.
Parameters:
allowed - Set whether a zoom along the y-axis is allowed.
startDragging
startDragging(e)
Starts the drag.
Parameters:
e - The mouse event.
stopDragging
stopDragging(e)
Ends the drag.
Parameters:
e - The mouse event.
whileDragging
whileDragging(e)
When dragging.
Parameters:
e - The mouse event.
©Copyright 2024 Rogue Wave Software, Inc., a Perforce company.. All Rights Reserved.