Skip to content

Component API calls

petewarden edited this page Sep 14, 2010 · 25 revisions

These are the functions you can call on an OpenHeatMap object from Javascript within a page. The object itself should be retrieved by calling getOpenHeatMap() from the supplied openheatmap.js script.

addInlay(leftX, topY, rightX, bottomY, topLat, leftLon, bottomLat, rightLon)

Creates an inlay that renders an area of the map over the top of the main view. This is typically used to display places like Alaska or Hawaii on a map of the US, but is also useful for showing details like a zoomed-in view of a city center on a regional map. One pitfall to beware of is that the first four values are coordinates in screen pixels for the area where the inlay should appear in the current view, so you should only call this directly after setting the initial viewing area, before the user has had a chance to zoom and pan.

getLatLonViewingArea

getPixelsPerDegreeLatitude

getValueForWayId

getValuePointsNearLatLon

getWayForWayId

getWaysContainingLatLon

loadValuesFromCSVString

loadValuesFromFile

loadWaysFromFile

removeAllInlays

removeAllWays

setColorGradient

setEventHandler

setGradientValueRange

setLatLonViewingArea

setOceanColor

setPixelsPerDegreeLatitude

setSetting

setSize

setWayDefault

translateMapByScreenPixels

zoomMapByFactorAroundPoint