Api session event editor netline: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/editornetline/ | <noinclude lang="text" copy>API Endpoint: api/session/event/editornetline/ | ||
</noinclude><noinclude lang="text" copy> | |||
API | API Endpoints for [[Net Line]] editing. | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
| Line 13: | Line 13: | ||
|- | |- | ||
| [[Api session event editor netline remove|remove]] | | [[Api session event editor netline remove|remove]] | ||
| Remove [[Net Line]] | | Remove existing [[Net Line]] | ||
|- | |- | ||
| [[Api session event editor netline remove attribute|remove_attribute]] | | [[Api session event editor netline remove attribute|remove_attribute]] | ||
| Line 19: | Line 19: | ||
|- | |- | ||
| [[Api session event editor netline set attribute|set_attribute]] | | [[Api session event editor netline set attribute|set_attribute]] | ||
| For each [[Net Line]], set a particular [[Attribute]] to a specified array of values, optionally providing its [[Source]] | | For each [[Net Line]], set a particular [[Attribute]] to a specified array of values, optionally providing its [[Source]] | ||
|- | |- | ||
| [[Api session event editor netline set attributes|set_attributes]] | | [[Api session event editor netline set attributes|set_attributes]] | ||
| Set multiple [[Net Line]] numeric [[Attribute]] values | | Set multiple [[Net Line]] numeric [[Attribute]] values | ||
|} | |} | ||
<noinclude lang="text" copy> | |||
Additional API | Additional API Endpoints: | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
| [[Api session event editor netline add for points|add_for_points]] | | [[Api session event editor netline add for points|add_for_points]] | ||
| Connect start and end [[ | | Connect start and end [[Point]]s with one or more [[Net Line]]s of a specified [[Net Function]]. [[Net Node]]s are created for both [[Point]]s. Optionally connect the [[Point]]s using the road system and specify the merge distance for existing [[Net Node]]s | ||
|- | |- | ||
| [[Api session event editor netline insert and add for points|insert_and_add_for_points]] | | [[Api session event editor netline insert and add for points|insert_and_add_for_points]] | ||
| Insert one [[ | | Insert one [[Point]] into the first [[Net Line]] and a second [[Point]] into the Second [[Net Line]]. Potentially connect these two [[Point]]s with a new [[Net Line]] with a specified [[Net Function]]. [[Net Node]]s are created for start and end [[Point]]. Optionally connect the two [[Net Node]]s using the road system. Also specify at what distance the new [[Net Node]]s are merged with existing [[Net Node]]s | ||
|- | |- | ||
| [[Api session event editor netline insert point|insert_point]] | | [[Api session event editor netline insert point|insert_point]] | ||
| Insert a new Node in an existing [[Net Line]], potentially splitting the [[Net Line]] into two parts. Also specify at what distance the new | | Insert a new [[Net Node]] in an existing [[Net Line]], potentially splitting the [[Net Line]] into two parts. Also specify at what distance the new [[Net Node]]s are merged with existing [[Net Node]]s | ||
|- | |- | ||
| [[Api session event editor netline move and insert|move_and_insert]] | | [[Api session event editor netline move and insert|move_and_insert]] | ||
| Place an existing Node at a new location and insert it in an existing [[Net Line]] | | Place an existing [[Net Node]] at a new location and insert it in an existing [[Net Line]]. Potentially split the [[Net Line]] into two parts. Also specify at what distance the new [[Net Node]]s are merged with existing Nodes | ||
|- | |- | ||
| [[Api session event editor netline remove all attributes|remove_all_attributes]] | | [[Api session event editor netline remove all attributes|remove_all_attributes]] | ||
| Line 46: | Line 46: | ||
|- | |- | ||
| [[Api session event editor netline remove repeated|remove_repeated]] | | [[Api session event editor netline remove repeated|remove_repeated]] | ||
| Remove | | Remove [[Net Line]]s and optionally remove connected [[Net Node]]s linked to only one other [[Net Line]] of the same [[Net Type]] | ||
|- | |- | ||
| [[Api session event editor netline set net function|set_net_function]] | | [[Api session event editor netline set net function|set_net_function]] | ||
| Set the [[Net Function]] for a [[Net Line]] | | Set the [[Net Function]] for a [[Net Line]] | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | <noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]] | ||
*[[Api session items netlines]] | *[[Api session items netlines]] | ||
}} | }} | ||
</noinclude> | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 10:26, 13 November 2026
API Endpoint: api/session/event/editornetline/
API Endpoints for Net Line editing.
| Name | Description |
|---|---|
| add | Add a Net Line with the provided Net Function |
| append_attribute | Appended to existing Net Line numeric Attribute value |
| remove | Remove existing Net Line |
| remove_attribute | Remove the specified Attributes for each specified Net Line |
| set_attribute | For each Net Line, set a particular Attribute to a specified array of values, optionally providing its Source |
| set_attributes | Set multiple Net Line numeric Attribute values |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_for_points | Connect start and end Points with one or more Net Lines of a specified Net Function. Net Nodes are created for both Points. Optionally connect the Points using the road system and specify the merge distance for existing Net Nodes |
| insert_and_add_for_points | Insert one Point into the first Net Line and a second Point into the Second Net Line. Potentially connect these two Points with a new Net Line with a specified Net Function. Net Nodes are created for start and end Point. Optionally connect the two Net Nodes using the road system. Also specify at what distance the new Net Nodes are merged with existing Net Nodes |
| insert_point | Insert a new Net Node in an existing Net Line, potentially splitting the Net Line into two parts. Also specify at what distance the new Net Nodes are merged with existing Net Nodes |
| move_and_insert | Place an existing Net Node at a new location and insert it in an existing Net Line. Potentially split the Net Line into two parts. Also specify at what distance the new Net Nodes are merged with existing Nodes |
| remove_all_attributes | Remove all Attributes for each specified Net Line |
| remove_repeated | Remove Net Lines and optionally remove connected Net Nodes linked to only one other Net Line of the same Net Type |
| set_net_function | Set the Net Function for a Net Line |