Map_Center()
Syntax: _Map_Center(Object_Map, latitude, longitude, latitudeSpan, longitudeSpan, isAnimated)
Purpose: Centers the map view on a specified location with the option to control zoom and animation.
Parameters:
Object_Map: (string) Name of the existing map object.
latitude, longitude: (numeric) Coordinates of the desired center point.
latitudeSpan, longitudeSpan: (numeric, optional) Span of the region in degrees. This sets the zoom level. If set to 0, the current zoom is maintained.
isAnimated: (boolean, optional) Specifies if the transition is animated (true) or instant (false, default).
Map_City()
Syntax: _Map_City()
Purpose: Retrieves the city name from map data. Often used in conjunction with reverse geocoding commands.
Returns: City name (if available) or an empty string.
Map_City_Detail()
Syntax: _Map_City_Detail()
Purpose: Retrieves additional city details from map data, such as neighborhood or similar subdivisions.
Returns: Supplementary city information (if available) or an empty string.
Map_Convert_Address_to_Coordinates()
Syntax: _Map_Convert_Address_to_Coordinates(Object_Map, Full_Address, Function_to_Response)
Purpose: Converts a given address into latitude and longitude coordinates.
Parameters:
Object_Map: (string) Name of the existing map object.
Full_Address: (string) The address to be converted.
Function_to_Response: (string) Name of the function to be executed upon completion.
Provides Data (within the response function):
_Map_Latitude()
_Map_Longitude()
_Map_Error_Message() (if an error occurs)
_Map_Is_Error() (true or false)
Map_Convert_Coordinates_to_Address()
Syntax: _Map_Convert_Coordinates_to_Address(Object_Map, latitude, longitude, Function_to_Response)
Purpose: Performs reverse geocoding, finding the closest address to provided coordinates.
Parameters:
Object_Map: (string) Name of the existing map object.
latitude, longitude: (numeric) The coordinates to convert.
Function_to_Response: (string) Name of the function to be executed upon completion.
Provides Data (within the response function):
_Map_City()
_Map_City_Detail()
_Map_Country_Code()
_Map_Country()
_Map_Error_Message() (if an error occurs)
_Map_Is_Error() (true or false)
_Map_Postal_Code()
_Map_Region()
_Map_Region_Detail()
_Map_Street()
_Map_Street_Detail()
Map_Coordinates_to_Display_Coordinate()
Syntax: _Map_Coordinates_to_Display_Coordinate(ObjectName, Latitud, Longitud)
Purpose: Converts map coordinates (latitude, longitude) into display coordinates (pixels) relative to the map object.
Parameters:
ObjectName: (string) Name of the existing map object.
Latitud, Longitud: (numeric) The map coordinates.
Map_Country()
Syntax: _Map_Country()
Purpose: Retrieves the country name from map data.
Returns: Country name (if available) or an empty string.
Map_Country_Code()
Syntax: _Map_Country_Code()
Purpose: Retrieves the standard country abbreviation (e.g., "US", "UK") based on map data.
Returns: Country code (if available) or an empty string.
Map_Error()
Syntax: _Map_Error()
Purpose: Deprecated. No longer in use with current map functions.
Map_Error_Message()
Syntax: _Map_Error_Message()
Purpose: Retrieves an error message if a map-related operation has failed.
Returns: Error message (if an error occurred) or an empty string.
Map_Is_Error()
Syntax: _Map_Is_Error()
Purpose: Checks if the previous map operation resulted in an error.
Returns: true (if an error occurred) or false.
Map_Is_Location_Visible()
Syntax: _Map_Is_Location_Visible(Object_Map)
Purpose: Checks if the user's current location is within the visible area of the map (approximate).
Parameters:
Object_Map: (string) Name of the existing map object.
Returns: true (if location is visible) or false.
Map_Latitude()
Syntax: _Map_Latitude()
Purpose: Retrieves the latitude associated with map data, often from geocoding operations.
Returns: Latitude (if available) or an empty string.
Map_Longitude()
Syntax: _Map_Longitude()
Purpose: Retrieves the longitude associated with map data, often from geocoding operations.
Returns: Longitude (if available) or an empty string.
Map_Marker()
Syntax: _Map_Marker(Object_Map, latitude, longitude, marker_function, title, subtitle, imageFile)
Purpose: Adds a marker to a map.
Parameters:
Object_Map: (string) Name of the existing map object.
latitude, longitude: (numeric) Coordinates for the marker.
marker_function: (string, optional) Function name to execute when the marker is tapped/clicked.
(string, optional) Title for the marker.
sub(string, optional) Subtitle for the marker.
imageFile: (string, optional) Image file for a custom marker. If omitted, a default marker is used. Image paths can use prefixes ($D, $R, $T, $C).
Returns: A Marker ID, used for further manipulation.
Map_Postal_Code()
Syntax: _Map_Postal_Code()
Purpose: Retrieves the postal code (zip code) from map data, often in conjunction with reverse geocoding.
Returns: Postal code (if available) or an empty string.
Map_Refresh()
Syntax: _Map_Refresh(ObjectName)
Purpose: Redraws the map instantly, useful after significant changes.
Parameters:
ObjectName: (string) Name of the existing map object.
Map_Region()
Syntax: _Map_Region()
Purpose: Retrieves the state, province, or similar region from map data.
Returns: Region name (if available) or an empty string.
Map_Region_Detail()
Syntax: _Map_Region_Detail()
Purpose: Retrieves further regional details below the state/province level (e.g., county) from map data.
Returns: Additional region information (if available) or an empty string.
Map_Remove_All_Markers()
Syntax: _Map_Remove_All_Markers(Object_Map)
Purpose: Removes all markers from a specified map.
Parameters:
Object_Map: (string) Name of the existing map object.
Map_Remove_Marker()
Syntax: _Map_Remove_Marker(Object_Map, markerID)
Purpose: Removes a single marker from a map.
Parameters:
Object_Map: (string) Name of the existing map object.
markerID: (string) The Marker ID, obtained when the marker was created using Map_Marker.
Map_Reverse_Geocoding()
Syntax: _Map_Reverse_Geocoding(GoogleLatLon, Actual_Add, Google_Maps_Api_Key, Label_for_Address, Function_to_Run_After_Completion)
Purpose: Performs reverse geocoding using Google Maps. Finds an address based on coordinates.
Parameters:
GoogleLatLon: (string) Latitude and Longitude, formatted as "Lat,Lon".
Actual_Add: (string, optional) If provided, sets this address to Label_for_Address and updates global Last* variables.
Google_Maps_Api_Key: (string) Required Google Maps API key.
Label_for_Address: (string, optional) Name of a label object to display the obtained address.
Function_to_Run_After_Completion: (string, optional) Function name to execute after the operation completes.
Provides Data (global variables):
Last_Address
Last_Zone
Last_City
Last_State
Last_Country_Code
Map_Reverse_Geocoding2()
Syntax: _Map_Reverse_Geocoding2(LocationIQ_LatLon, Actual_Add, LocationIQ_Maps_Api_Key, Label_for_Address, Function_to_Run_After_Completion)
Purpose: Performs reverse geocoding using LocationIQ Maps.
Parameters: (Identical parameters as Map_Reverse_Geocoding, substituting the API key)
Provides Data: (Same global variables as Map_Reverse_Geocoding)
Map_Set_Scroll_Mode()
Syntax: _Map_Set_Scroll_Mode(Object_Map, Scroll_Mode)
Purpose: Controls whether users can scroll the map by touch.
Parameters:
Object_Map: (string) Name of the existing map object.
Scroll_Mode: (boolean) True to allow scrolling, false to disable.
Map_Set_Zoom_Mode()
Syntax: _Map_Set_Zoom_Mode(Object_Map, Zoom_Mode)
Purpose: Controls whether users can zoom in or out using pinch gestures.
Parameters:
Object_Map: (string) Name of the existing map object.
Zoom_Mode: (boolean) True to allow zooming, false to disable.
Map_Street()
Syntax: _Map_Street()
Purpose: Retrieves the street name from map data.
Returns: Street name (if available) or an empty string.
Map_Street_Detail()
Syntax: _Map_Street_Detail()
Purpose: Retrieves additional street details, such as the street number, from map data.
Returns: Street details (if available) or an empty string.
Map_Touch_Started()
Syntax: _Map_Touch_Started(ObjectName, event)
Purpose: Internal use. This function is used by the Lu C Studio system to handle map touch events. Do not call directly.
Map_Type()
Syntax: _Map_Type(Object_Map, mapType)
Purpose: Sets the display type of the map.
Parameters:
Object_Map: (string) Name of the existing map object.
mapType: (string) Must be one of the following:
"standard" (default)
"satellite"
"hybrid"
Map_Zoom_In()
Syntax: _Map_Zoom_In(ObjectName)
Purpose: Zooms in on the map by a fixed increment (increasing the zoom level).
Parameters:
ObjectName: (string) Name of the existing map.
Map_Zoom_Level()
Syntax: _Map_Zoom_Level(ObjectName, ZoomLevel)
Purpose: Sets the zoom level of the map directly.
Parameters:
ObjectName: (string) Name of the existing map.
ZoomLevel: (numeric) Desired zoom level. Typical range is between 1 (world view) and 20 (street level). Minimum permitted value is 0.4.
Map_Zoom_Out()
Syntax: _Map_Zoom_Out(ObjectName)
Purpose: Zooms out on the map by a fixed increment (decreasing the zoom level).
Parameters:
ObjectName: (string) Name of the existing map object.
Mapping_Directions()
Syntax: _Mapping_Directions(Latitude1,Longitude1,Latitude2,Longitude2,App_Id,App_Code,Mode,VehiculeType,TrafficMode,LanguageCodeType,Function_To_Receive_Response)
Purpose: Obtains driving, cycling, or walking directions using the HERE Maps API. Requires a Freemium account with HERE.
Parameters:
Latitude1, Longitude1: (numeric) Starting point coordinates.
Latitude2, Longitude2: (numeric) Destination coordinates.
App_Id, App_Code: (strings) Your HERE Maps application credentials.
Mode: (string, optional) Transportation mode. Valid options:
"fastest" (default)
"shortest"
"balanced"
VehiculeType: (string, optional) Type of vehicle. Valid options:
"car" (default)
"pedestrian"
"carHOV"
"publicTransport"
"publicTransportTimeTable"
"truck"
"bicycle"
TrafficMode: (string, optional) Traffic consideration. Valid options:
"enabled"
"disabled"
"default" (default)
LanguageCodeType: (string, optional) Language code for the directions (refer to HERE Maps documentation for codes). Default is "en".
Function_To_Receive_Response: (string) Name of the function to execute after the request completes, receiving the results.
Response:
Provides route data in JSON format.
See HERE Maps Routing API
documentation for details.
Mapping_Geocoding()
Syntax: _Mapping_Geocoding(Address, Function_To_Receive_Response)
Purpose: Uses the HERE Maps API to convert an address into latitude and longitude coordinates.
Parameters:
Address: (string) The address to geocode.
Function_To_Receive_Response: (string) Name of the function to execute after the request completes.
Response: Provides coordinates in CSV format (e.g., "3.4190807723674394,-76.54630797636034")
Mapping_Reverse_Geocoding()
Syntax: _Mapping_Reverse_Geocoding(Latitude, Longitude, Function_To_Receive_Response)
Purpose: Uses the HERE Maps API to find the closest address to provided coordinates.
Parameters:
Latitude, Longitude: (numeric) The coordinates for reverse geocoding.
Function_To_Receive_Response: (string) Name of the function to execute after the request completes.
Response: Provides address data in CSV format. See HERE Maps documentation for details.
Remove_Map()
Syntax: _Remove_Map(ObjectName)
Purpose: Deletes a map object and all its associated elements from the scene.
Parameters:
ObjectName: (string) Name of the map object.
Set_Map_Latitude_Longitude()
Syntax: _Set_Map_Latitude_Longitude(ObjectName, latitude, longitude)
Purpose: Updates the center coordinates of an existing map. This is different from Map_Center, which can also animate the change as needed.
Parameters:
ObjectName: (string) Name of the existing map object.
latitude, longitude: (numeric) The new center coordinates.
Important Note: For significant changes (more than 50 pixels), this will trigger a complete redraw of the map for efficiency.
Initialize_Map2()
Syntax: _Initialize_Map2(Lu_C_Map_Server)
Purpose: Initializes a Lu C Map system for custom offline maps. Loads available areas from a server to determine parameters for the map.
Parameters:
Lu_C_Map_Server: (string) URL of the Lu C Map Server.
Requirements:
A file named "Maps_Index.txt" must exist in the map's folder on the server.
Example Maps_Index.txt Format:
****
-87.0419,20.2637,-86.7137,20.5996,0.00697,0.00455,17,Cozumel
-87.226955,20.478069,-86.909209,20.801443,0.00697,0.00455,17,MX Playa del carmen
-87.004825,20.771753,-86.666652,21.455534,0.00697,0.00455,17,Cancun
...
Each line represents an area:
The first four numbers are the bounding coordinates (lat1, lon1, lat2, lon2).
The next two are scaling factors for jump calculations.
The final number is a zoom level.
The optional text at the end is a label for that region.
Get_Map_Latitude_Longitude_Area()
Syntax: _Get_Map_Latitude_Longitude_Area(ObjectName)
Purpose: Retrieves coordinates defining the boundaries of the currently loaded map area in memory.
Parameters:
ObjectName: (string) Name of the existing map object.
Returns: A string containing "Lat1,Lng1,Lat2,Lng2"
Get_Map_Latitude_Longitude_Center()
Syntax: _Get_Map_Latitude_Longitude_Center(ObjectName)
Purpose: Retrieves the center coordinates of the current map.
Parameters:
ObjectName: (string) Name of the existing map object.
Returns: A string containing "Latitude,Longitude"
Get_Map_Zoom_Level()
Syntax: _Get_Map_Zoom_Level(ObjectName)
Purpose: Retrieves the current zoom level of a map.
Parameters:
ObjectName: (string) Name of the existing map object.
Returns: A numeric value representing the zoom level.