Api session event editor netline: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor netline add|add]] | | [[Api session event editor netline add|add]] | ||
|Add a [[Net Line]] with the provided [[Net Function]] | | Add a [[Net Line]] with the provided [[Net Function]] | ||
|- | |- | ||
|[[Api session event editor netline append attribute|append_attribute]] | | [[Api session event editor netline append attribute|append_attribute]] | ||
|Appended to existing [[Net Line]] [[Attribute]] value | | Appended to existing [[Net Line]] numeric [[Attribute]] value | ||
|- | |- | ||
|[[Api session event editor netline remove|remove]] | | [[Api session event editor netline remove|remove]] | ||
|Remove [[Net Line]]s | | Remove [[Net Line]]s | ||
|- | |- | ||
|[[Api session event editor netline remove attribute|remove_attribute]] | | [[Api session event editor netline remove attribute|remove_attribute]] | ||
|Remove the specified [[Attribute]]s for each specified [[Net Line]] | | Remove the specified [[Attribute]]s for each specified [[Net Line]] | ||
|- | |- | ||
|[[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]] [[Attribute]] values | | Set multiple [[Net Line]] numeric [[Attribute]] values | ||
|} | |} | ||
| Line 30: | Line 30: | ||
!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]] with one (or more) [[Net Line]](s) of a specified [[Net Function]]. Nodes are created for start and end [[Point]]. Optionally connection the two [[Point]]s using the road system. Also specify at what distance the new Nodes are merged with existing Nodes. | ||
|- | |- | ||
|[[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]] and potentially connect these two [[Point]]s with a new [[Net Line]] with a specified [[Net Function]]. Nodes are created for start and end [[Point]]. Optionally connection the two [[Point]]s using the road system. Also specify at what distance the new Nodes are merged with existing Nodes. | ||
|- | |- | ||
|[[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 Nodes are merged with existing Nodes. | | Insert a new Node in an existing [[Net Line]], potentially splitting the [[Net Line]] into two parts. Also specify at what distance the new Nodes are merged with existing Nodes. | ||
|- | |- | ||
|[[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]], potentially splitting the [[Net Line]] into two parts. Also specify at what distance the new Nodes are merged with existing Nodes. | | Place an existing Node at a new location and insert it in an existing [[Net Line]], potentially splitting the [[Net Line]] into two parts. Also specify at what distance the new Nodes 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]] | ||
|Remove all [[Attribute]]s for each specified [[Net Line]] | | Remove all [[Attribute]]s for each specified [[Net Line]] | ||
|- | |- | ||
|[[Api session event editor netline remove repeated|remove_repeated]] | | [[Api session event editor netline remove repeated|remove_repeated]] | ||
|Remove the [[Net Line]]s, and optionally continue removing for [[Net Node]]s that are connected the removed [[Net Line]] and that are only connected to one other [[Net Line]] of the same [[Net Type]] of the specified [[Net Line]]. | | Remove the [[Net Line]]s, and optionally continue removing for [[Net Node]]s that are connected the removed [[Net Line]] and that are only connected to one other [[Net Line]] of the same [[Net Type]] of the specified [[Net Line]]. | ||
|- | |- | ||
|[[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]] | {{article end|seealso=*[[Api Session Endpoints]] | ||
Latest revision as of 13:01, 19 June 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 Net Lines |
| 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 Point with one (or more) Net Line(s) of a specified Net Function. Nodes are created for start and end Point. Optionally connection the two Points using the road system. Also specify at what distance the new Nodes are merged with existing Nodes. |
| insert_and_add_for_points | Insert one Point into the first Net Line and a second Point into the Second Net Line and potentially connect these two Points with a new Net Line with a specified Net Function. Nodes are created for start and end Point. Optionally connection the two Points using the road system. Also specify at what distance the new Nodes are merged with existing Nodes. |
| 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 Nodes are merged with existing Nodes. |
| move_and_insert | Place an existing Node at a new location and insert it in an existing Net Line, potentially splitting the Net Line into two parts. Also specify at what distance the new Nodes are merged with existing Nodes. |
| remove_all_attributes | Remove all Attributes for each specified Net Line |
| remove_repeated | Remove the Net Lines, and optionally continue removing for Net Nodes that are connected the removed Net Line and that are only connected to one other Net Line of the same Net Type of the specified Net Line. |
| set_net_function | Set the Net Function for a Net Line |