Difference between revisions of "Spatial Manager™ for BricsCAD - FAQs: Application Programming Interface (API) ("Professional" edition only)"

Latest revision as of 05:25, 10 April 2022

The Application Programming Interface (API) is currently under development. Next you can find the available functionality:

Coordinate Systems (CRS)
- Transform the coordinates of a point: (spm_cstransformpoint '(x y z) SourceCRS# TargetCRS# [Tranformation#])
  - '(xyz) : Point source coordinates
  - SourceCRS# : Source CRS code
  - TargetCRS# : Target CRS code
  - Transformation# : Transformation code (Optional)
  - Sample : (spm_cstransformpoint '(-2.5548 43.2148 0) 4326 23030 1133)
- Get the current drawing CRS Code: (spm_csgetdrawingcrscode)
- Get the current drawing CRS Name: (spm_csgetdrawingcrsname)
- Assign a CRS to the drawing: (spm_cssetdrawingcrs CRS#)
  - CRS# : CRS Code
  - Sample : (spm_cssetdrawingcrs 23030)
Data management
- Attach a data table to the selected objects: (spm_fdattachtable "TableName")
  - TableName : Name of an existing Table
  - Sample : (spm_fdattachtable "Census")
- Set the value of a data field for the selected objects: (spm_fdsetfieldvalue "TableName" "FieldName" "Value")
  - TableName : Name of an existing Table
  - FieldName : Name of an existing Field in the above table
  - Value : Value for the above Field
  - Sample : (spm_fdsetfieldvalue "Census" "TRACK" "99")
- Get the value of a data field for the selected object: (spm_fdgetfieldvalue "TableName" "FieldName")
  - TableName : Name of an existing Table
  - FieldName : Name of an existing Field in the above table
  - Sample : (spm_fdgetfieldvalue "Census" "TRACK")

Notes:

To learn more about CRSs and Transformations details, please go to the Coordinate Systems and Transformation details page
To learn more about the CRS and Transformation codes, please go to the Coordinate Systems objects list page
To learn more about Data Tables, please go to the Data Structure Management page

@@ Line 19: / Line 19: @@
 ***''CRS# : CRS Code''
 ***''Sample : (spm_cssetdrawingcrs 23030)''
+*'''Data management'''
+**'''Attach a data table to the selected objects:''' (spm_fdattachtable "TableName")
+***''TableName : Name of an existing Table''
+***''Sample : (spm_fdattachtable "Census")''
+**'''Set the value of a data field for the selected objects:''' (spm_fdsetfieldvalue "TableName" "FieldName" "Value")
+***''TableName : Name of an existing Table''
+***''FieldName : Name of an existing Field in the above table''
+***''Value : Value for the above Field''
+***''Sample : (spm_fdsetfieldvalue "Census" "TRACK" "99")''
+**'''Get the value of a data field for the selected object:''' (spm_fdgetfieldvalue "TableName" "FieldName")
+***''TableName : Name of an existing Table''
+***''FieldName : Name of an existing Field in the above table''
+***''Sample : (spm_fdgetfieldvalue "Census" "TRACK")''
@@ Line 24: / Line 37: @@
 *''To learn more about CRSs and Transformations details, please go to the [[Coordinate Systems and Transformation details | Coordinate Systems and Transformation details]] page''
 *''To learn more about the CRS and Transformation codes, please go to the [[Coordinate_Systems_objects_list|Coordinate Systems objects list]] page''
+*''To learn more about Data Tables, please go to the [[Spatial_Manager™_for_BricsCAD_-_FAQs:_Data_Structure_Management_("Standard"_and_"Professional"_editions_only)|Data Structure Management]] page''