Api session event editor area: 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
51,321 edits
No edit summary
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session event editor area Endpoints.
<noinclude lang="text" copy>API Endpoint: api/session/event/editorarea/
 
</noinclude><noinclude lang="text" copy>
API endpoints for [[Area]] editing.
API Endpoints for [[Area]] editing.
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor area add|add]]
| [[Api session event editor area add|add]]
|Add new [[Area]]
| Add one or more [[Area]]s
|-
|-
|[[Api session event editor area add polygons|add_polygons]]
| [[Api session event editor area add polygons|add_polygons]]
|Add [[#Api Model Polygon|Polygon]]s to existing [[Area]]
| Add [[Polygon]]s to existing [[Area]]
|-
|-
|[[Api session event editor area append attribute|append_attribute]]
| [[Api session event editor area append attribute|append_attribute]]
|Appended to existing [[Area]] [[Attribute]] value
| Appended to existing [[Area]] numeric [[Attribute]] value
|-
|-
|[[Api session event editor area duplicate|duplicate]]
| [[Api session event editor area duplicate|duplicate]]
|Duplicate existing [[Area]]
| Duplicate existing [[Area]]
|-
|-
|[[Api session event editor area import|import]]
| [[Api session event editor area import|import]]
|Import [[Area]] Collection
| Import [[Area]] Collection
|-
|-
|[[Api session event editor area remove|remove]]
| [[Api session event editor area remove|remove]]
|Remove existing [[Area]]
| Remove existing [[Area]]
|-
|-
|[[Api session event editor area remove attribute|remove_attribute]]
| [[Api session event editor area remove attribute|remove_attribute]]
|Remove [[Attribute]] from [[Area]]
| Remove numeric [[Attribute]] from [[Area]]
|-
|-
|[[Api session event editor area remove polygons|remove_polygons]]
| [[Api session event editor area remove polygons|remove_polygons]]
|Remove [[#Api Model Polygon|Polygon]]s from existing [[Area]]
| Remove [[Polygon]]s from existing [[Area]]
|-
|-
|[[Api session event editor area set active|set_active]]
| [[Api session event editor area set active|set_active]]
|Set [[Area]] active
| Set [[Area]] active
|-
|-
|[[Api session event editor area set attribute|set_attribute]]
| [[Api session event editor area set attribute|set_attribute]]
|Set [[Area]] [[Attribute]] value
| Set [[Area]] numeric [[Attribute]] value
|-
|-
|[[Api session event editor area set attributes|set_attributes]]
| [[Api session event editor area set attributes|set_attributes]]
|Set multiple [[Area]] [[Attribute]] values
| Set multiple [[Area]] numeric [[Attribute]] values
|-
|-
|[[Api session event editor area set color|set_color]]
| [[Api session event editor area set color|set_color]]
|Set new color of existing [[Area]]
| Set new color of existing [[Area]]
|-
|-
|[[Api session event editor area set name|set_name]]
| [[Api session event editor area set name|set_name]]
|Set new name of existing [[Area]]
| Set new name of existing [[Area]]
|-
|-
|[[Api session event editor area set polygons|set_polygons]]
| [[Api session event editor area set polygons|set_polygons]]
|Set [[#Api Model Polygon|Polygon]]s to existing [[Area]]
| Set [[Polygon]]s to existing [[Area]]
|}
|}
 
<noinclude lang="text" copy>
Additional API endpoints:
Additional API Endpoints:
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor area add group|add_group]]
| [[Api session event editor area add group|add_group]]
|Add Group
| 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]]
|Add [[Relation]]
| Add [[Relation]]
|-
|-
|[[Api session event editor area add with attribute|add_with_attribute]]
| [[Api session event editor area add with attribute|add_with_attribute]]
|Add With [[Attribute]]
| 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 All [[Attribute]]s
| 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 Group
| 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 Events]]
<noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items areas]]
*[[Api session items areas]]
}}
}}
 
</noinclude>
[[Category:API]]
[[Category:API]]

Latest revision as of 10:26, 13 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

See also

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