Api session event editor netline: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session event editor netline Endpoints.
API Endpoint: api/session/event/editornetline/


API Endpoints for [[Net Line]] editing.
API endpoints for [[Net Line]] editing.
{|class=wikitable
{|class=wikitable
!Name
!Name
!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]]
| 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 attributes 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
|}
|}


Additional API Endpoints:
Additional API endpoints:
{|class=wikitable
{|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 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.
| Connect start and end [[Point]]s with one or more [[Net Line]]s of a specified [[Net Function]]. Nodes are created for both [[Point]]s. Optionally connect the [[Point]]s using the road system and specify the merge distance for 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 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 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 attributes 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]], and optionally continue removing for [[Net Node]] 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 [[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 Events]]
{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items netlines]]
*[[Api session items netlines]]
}}
}}


[[Category:API]]
[[Category:API]]

Latest revision as of 09:59, 13 July 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 Points with one or more Net Lines of a specified Net Function. Nodes are created for both Points. Optionally connect the Points using the road system and specify the merge distance for 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 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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_netline&oldid=90829"