Api session event editor area: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
|- | |- | ||
| [[Api session event editor area add|add]] | | [[Api session event editor area add|add]] | ||
| Add | | Add one or more [[Area]]s | ||
|- | |- | ||
| [[Api session event editor area add polygons|add_polygons]] | | [[Api session event editor area add polygons|add_polygons]] | ||
| Line 55: | Line 55: | ||
|- | |- | ||
| [[Api session event editor area add group|add_group]] | | [[Api session event editor area add group|add_group]] | ||
| Add | | Add a group [[Attribute]] for [[Area]]s | ||
|- | |- | ||
| [[Api session event editor area add relation|add_relation]] | | [[Api session event editor area add relation|add_relation]] | ||
| Line 61: | Line 61: | ||
|- | |- | ||
| [[Api session event editor area add with attribute|add_with_attribute]] | | [[Api session event editor area add with attribute|add_with_attribute]] | ||
| Add | | Add an [[Area]] with the provided [[Attribute]] and value | ||
|- | |- | ||
| [[Api session event editor area generate border areas|generate_border_areas]] | | [[Api session event editor area generate border areas|generate_border_areas]] | ||
| Generate Border [[Area]]s | | Generate new [[Area]]s with a specified Border [[Attribute]] and a particular width, at borders of nearby [[Area]]s, identified by a Filter [[Attribute]] | ||
|- | |- | ||
| [[Api session event editor area generate inundation areas|generate_inundation_areas]] | | [[Api session event editor area generate inundation areas|generate_inundation_areas]] | ||
| Generate Inundation [[Area]]s | | Generate Water Inundation [[Area]](s) with the Inundation Level [[Attribute]] set to the provided value | ||
|- | |- | ||
| [[Api session event editor area generate sewer areas|generate_sewer_areas]] | | [[Api session event editor area generate sewer areas|generate_sewer_areas]] | ||
| Generate Sewer [[Area]]s for [[Neighborhood]]s | | Generate Sewer [[Area]]s for [[Neighborhood]]s, with a Sewer Storage depending on the [[Neighborhood]]'s degree of Urbanization. A Sewer Overflow is generated for an overlapping Water Level [[Area]] identified by the provided Water Level [[Attribute]] | ||
|- | |- | ||
| [[Api session event editor area generate water areas|generate_water_areas]] | | [[Api session event editor area generate water areas|generate_water_areas]] | ||
| Generate Water [[Area]]s | | Generate Water Level [[Area]](s) with the Water Level [[Attribute]] set to the provided value | ||
|- | |- | ||
| [[Api session event editor area remove all attributes|remove_all_attributes]] | | [[Api session event editor area remove all attributes|remove_all_attributes]] | ||
| Remove | | Remove all [[Attribute]]s of an [[Area]] | ||
|- | |- | ||
| [[Api session event editor area remove group|remove_group]] | | [[Api session event editor area remove group|remove_group]] | ||
| Remove | | Remove the provided group [[Attribute]]s | ||
|- | |- | ||
| [[Api session event editor area remove relations|remove_relations]] | | [[Api session event editor area remove relations|remove_relations]] | ||
| Remove [[Relation]]s | | Remove [[Relation]]s from an [[Area]] | ||
|- | |- | ||
| [[Api session event editor area set relation|set_relation]] | | [[Api session event editor area set relation|set_relation]] | ||
| Set [[Relation]] | | Set an [[Area]] [[Relation]] to an [[Item]] ID | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | {{article end|seealso=*[[Api Session Endpoints]] | ||
Revision as of 15:29, 10 November 2026
API Endpoint: api/session/event/editorarea/
API Endpoints for Area editing.
| Name | Description |
|---|---|
| add | Add one or more Areas |
| add_polygons | Add Polygons to existing Area |
| append_attribute | Appended to existing Area numeric Attribute value |
| duplicate | Duplicate existing Area |
| import | Import Area Collection |
| remove | Remove existing Area |
| remove_attribute | Remove numeric Attribute from Area |
| remove_polygons | Remove Polygons from existing Area |
| set_active | Set Area active |
| set_attribute | Set Area numeric Attribute value |
| set_attributes | Set multiple Area numeric Attribute values |
| set_color | Set new color of existing Area |
| set_name | Set new name of existing Area |
| set_polygons | Set Polygons to existing Area |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_group | Add a group Attribute for Areas |
| add_relation | Add Relation |
| add_with_attribute | Add an Area with the provided Attribute and value |
| generate_border_areas | Generate new Areas with a specified Border Attribute and a particular width, at borders of nearby Areas, identified by a Filter Attribute |
| generate_inundation_areas | Generate Water Inundation Area(s) with the Inundation Level Attribute set to the provided value |
| generate_sewer_areas | Generate Sewer Areas for Neighborhoods, with a Sewer Storage depending on the Neighborhood's degree of Urbanization. A Sewer Overflow is generated for an overlapping Water Level Area identified by the provided Water Level Attribute |
| generate_water_areas | Generate Water Level Area(s) with the Water Level Attribute set to the provided value |
| remove_all_attributes | Remove all Attributes of an Area |
| remove_group | Remove the provided group Attributes |
| remove_relations | Remove Relations from an Area |
| set_relation | Set an Area Relation to an Item ID |