Api session event editor overlay set rasterization: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
No edit summary
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
API Event to Set the type of rasterization a specified AVG or Distance [[Overlay]] should do.
API Endpoint: editoroverlay/set_rasterization.
 
Description: Set the type of rasterization a specified AVG or Distance [[Overlay]] should do.
 
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 22: Line 25:
|OPTIONAL
|OPTIONAL
|(Enumeration)
|(Enumeration)
|MapLink (will only affect the SINGLE_LAYER rasterization type): BUILDINGS, TERRAINS, AREAS, NEIGHBORHOODS
|MapLink (will only affect the SINGLE_LAYER rasterization type): [[Building]], [[Terrain]], [[Area]], [[Neighborhood]]
|
|
|}
|}
Line 37: Line 40:
|}
|}
===Example POST===
===Example POST===
Curl Example POST:
Curl example POST:


<syntaxhighlight lang="text" copy>curl 'https://development.tygron.com/api/session/event/editoroverlay/set_rasterization/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "FIRST", "" ]'
<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>
</syntaxhighlight>
JavaScript Example POST:
JavaScript example POST:


<syntaxhighlight lang="text" copy>var options = {
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer 31410104zAuxtcJo8WGhL6iYlCDnU5hd" },
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "FIRST", "" ]'
 body: '[ 1, "FIRST", "" ]'
};
};
fetch("https://development.tygron.com/api/session/event/editoroverlay/set_rasterization/", options)
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_rasterization/", options)
 .then(response => response.text())
 .then(response => response.text())
 .then(result => console.log(result))
 .then(result => console.log(result))

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));

See also

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