Api session event editor overlay set rasterization: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Event to Set the type of rasterization a specified AVG or Distance Overlay should do. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(OVERLAY Integer ID) |Overlay ID (must relate to an AVG or Distance Overlay) | |- |1 |REQUIRED |(Enumeration) |Rasterization type: FIRST, MIN, MAX, SINGLE_LAYER, GRID |FIRST, MAX, MIN, SINGLE_LAYER or GRID |- |2 |OPTIONAL |(Enumeration) |MapLink (will only affect the SINGLE_LAYER rasterization..." |
No edit summary |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
API | API Endpoint: api/session/event/editoroverlay/set_rasterization/ | ||
Description: Set the type of rasterization a specified AVG or Distance [[Overlay]] should do. | |||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
| Line 10: | Line 13: | ||
|REQUIRED | |REQUIRED | ||
|(OVERLAY Integer ID) | |(OVERLAY Integer ID) | ||
|[[Overlay]] ID (must relate to an AVG or Distance Overlay) | |[[Overlay]] ID (must relate to an AVG or Distance [[Overlay]]) | ||
| | | | ||
|- | |- | ||
| Line 22: | Line 25: | ||
|OPTIONAL | |OPTIONAL | ||
|(Enumeration) | |(Enumeration) | ||
| | |[[Maplink]] (will only affect the SINGLE_LAYER rasterization type): [[Building]], [[Terrain]], [[Area]], [[Neighborhood]] | ||
| | | | ||
|} | |} | ||
| Line 37: | Line 40: | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Curl example POST: | |||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_rasterization/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "FIRST", "" ]' | |||
</syntaxhighlight> | |||
JavaScript example POST: | |||
<syntaxhighlight lang="text" copy>var options = { | |||
method: "POST", | |||
</ | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
{{article end|seealso=*[[ | body: '[ 1, "FIRST", "" ]' | ||
}; | |||
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_rasterization/", options) | |||
.then(response => response.text()) | |||
.then(result => console.log(result)) | |||
.catch(error => console.log('error', error)); | |||
</syntaxhighlight> | |||
{{article end|seealso=*[[Api session event editor overlay]] | |||
*[[Api session items overlays]] | |||
}} | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 08:16, 15 May 2026
API Endpoint: api/session/event/editoroverlay/set_rasterization/
Description: Set the type of rasterization a specified AVG or Distance Overlay should do.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID (must relate to an AVG or Distance Overlay) | |
| 1 | REQUIRED | (Enumeration) | Rasterization type: FIRST, MIN, MAX, SINGLE_LAYER, GRID | FIRST, MAX, MIN, SINGLE_LAYER or GRID |
| 2 | OPTIONAL | (Enumeration) | Maplink (will only affect the SINGLE_LAYER rasterization type): Building, Terrain, Area, Neighborhood |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Curl example POST:
curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_rasterization/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "FIRST", "" ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "FIRST", "" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_rasterization/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));