Api session event editor netcluster: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (14 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<noinclude lang="text" copy>API Endpoint: api/session/event/editornetcluster/ | |||
</noinclude><noinclude lang="text" copy> | |||
API Endpoints for [[Net Cluster]] editing. | API Endpoints for [[Net Cluster]] editing. | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor netcluster add|add]] | | [[Api session event editor netcluster add|add]] | ||
|Add new [[Net Cluster]] | | Add new [[Net Cluster]] | ||
|- | |- | ||
|[[Api session event editor netcluster remove|remove]] | | [[Api session event editor netcluster remove|remove]] | ||
|Remove existing [[Net Cluster]] | | Remove existing [[Net Cluster]] | ||
|- | |- | ||
|[[Api session event editor netcluster set name|set_name]] | | [[Api session event editor netcluster set name|set_name]] | ||
|Set | | Set the name of a [[Net Cluster]] | ||
|} | |} | ||
<noinclude lang="text" copy> | |||
Additional API Endpoints: | Additional API Endpoints: | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor netcluster add loads in area to net cluster|add_loads_in_area_to_net_cluster]] | | [[Api session event editor netcluster add loads in area to net cluster|add_loads_in_area_to_net_cluster]] | ||
|Add | | Add unclustered [[Net Load]]s to a [[Net Cluster]] given a [[MultiPolygon]] | ||
|- | |- | ||
|[[Api session event editor netcluster generate clusters|generate_clusters]] | | [[Api session event editor netcluster generate clusters|generate_clusters]] | ||
|Generate | | Generate [[Net Cluster]]s for a set of [[Net Type]]s, using a Clustering Type, a Region, allowed owners of [[Building]]s, cluster area size, default [[Stakeholder]] for created [[Net Cluster]]s. A default [[Stakeholder]] for [[Net Load]]s without an associated [[Building]]. A Cluster [[Attribute]] and optional specific value can be used to only include specific [[Net Load]]s. Optionally, [[Net Load]]s identified as Collective can be clustered separately | ||
|- | |- | ||
|[[Api session event editor netcluster remove all clusters|remove_all_clusters]] | | [[Api session event editor netcluster remove all clusters|remove_all_clusters]] | ||
|Remove | | Remove all [[Net Cluster]]s with [[Net Load]]s belonging only to a particular [[Net Type]] | ||
|- | |- | ||
|[[Api session event editor netcluster remove loads in area from net cluster|remove_loads_in_area_from_net_cluster]] | | [[Api session event editor netcluster remove loads in area from net cluster|remove_loads_in_area_from_net_cluster]] | ||
|Remove | | Remove [[Net Load]]s from a [[Net Cluster]] given a [[MultiPolygon]] | ||
|- | |- | ||
|[[Api session event editor netcluster remove network|remove_network]] | | [[Api session event editor netcluster remove network|remove_network]] | ||
|Remove Network | | Remove a Network of a particular [[Net Type]], with the option to keep the Root Load | ||
|- | |- | ||
|[[Api session event editor netcluster set fraction connected|set_fraction_connected]] | | [[Api session event editor netcluster set fraction connected|set_fraction_connected]] | ||
|Set | | Set the fraction with [[Net Load]]s of this Cluster that are set to connected | ||
|- | |- | ||
|[[Api session event editor netcluster set owner|set_owner]] | | [[Api session event editor netcluster set owner|set_owner]] | ||
|Set | | Set the owner of a [[Net Cluster]] | ||
|- | |- | ||
|[[Api session event editor netcluster set scenario|set_scenario]] | | [[Api session event editor netcluster set scenario|set_scenario]] | ||
|Set [[Scenario]] | | Set the [[Scenario]] in which this [[Net Cluster]] is active | ||
|} | |} | ||
{{article end|seealso=*[[Api | <noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]] | ||
*[[Api session items netclusters]] | |||
}} | }} | ||
</noinclude> | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 10:26, 13 November 2026
API Endpoint: api/session/event/editornetcluster/
API Endpoints for Net Cluster editing.
| Name | Description |
|---|---|
| add | Add new Net Cluster |
| remove | Remove existing Net Cluster |
| set_name | Set the name of a Net Cluster |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_loads_in_area_to_net_cluster | Add unclustered Net Loads to a Net Cluster given a MultiPolygon |
| generate_clusters | Generate Net Clusters for a set of Net Types, using a Clustering Type, a Region, allowed owners of Buildings, cluster area size, default Stakeholder for created Net Clusters. A default Stakeholder for Net Loads without an associated Building. A Cluster Attribute and optional specific value can be used to only include specific Net Loads. Optionally, Net Loads identified as Collective can be clustered separately |
| remove_all_clusters | Remove all Net Clusters with Net Loads belonging only to a particular Net Type |
| remove_loads_in_area_from_net_cluster | Remove Net Loads from a Net Cluster given a MultiPolygon |
| remove_network | Remove a Network of a particular Net Type, with the option to keep the Root Load |
| set_fraction_connected | Set the fraction with Net Loads of this Cluster that are set to connected |
| set_owner | Set the owner of a Net Cluster |
| set_scenario | Set the Scenario in which this Net Cluster is active |