Api session event editor parametric: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (19 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<noinclude lang="text" copy>API Endpoint: api/session/event/editorparametric/ | |||
</noinclude><noinclude lang="text" copy> | |||
Parametric editing. | API Endpoints for Parametric editing. | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric add|add]] | ||
|Add | | Add a [[Parametric Design]] of a particular Alignment | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric append attribute|append_attribute]] | ||
|Appended to existing Parametric | | Appended to existing Parametric numeric [[Attribute]] value | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric duplicate|duplicate]] | ||
|Duplicate existing Parametric | | Duplicate existing Parametric | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric remove|remove]] | ||
|Remove existing Parametric | | Remove existing Parametric | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric remove attribute|remove_attribute]] | ||
|Remove | | Remove numeric [[Attribute]] from Parametric | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric set attribute|set_attribute]] | ||
|Set Parametric | | Set Parametric numeric [[Attribute]] value | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric set attributes|set_attributes]] | ||
|Set multiple Parametric | | Set multiple Parametric numeric [[Attribute]] values | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric set name|set_name]] | ||
|Set | | Set the name of a [[Parametric Design]] | ||
|- | |||
| [[Api session event editor parametric set polygons|set_polygons]] | |||
| Set [[Polygon]]s to existing Parametric | |||
|} | |} | ||
<noinclude lang="text" copy> | |||
Additional API Endpoints: | |||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric add example|add_example]] | ||
| Add a [[Parametric Design]] using a particular example | |||
|Add [[ | |||
|- | |- | ||
|[[ | | [[Api session event editor parametric add plot|add_plot]] | ||
| | | Add a [[Plot Design]] of a particular [[Function]] to a [[Parametric Design]] | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric apply|apply]] | ||
| | | Apply a [[Parametric Design]] for a [[Stakeholder]], [[Function]] Types, [[Function]] IDs and one or more [[MultiPolygon]]s per [[Function]] Type | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric generate|generate]] | ||
| | | Generate a result for a [[Parametric Design]] | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric remove plot|remove_plot]] | ||
|Remove [[Plot]] | | Remove a [[Plot Design]] of a [[Parametric Design]] | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric remove plot attributes|remove_plot_attributes]] | ||
| | | Remove [[Attribute]]s from a [[Plot Design]] of a [[Parametric Design]] | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric save as measure|save_as_measure]] | ||
| | | Save a [[Parametric Design]] as a new [[Measure]] for a [[Stakeholder]], using [[Function]] Types, [[Function]] IDs and one or more [[MultiPolygon]]s per [[Function]] Type | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric set alignment|set_alignment]] | ||
|Set [[ | | Set the alignment of a [[Parametric Design]] | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric set function|set_function]] | ||
|Set [[ | | Set a [[Function]] of a [[Function]] Type for a [[Parametric Design]]. Use [[Function]] ID -1 to remove it for a [[Function]] Type | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric set plot attributes|set_plot_attributes]] | ||
|Set [[Plot]] [[ | | Set [[Attribute]]s of a [[Plot Design]] of a [[Parametric Design]] | ||
|- | |- | ||
|[[ | | [[Api session event editor parametric set plot function|set_plot_function]] | ||
|Set | | Set the [[Function]] of a [[Plot Design]] of a [[Parametric Design]] | ||
|} | |} | ||
{{article end|seealso=*[[Api | <noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]] | ||
*[[ | *[[Api session items parametricdesigns]] | ||
}} | }} | ||
</noinclude> | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 10:27, 13 November 2026
API Endpoint: api/session/event/editorparametric/
API Endpoints for Parametric editing.
| Name | Description |
|---|---|
| add | Add a Parametric Design of a particular Alignment |
| append_attribute | Appended to existing Parametric numeric Attribute value |
| duplicate | Duplicate existing Parametric |
| remove | Remove existing Parametric |
| remove_attribute | Remove numeric Attribute from Parametric |
| set_attribute | Set Parametric numeric Attribute value |
| set_attributes | Set multiple Parametric numeric Attribute values |
| set_name | Set the name of a Parametric Design |
| set_polygons | Set Polygons to existing Parametric |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_example | Add a Parametric Design using a particular example |
| add_plot | Add a Plot Design of a particular Function to a Parametric Design |
| apply | Apply a Parametric Design for a Stakeholder, Function Types, Function IDs and one or more MultiPolygons per Function Type |
| generate | Generate a result for a Parametric Design |
| remove_plot | Remove a Plot Design of a Parametric Design |
| remove_plot_attributes | Remove Attributes from a Plot Design of a Parametric Design |
| save_as_measure | Save a Parametric Design as a new Measure for a Stakeholder, using Function Types, Function IDs and one or more MultiPolygons per Function Type |
| set_alignment | Set the alignment of a Parametric Design |
| set_function | Set a Function of a Function Type for a Parametric Design. Use Function ID -1 to remove it for a Function Type |
| set_plot_attributes | Set Attributes of a Plot Design of a Parametric Design |
| set_plot_function | Set the Function of a Plot Design of a Parametric Design |