1. Start Here

    1. Welcome
    2. Get Help
    3. Blog
    4. Version Changelog
  2. [+]Examples

  3. Reference

  4. [+]JavaScript API

  5. [+]REST API

  6. [+]Analysis

JavaScript Methods

Map Interaction

Geographic Maps can be panned, zoomed, and modified.

Method Description
F1.Maker.Map Create a new map on the page
setExtent Set the map geographic boundaries.
getCenterZoom Get map geographic center location coordinates and zoom level.
getCenter Get map geographic center location coordinates.
setCenter Set the map location by coordinates.
setCenterZoom Set the map location and zoom level.
getZoom Get the current map zoom level.
setZoom Set a new map zoom level.
getMapProviderList
getBasemap Get the current basemap layer and projection.
setBasemap Change the basemap to a new tile layer.
saveMap Save the current map state to GeoIQ.
setStyle Change the map styling such as Zoom and Legend.

Map Layers

Layers are styled datasets on a map. They can be simple styles such as color, size, or transparency. For more advanced visualizations thematic styling can vary the styling by an attribute value or category.

Method Description
getLayers Returns a list of the map layers.
removeLayer Remove a specific layer from the map.
addLayer Add a data layer and styling to the map.
showLayer Change the visibility of a layer.
getLayer Get the layer styling and metadata.
setLayerStyle Change the layer styling.
setLayerTitle Set the layer title for the legend.
setLayerSubTitle Set the layer subtitle for the legend.
addLayerCategoryFilter Style the layer icons that match a list of categories and URLs.
addLayerInfoWindowFilter Style the infowindow contents for a layer.

Layer Filters

Map layers can be filtered to show a limited subset of data based on an attribute, or visible area. It is also possible to highlight specific dataset features based on a simple or complex comparison with the attributes.

Method Description
addFilter Add a new limit expression to a layer.
removeFilter Remove a limit expression by name from a layer.
getFilters Get the array of current limit expressions for a layer.
clearFilters Remove all limit expressions from the layer.
addHighlight Highlight features of a layer by a filter expression.
removeHighlight Remove a highlight expression from a layer.
clearHighlights Remove all highlights from a layer.

Data Features API

Each dataset layer has a collection of features, or individual geographic points, lines or polygons. It is possible to access all of the features or some features. Drawing new features must be added to an existing layer.

Method Description
addFeatures Add an array of features to a layer.
getFeatures Get the current list of features that are part of the layer.
getVisibleFeatures Get only the currently visible features by limit expressions and geographic extents.

Temporal Controls

Map layers can be animated by a time attribute.

Method Description
setLayerTemporalAttribute Specify a temporal attribute for a layer to be animated with.
setTemporalResolution Set the time resolution for an attribute.
getTemporalResolution Get the current time resolution for a layer.
getTimeSlots Get an array of the features in all time slots.
setTimeSpan Set the currently visible time span.
getTimeSpan Get the currently visible time span.
getGlobalTimeSpan Get the extent of all time features in a layer.
setTimeFilter

Events

Maps and layers can reference callback methods when an event occurs.

Method Description
onMapLoaded Called when the map has finished loading all layer data
onMapClicked Called when the map has been clicked on
onMapPanStart Called when a user starts moving map
onMapPanStop Called when a user stops moving the map
onMapZoomed Called after a user has zoomed in or out of the map
onFeatureSelected Called after a feature has been selected by the map user.
onBaseMapChanged Called when the basemap changes
onLayerAdded Called once after a layer has been added to the map
onLayerLoading Called while the layer is loading, used for progress
onLayerLoaded Called once a layer has been completely loaded
onLayerStyleChange Called every time a style is changed
onLayerParsing Called while a layer is being parsed
onLayerParsed Called after a layer has been parsed
onLayerRendering Called while an overlay is rendering, post init and pre-loaded
onLayerRendered Called once a layer has been completely rendered on the map
onLayerError Called on an error loading layers
onLayerRemoved Called when a layer is removed from the map
onMapClassificationChange Called every time a map’s classification is changed
onTemporalReady Called when the temporal features are ready to be animated
onTemporalChange Called after the time slider is changed in any way