Skip to main content

Data Accessor Functions

These functions are exposed via globalThis.MaptaskrControlManager.getControl(controlId) and let you search, navigate, manage layers & sublayers, work with shapes, retrieve map state, highlight data, and manage selected features.

Usage Pattern

const control = globalThis.MaptaskrControlManager.getControl(controlId);

Each function below assumes you already have a control reference as shown.

The table below lists the currently supported functions grouped by category (sourced from the individual pages in this folder). Anything not listed here is deprecated, internal, or not yet documented.

CategoryFunctionSignatureReturnsDescription
NavigationnavigateToLatLong(latitude: number, longitude: number, zoom: number)voidPan & zoom to a coordinate
NavigationnavigateToExtent(minLat: number, minLon: number, maxLat: number, maxLon: number)voidFit map to extent
NavigationnavigateToAddress(item: SearchResult)Promise<void>Center on an address result
NavigationnavigateToRegion(item: SearchResult)Promise<void>Center on a region result
NavigationnavigateToFeature(item: SearchResult)Promise<void>Center on a feature result
SearchingparseLocation(possibleCoordinate: string)SearchResult | undefinedParse free‑text lat/long
SearchingsearchAddressesByLocation(lat: number, lon: number)Promise<SearchResult[]>Reverse geocode nearby addresses
SearchingsearchAddresses(searchTerm: string)Promise<SearchResult[]>Search addresses
SearchingsearchRegions(searchTerm: string)Promise<SearchResult[]>Search regions
SearchingsearchFeatures(searchTerm: string)Promise<SearchResult[]>Search features
SearchingsearchLayers(searchTerm: string)Promise<SearchResult[]>Search layers (metadata)
SearchingsetRecordAddress(item: SearchResult)voidApply address to current record
Layer ManagementgetGalleryLayers()Promise<CustomAvailableLayer[]>List available gallery layers
SublayersgetSublayerAttributes(sublayerId: string)Promise<SublayerAttributes>Attribute metadata for a sublayer
LayerscreateSublayerInstance(sublayerId: string)Promise<string>Enable sublayer (returns instanceId)
LayerscreateSublayerInstanceWithFilter(sublayerId: string, filter: Filter)Promise<string | void>Enable sublayer with initial filter
LayersgetEnabledSublayerInstances()Promise<ILayerInstance[]>All enabled sublayer instances
LayersshowSublayerInstance(subLayerInstanceId: string)Promise<void>Make instance visible
LayershideSublayerInstance(subLayerInstanceId: string)voidHide instance
LayersremoveSublayerInstance(subLayerInstanceId: string)voidRemove instance (disable)
LayersnavigateToSublayerInstance(subLayerInstanceId: string)voidZoom to instance extent
LayersfilterSublayerInstance(subLayerInstanceId: string, filter: Filter)voidApply / replace filter
LayersclearFilterFromSublayerInstance(subLayerInstanceId: string)voidClear filter
LayersupdateSublayerInstanceOpacity(subLayerInstanceId: string, opacity: number)Promise<void>Change opacity
LayersgetVisibleSublayerInstanceData(subLayerInstanceId: string, pageNumber: number, pageToken?: string)Promise<FeaturesResponse>Paged visible data
LayersgetAllSublayerInstanceData(subLayerInstanceId: string, pageNumber: number, pageToken?: string)Promise<FeaturesResponse>Paged full data
LayersshowVisibleDataTabForSublayerInstance(subLayerInstanceId: string)voidShow data tab (visible extent)
LayersshowAllDataTabForSublayerInstance(subLayerInstanceId: string)voidShow data tab (all data)
LayershideDataTabForSublayerInstance(subLayerInstanceId: string)voidHide single data tab
LayershideAllDataTabs()voidHide all data tabs
ShapesgetShapes(id?: string)MaptaskrShape[]Get shapes (optional scope id)
ShapesaddOrUpdateShape(customShape: CustomShape)Promise<MaptaskrShape[]>Create or update shape
ShapesdeleteShape(shape: MaptaskrShape)Promise<void>Delete a shape
Map StatedownloadMap()voidDownload current view
Map StategetMapCenter()MaptaskrCoordinateCurrent map center
Map StategetMapExtent()ExtentCurrent extent
User HighlightsaddUserHighlight(geoJsonObject: FeatureCollection)voidAdd / replace highlight overlay
User HighlightsclearUserHighlight()voidRemove highlight overlay
Selected FeaturesgetSelectedFeatures()SelectedFeature[]Current selected features
Selected FeaturessetSelectedFeatures(features: SelectedFeature[] | null | undefined)voidReplace / clear selected features
Map FilteringsetMapFilter(filter: MapGeometryFilter)Promise<void>Create / replace map filter
Map FilteringdisableMapFilter()voidTemporarily disable active filter
Map FilteringenableMapFilter()voidRe-enable previously disabled filter
Map FilteringclearMapFilter()voidRemove active filter definition