Api session event editor overlay set rasterization: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: editoroverlay/set_rasterization. | API Endpoint: editoroverlay/set_rasterization. | ||
Description: Set the type of rasterization a specified AVG or Distance [[Overlay]] should do. | |||
{|class=wikitable | {|class=wikitable | ||
| Line 27: | Line 25: | ||
|OPTIONAL | |OPTIONAL | ||
|(Enumeration) | |(Enumeration) | ||
|MapLink (will only affect the SINGLE_LAYER rasterization type): | |MapLink (will only affect the SINGLE_LAYER rasterization type): [[Building]], [[Terrain]], [[Area]], [[Neighborhood]] | ||
| | | | ||
|} | |} | ||
| Line 59: | Line 57: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{article end|seealso=*[[Api session event editor overlay]] | {{article end|seealso=*[[Api session event editor overlay]] | ||
*[[Api session items overlays]] | |||
}} | }} | ||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 15:00, 20 April 2026
API Endpoint: 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));