autk-map / AutkMap
Class: AutkMap
Defined in: main.ts:60
The main autark map class.
AutkMap encapsulates the core logic for initializing and rendering a map on a given HTML canvas element. It manages the camera, map rendering, map layers, and user interactions through keyboard, mouse, and map events.
Example
const canvas = document.getElementById('map-canvas') as HTMLCanvasElement;
const boundingBox = /* { bounding box for the map } */ ;
const map = new AutkMap(canvas);
await map.init(boundingBox);
const geojsonData = { /* GeoJSON data */ };
map.loadGeoJsonLayer('my_data', LayerType.CUSTOM_FEATURES_LAYER, geojsonData);Constructors
Constructor
new AutkMap(
canvas,autoResize?):AutkMap
Defined in: main.ts:85
Creates an instance of the AutkMap class.
Parameters
canvas
HTMLCanvasElement
The canvas element to render the map on
autoResize?
boolean = true
Whether to automatically resize the canvas on window resize
Returns
AutkMap
Properties
_camera
protected_camera:Camera
Defined in: main.ts:62
The camera instance used for rendering the map
_canvas
protected_canvas:HTMLCanvasElement
Defined in: main.ts:78
The canvas element used for rendering the map
_keyEvents
protected_keyEvents:KeyEvents
Defined in: main.ts:69
The key events handler for keyboard interactions
_layerManager
protected_layerManager:LayerManager
Defined in: main.ts:66
The layer manager instance used for managing map layers
_mapEvents
protected_mapEvents:MapEvents
Defined in: main.ts:73
The map events handler for map interactions
_mouseEvents
protected_mouseEvents:MouseEvents
Defined in: main.ts:71
The mouse events handler for mouse interactions
_renderer
protected_renderer:Renderer
Defined in: main.ts:64
The renderer instance used for rendering the map
_ui
protected_ui:AutkMapUi
Defined in: main.ts:76
The UI instance for managing the map's user interface
Accessors
boundingBox
Get Signature
get boundingBox():
BBox
Defined in: main.ts:177
Gets the bounding box of the map.
Returns
BBox
The bounding box
Set Signature
set boundingBox(
bbox):void
Defined in: main.ts:180
Parameters
bbox
BBox
Returns
void
camera
Get Signature
get camera():
Camera
Defined in: main.ts:110
Gets the camera instance used for rendering the map.
Returns
The camera instance
Set Signature
set camera(
camera):void
Defined in: main.ts:118
Sets the camera instance used for rendering the map.
Parameters
camera
The camera instance to set
Returns
void
canvas
Get Signature
get canvas():
HTMLCanvasElement
Defined in: main.ts:152
Gets the canvas element used for rendering the map.
Returns
HTMLCanvasElement
The canvas element
layerManager
Get Signature
get layerManager():
LayerManager
Defined in: main.ts:134
Gets the layer manager instance used for managing map layers.
Returns
The layer manager instance
mapEvents
Get Signature
get mapEvents():
MapEvents
Defined in: main.ts:143
Gets the map events instance used for handling map interactions.
Returns
The map events instance
origin
Get Signature
get origin():
number[]
Defined in: main.ts:169
Gets the origin of the map, which is the center of the bounding box.
Returns
number[]
The origin coordinates [x, y]
renderer
Get Signature
get renderer():
Renderer
Defined in: main.ts:126
Gets the renderer instance used for rendering the map.
Returns
The renderer instance
ui
Get Signature
get ui():
AutkMapUi
Defined in: main.ts:160
Gets the UI instance used for managing the map's user interface.
Returns
The UI instance
Methods
draw()
draw(
fps?):void
Defined in: main.ts:453
Starts the drawing loop.
Parameters
fps?
number = 60
The frames per second to target.
Returns
void
init()
init():
Promise<void>
Defined in: main.ts:187
Initializes the map.
Returns
Promise<void>
loadGeoJsonLayer()
loadGeoJsonLayer(
layerName,geojson,typeLayer?):void
Defined in: main.ts:220
Loads a GeoJSON layer into the map.
This method creates a layer based on the provided GeoJSON data and adds it to the map's layer manager. Supported OSM layer types include:
- AUTK_OSM_SURFACE
- AUTK_OSM_WATER
- AUTK_OSM_PARKS
- AUTK_OSM_ROADS
- AUTK_OSM_BUILDINGS
Custom layers can also be loaded with types:
- AUTK_GEO_POINTS
- AUTK_GEO_POLYLINES
- AUTK_GEO_POLYGONS
- AUTK_RASTER
Parameters
layerName
string
The name of the layer
geojson
FeatureCollection
The GeoJSON data to load
typeLayer?
LayerType | null
The type of the layer
Returns
void
loadGeoTiffLayer()
loadGeoTiffLayer(
layerName,geotiff,typeLayer?):void
Defined in: main.ts:287
Loads a GeoTIFF layer into the map. This method creates a layer based on the provided GeoTIFF data and adds it to the map's layer manager.
Parameters
layerName
string
The name of the layer
geotiff
FeatureCollection
The GeoTIFF data to load
typeLayer?
LayerType | null
The type of the layer
Returns
void
updateGeoJsonLayerThematic()
updateGeoJsonLayerThematic(
layerName,geojson,getFnv,groupById?):void
Defined in: main.ts:314
Updates the thematic information of a layer based on a GeoJSON source.
This method extracts thematic values from the GeoJSON features using the provided function, normalizes these values, and updates the layer's thematic data accordingly.
Parameters
layerName
string
The name of the layer to update
geojson
FeatureCollection
The GeoJSON data containing the features
getFnv
(feature) => string | number
A function that extracts a numeric value from a GeoJSON feature
groupById?
boolean = false
Whether to group features by their 'building_id' property to ensure uniqueness
Returns
void
updateLayerGeometry()
updateLayerGeometry(
layerName,layerGeometry):void
Defined in: main.ts:396
Updates the geometry of a layer.
Parameters
layerName
string
The name of the layer
layerGeometry
The geometry data to update
Returns
void
updateLayerThematic()
updateLayerThematic(
layerName,layerThematic):void
Defined in: main.ts:381
Updates the thematic information of a layer.
Parameters
layerName
string
The name of the layer
layerThematic
The thematic information to update
Returns
void
updateRenderInfoProperty()
updateRenderInfoProperty(
layerName,property,value):void
Defined in: main.ts:412
Updates the render information of a layer.
Parameters
layerName
string
The name of the layer
property
keyof ILayerRenderInfo
The property to update
value
unknown
The new value for the property
Returns
void
