Wiki

This version is outdated by a newer approved version.DiffThis version (25 Jun 2020 07:15) is a draft.
Approvals: 0/1

This is an old revision of the document!


Click here to return back

Remove Shape

This action allows the user to remove/delete a given element or plugin from the parent canvas or schematic page specified. Return type is a success/failure message in the form of list of strings. The function call takes in 2 arguments.


API

list<string> RemoveShape(1: string parentUid, 2: string shapeUid)


Arguments

  1. parentUid - The Uid of the parent canvas/Schematic onto which the plugin must be added
  2. shapeUid- Uid of the plugin to be removed.


Result

“Successfully removed the element: <shapeUid>”.
Also, when adding a plugin which has predefined sub elements, the Uids of those are also displayed.

Error

1. The given information is incomplete/shape not found – when the arguments are not conveying the required information
2. Failed to remove element
3. Default: Displays the error msg as obtained by the Server application.

resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/removeshape.1593062143.txt.gz · Last modified: 25 Jun 2020 07:15 by Krithika Manchale