Wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

resources:tools-software:sigmastudiov2:usingsigmastudio:scripting:rotateshape [25 Jun 2020 07:33]
Krithika Manchale created
resources:tools-software:sigmastudiov2:usingsigmastudio:scripting:rotateshape [15 Nov 2021 09:53]
Nikhin Shetty
Line 3: Line 3:
 =====Rotate Shape===== =====Rotate Shape=====
  
-This action allows the user to rotate a specified shape on the parent canvas or schematic page according to the angle given. Return type is a success/​failure ​message ​in the form of list of strings. The function call takes in 3 arguments.+This action allows the user to rotate a specified shape on the parent canvas or schematic page according to the angle given. The function call takes in 3 arguments. Return type is a SSPResult which contains a IsSuccess flag for  ​success/​failure ​and Message ​in the form of list of strings.
  
 \\ \\
 ===API=== ===API===
 <​code>​ <​code>​
-list<​string> ​RotateShape(1: string shapeUid, ​2: Position newPosition, ​3: double newAngle)+SSPResult ​RotateShape(string shapeUid, Position newPosition,​ double newAngle)
 </​code>​ </​code>​
 \\ \\
 ===Arguments==== ===Arguments====
   - shapeUid- Uid of the plugin to be moved.   - shapeUid- Uid of the plugin to be moved.
-  - newPosition -Position in the form of (X,Y) coordinates of the canvas.+  - newPosition -Position in the form of (double ​X, double ​Y) coordinates of the canvas.
   - newAngle -Angle of rotation in degrees.   - newAngle -Angle of rotation in degrees.
 \\ \\
  
 ===Result=== ===Result===
-“Rotate Successful”.\\+SSPResult contains '​IsSuccess'​ flag and '​Message'​ information of the RotateShape action. 
 +  -IsSuccess is '​True'​ for successful shape rotation, else '​False'​. 
 +  -Message contains the Success/​Failure information in the form of list of string. 
 +\\
 \\ \\
-===Error==== 
-Error message sent out by the server application. 
  
  
resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/rotateshape.txt · Last modified: 15 Nov 2021 09:53 by Nikhin Shetty