%%PageItemTitle%%

VectorDraw Web Library

previous page next page
JsPropertiesExtractor Send comments on this topic.
line Method
See Also  Example
vdWebLibrary Namespace > ScriptCommands Class : line Method
parameters
A array of parameters in the following order, used for no user action. 1.Start point as an array of 3 numbers(X,Y,Z) 2.End point as an array of 3 numbers(X,Y,Z)
callback
A user function of ScriptEntityDelegate type, that will be called when the command finish.It can be ignored.
Add a line to the document.

Syntax

JScript 
public function line( 
   parameters : Object[],
   callback : ScriptEntityDelegate
);

Parameters

parameters
A array of parameters in the following order, used for no user action. 1.Start point as an array of 3 numbers(X,Y,Z) 2.End point as an array of 3 numbers(X,Y,Z)
callback
A user function of ScriptEntityDelegate type, that will be called when the command finish.It can be ignored.

Example

C#Copy Code
vdrawobj.scriptCommand.line(); // begins a user action to draw a line
C#Copy Code
// draw a line using active color , linetype,layer etc properties, from 1,1 to 2,2 
//after this command is finished the object is not drawn on screen. 
//You can call the vdrawObj.redraw after adding an amount of commands 
vdrawobj.scriptCommand.line([[1,1,0],[2,2,0]]);  
setTimeout(vdrawObj.redraw);//post a redraw command
C#Copy Code
// draw a line using active color , linetype,layer etc properties, from 1,1 to 2,2 
//after this command is finished the object is not drawn on screen. 
//In order to display it call vdrawObj.DrawEntity and <see cref="M:vdWebLibrary.vdrawObj.Refresh"/>  inside the user define callback .See example. 
 
function actionentityadded(vdraw, entity) { 
   vdraw.DrawEntity(entity); 
   setTimeout(vdraw.Refresh);//post a refresh command 
            } 
vdcanvas.scriptCommand.line([[1, 1, 0], [2, 2, 0]], actionentityadded); 
vdcanvas.scriptCommand.line([[1, 1, 0], [3, 1, 0]], actionentityadded);  

Remarks

if passed parameters not exist or it is null then start a new user action and prompts the user to draw a line. If parameters are not null then a new line is added synchronously depend on the passed parameters. The command add the action to undo history and also to script lines getCommands If parameters are not null and after this command is finished the object is not drawn on screen In order to display it call DrawEntity and Refresh inside the user define callback .See example.

See Also

previous page start next page