This version is outdated by a newer approved version.
This version (10 Feb 2021 11:47) was approved by Krithika Manchale.
This version (10 Feb 2021 11:47) was approved by Krithika Manchale.This is an old revision of the document!
Add Shape
This action allows the user to add a given element or plugin onto the canvas or schematic page specified. Return type is a success/failure message in the form of list of strings. The function call takes in 3 arguments.
API
list<string> AddShape(1: string parentUid, 2: string shapeFullName, 3: Position newPosition)
Arguments
- parentUid - The Uid of the parent canvas/Schematic onto which the plugin must be added.
- shapeFullName - Full name of the plugin to be added, as obtained in the documentation provided by Analog Devices.
- newPosition - Position on the canvas page where the user wishes to add the plugin. Default values are chosen if not specified.
Result
“Successfully added the element: <pluginUid>”.
Also, when adding a plugin which has predefined sub elements, the Uids of those are also displayed.
Error
1. The given information is incomplete – when the arguments are not conveying the required information
2. Failed to add element
3. Default: Displays the error msg as obtained by the Server application.
resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/addshape.1592994211.txt.gz · Last modified: 24 Jun 2020 12:23 by Krithika Manchale