Wiki

This version (15 Nov 2021 12:28) was approved by Nikhin Shetty.The Previously approved version (24 Jun 2020 12:23) is available.Diff

Click here to return back

Add Shape

This action allows the user to add a shape or plugin onto the canvas or schematic page specified.The function call takes in 3 arguments. This API returns the SSPResult type.

API

SSPResult AddShape(string parentUid, string shapeFullName, Position newPosition)              


Arguments

  1. parentUid - The Uid of the parent canvas/Schematic onto which the plugin must be added.
  2. shapeFullName - Full name of the plugin to be added, as obtained in the documentation provided by Analog Devices.
  3. newPosition - Position on the canvas page where the user wishes to add the plugin. Default values are chosen if not specified.


Result

SSPResult contains 'IsSuccess' flag and 'Message' information of the AddShape action.

  1. IsSuccess is 'True' if the add shape was successful, else 'False'.
  2. Message contains the Success/Failure information in the form of list of string.



resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/addshape.txt · Last modified: 15 Nov 2021 12:28 by Nikhin Shetty