Clip Script Reference

Main Page | Script Demos | Test Page

Clipping Methods
setClip(top,right,bottom,left)
The setClip() method clips the sides of a layer.
The parameters can be integers or set to null for clipping less then 4 sides
Returns the calling layer.

clipTop() clipRight() clipBottom() clipLeft() These methods return the clip value of the individual edges.
clipWidth()
clipHeight()
Returns the visible area of a clipped layer.
scrollTo(x,y) Sets the scroll position of a layer.
This is done by moving and clipping the layer at the same time.
x and y specify the pixel values.
Returns the calling layer.

scrollBy(x,y) Scrolls a layer relative to it's last scroll position.
x and y specify how many pixels to scroll.
Returns the calling layer.

clipTo(top,right,bottom,left,speed,"action")
The clipTo() method is used to dynamically clip a layer.
top,right,bottom and left specify where the clipping should end.
speed sets the speed of the clipping action.
This can be a number or a string of numbers separated by commas.
A lone number would set the speed for all four clip edges.
A string would be four numbers,each setting the speed of one clip edge.
action specifies the action to be taken .
If "run"(the default) is used,the clip path is created and is run automatically .
If "defer" is used,the clip path is created but is not run automatically.
If "add" is used,the segment is added to the end of the existing clip path.
Any of the parameters can be set to null and bypassed.
This allows the possibility of clipping less then all 4 sides.
Returns the calling layer.

runClip() Runs the clip path created by the clipTo() method.
Returns the calling layer.

reverseClip("defer") Reverses the clip path created by the clipTo() method.
The clip path is also run if the parameter is not used.
Returns the calling layer.

stopClip(next function) Stops the layer from proceeding along it's clip path.
next function is a boolean value,if true,calls the layer's onclipend event handler.
Returns the calling layer.

Clipping Properties
layerObject.onclipend.....event handler which fires when a layer completes a clip path.
layerObject.clipReversed.....returns true if a layer's clip path has been reversed.
layerObject.hasClipPath.....returns true if a layer has a clip path assigned to it.
layerObject.clipRunning.....returns true if a layer is currently beening clipped.
layerObject.clipIntervalSpeed.....sets/returns the interval speed of the clipping action.
lastClipLayer......varible set to the last layer which has been clipped.

Clipping Methods
setClip(top,right,bottom,left)	The setClip() method clips the sides of a layer. The parameters can be integers or set to null for clipping less then 4 sides Returns the calling layer.
clipTop() clipRight() clipBottom() clipLeft()	These methods return the clip value of the individual edges.
clipWidth() clipHeight()	Returns the visible area of a clipped layer.
scrollTo(x,y)	Sets the scroll position of a layer. This is done by moving and clipping the layer at the same time. x and y specify the pixel values. Returns the calling layer.
scrollBy(x,y)	Scrolls a layer relative to it's last scroll position. x and y specify how many pixels to scroll. Returns the calling layer.
clipTo(top,right,bottom,left,speed,"action") The clipTo() method is used to dynamically clip a layer. top,right,bottom and left specify where the clipping should end. speed sets the speed of the clipping action. This can be a number or a string of numbers separated by commas. A lone number would set the speed for all four clip edges. A string would be four numbers,each setting the speed of one clip edge. action specifies the action to be taken . If "run"(the default) is used,the clip path is created and is run automatically . If "defer" is used,the clip path is created but is not run automatically. If "add" is used,the segment is added to the end of the existing clip path. Any of the parameters can be set to null and bypassed. This allows the possibility of clipping less then all 4 sides. Returns the calling layer.
runClip()	Runs the clip path created by the clipTo() method. Returns the calling layer.
reverseClip("defer")	Reverses the clip path created by the clipTo() method. The clip path is also run if the parameter is not used. Returns the calling layer.
stopClip(next function)	Stops the layer from proceeding along it's clip path. next function is a boolean value,if true,calls the layer's onclipend event handler. Returns the calling layer.
Clipping Properties
layerObject.onclipend.....event handler which fires when a layer completes a clip path. layerObject.clipReversed.....returns true if a layer's clip path has been reversed. layerObject.hasClipPath.....returns true if a layer has a clip path assigned to it. layerObject.clipRunning.....returns true if a layer is currently beening clipped. layerObject.clipIntervalSpeed.....sets/returns the interval speed of the clipping action. lastClipLayer......varible set to the last layer which has been clipped.