---

Classes

• _global_
• AjaxRequestOptions
• ContentFilter
• GeoMashup
• GeoMashupIcon
• GeoMashupObject
• GeoMashupOptions
• VisibilityFilter

---

Namespace GeoMashup

Used more as a singleton than a namespace for data and methods for a single Geo Mashup map.

Violates the convention that capitalized objects are designed to be used with the 'new' keyword - an artifact of the age of the project. :o

Note: Events are Actions

Actions available for use with GeoMashup.addAction() are documented as events. See the custom javascript documentation for an example.

Defined in: geo-mashup.dev.js.

Namespace Summary

Constructor Attributes	Constructor Name and Description
	GeoMashup

Field Summary

Field Attributes	Field Name and Description
<static>	GeoMashup.term_manager An object to manage taxonomy terms.
<static>	GeoMashup.term_manager.tabbed_index The tabbed index control object.

Method Summary

Method Attributes	Method Name and Description
<static>	GeoMashup.addAction(name, callback) Add an action callback to extend Geo Mashup functionality.
<static>	GeoMashup.addGlowMarker(marker) Obscure an existing marker with the highlighted "glow" marker.
<static>	GeoMashup.addObjects(response_data, add_term_info) Add objects to the map.
<static>	GeoMashup.autoZoom() Zoom the map to loaded content.
<static>	GeoMashup.categoryIndexId(category_id) Get the DOM ID of the element containing a category index in the tabbed category index control.
<static>	GeoMashup.categoryTabSelect(select_category_id) Select a tab of the tabbed category index control.
<static>	GeoMashup.centerMarker(marker, zoom) Center and optionally zoom to a marker.
<static>	GeoMashup.clickMarker(object_id, try_count) Backward compatibility for clickObjectMarker().
<static>	GeoMashup.clickObjectMarker(object_id, try_count) Simulate a user click on the marker that represents a specified object.
<static>	GeoMashup.closeInfoWindow(marker) Close the info bubble for a marker.
<static>	GeoMashup.deselectMarker() De-select the currently selected marker if there is one.
<static>	GeoMashup.doAction(name) Fire all callbacks for an action.
<static>	GeoMashup.getCategoryName(category_id) Get the name of a category, if loaded.
<static>	GeoMashup.getMarkerLatLng(marker) Get the location coordinates for a marker.
<static>	GeoMashup.getMarkerObjects(marker) Get the objects at the location of a specified marker.
<static>	GeoMashup.getObjectsAtLocation(point) Get the objects at a specified location.
<static>	GeoMashup.getOnObjectIDs(objects) Extract the IDs of objects that are "on" (not filtered by a control).
<static>	GeoMashup.getShowPostElement() Get the DOM element where the full post content should be displayed, if any.
<static>	GeoMashup.hideAttachments() Hide any visible attachment layers on the map.
<static>	GeoMashup.hideCategory(category_id) Hide markers and line for a category.
<static>	GeoMashup.hideCategoryHierarchy(category_id) Hide a category and all its child categories.
<static>	GeoMashup.hideLine(line) Hide a line.
<static>	GeoMashup.hideLoadingIcon() Hide the spinner icon for the map.
<static>	GeoMashup.hideMarker(marker) Hide a marker.
<static>	GeoMashup.hideMarkers() Hide all markers.
<static>	GeoMashup.isCategoryAncestor(ancestor_id, child_id) Determine whether a category ID is an ancestor of another.
<static>	GeoMashup.isMarkerVisible(marker, False) Whether a marker is currently visible on the map.
<static>	GeoMashup.loadFullPost(point) Load full content for the objects/posts at a location into the full post display element.
<static>	GeoMashup.newLatLng(lat, lng) Create a new geo coordinate object.
<static>	GeoMashup.openInfoWindow(marker) Open the info bubble for a marker.
<static>	GeoMashup.parentizeLinks(node) Change the target of links in a DOM element to target the parent frame.
<static>	GeoMashup.parentizeLinksMarkup(markup) Change the target of links in HTML markup to target the parent frame.
<static>	GeoMashup.recluster() If clustering is active, refresh clusters.
<static>	GeoMashup.removeGlowMarker() Remove the highlighted "glow" marker from the map if it exists.
<static>	GeoMashup.selectMarker(marker) Select a marker.
<static>	GeoMashup.showCategory(category_id) Show markers for a category.
<static>	GeoMashup.showCategoryHierarchy(category_id) Show a category and all its child categories.
<static>	GeoMashup.showLine(line) Show a line.
<static>	GeoMashup.showLoadingIcon() Display a spinner icon for the map.
<static>	GeoMashup.showMarker(marker) Show a marker.
<static>	GeoMashup.showMarkerAttachments(marker) Show any attachment layers associated with the objects represented by a marker, loading the layer if necessary.
<static>	GeoMashup.showMarkers() Show all unfiltered markers.
<static>	GeoMashup.term_manager.getTermData(taxonomy, term_id, property) Get a property of a loaded term.
<static>	GeoMashup.term_manager.getTermName(taxonomy, term_id) Get the display name of a term.
<static>	GeoMashup.term_manager.isTermAncestor(ancestor_id, child_id, taxonomy) Determine whether a term ID is an ancestor of another.
<static>	GeoMashup.term_manager.reset() Enable more objects to be loaded.
<static>	GeoMashup.term_manager.searchTermHierarchy(search_id, hierarchy) Find a term in a hierarchy.
<static>	GeoMashup.term_manager.setHierarchyVisibility(term_id, hierarchy, taxonomy, visible) Show or hide a tree of terms.
<static>	GeoMashup.term_manager.setTermVisibility(term_id, taxonomy, visible) Show or hide a term.
<static>	GeoMashup.term_manager.updateLineZoom(old_zoom, new_zoom) Show or hide category lines according to their max_line_zoom setting.
<static>	GeoMashup.updateMarkerVisibilities() Show or hide markers according to current visibility criteria.
<static>	GeoMashup.updateVisibleList() Recompile the list of objects currently visible on the map.

Event Summary

Event Attributes	Event Name and Description
	categoryIcon(properties, icon, term_id) A category icon is being assigned.
	categoryLine(properties, line) A category line was created.
	clusterOptions(properties, clusterer_opts) Clusterer options are being set.
	colorIcon(properties, icon, color_name) A category icon is being assigned by color.
	fullPostChanged() The full post display has changed.
	fullPostLoad(objects, filter) Loading full post content.
	fullPostRequest(objects, options) Requesting full post content.
	geoQueryUrl(properties, filter) The base URL used for geo queries is being set.
	glowMarkerIcon(properties, glow_options) A highlight "glow" marker is being created.
	loadedMap(properties, map) The map has loaded.
	mapOptions(properties, map_opts) The map options are being set.
	marker(properties, marker) A marker was created.
	markerInfoWindowLoad(marker, filter) A marker info window content is being loaded.
	markerInfoWindowMaxLoad(marker, filter) A marker's maximized info window content is being loaded.
	markerInfoWindowMaxRequest(marker, request_options) A marker's maximized info window content is being requested.
	markerInfoWindowRequest(marker, request) A marker's info window content is being requested.
	markerVisibilityOptions(properties, filter, marker, map) Visibility is being tested for a marker.
	multiObjectIcon(properties, plus_image) A marker representing multiple objects was created with this icon.
	multiObjectMarker(properties, marker) A marker representing multiple objects was created.
	newMap(properties, map) The map was created.
	objectIcon(properties, object) An icon is being assigned to an object.
	objectMarkerOptions(properties, glow_options, object) A marker is being created for an object.
	objectVisibilityOptions(properties, filter, object, map) Visibility is being tested for an object.
	selectedMarker(properties, marker, map) A marker was selected.
	singleMarker(properties, single_marker) A single map marker was added to the map.
	singleMarkerOptions(properties, marker_opts) A single map marker is being created with these options
	taxonomyLegend($legend, taxonomy) A taxonomy legend is being created
	taxonomyLegendTitle($title, taxonomy) A taxonomy legend title is being created
	termIcon(icon, taxonomy, term_id) A term icon is being assigned.
	termLegendEntry($key, $def, taxonomy, term_id) A taxonomy legend entry is being created
	termLegendRow($entry, taxonomy, term_id) A taxonomy legend table row is being created
	termLine(line) A term line was created.
	termLineOptions(properties, options) A term line will be added with the given options.
	updatedVisibleList(properties, list_count) The visible posts list was updated.

Since:

1.5

---

Since:

1.5

Parameters:

{String} name

The name of the action (event).

{Function} callback

The function to call when the action occurs

---

Parameters:

{Marker} marker

The existing marker

---

Parameters:

{Object} response_data

Data returned by a geo query.

{Boolean} add_term_info

Whether to build and show term data for these objects, for legend or other term controls.

---

---

Parameters:

{String} category_id

The category ID

Deprecated:

1.5

Returns:

{String} DOM ID

See:

GeoMashup.term_manager.tabbed_index.getTermIndexId()

---

Parameters:

{String} select_category_id

The ID of the category tab to select

Deprecated:

1.5

See:

GeoMashup.term_manager.tabbed_index.selectTab()

---

Parameters:

{Marker} marker

{Number} zoom

Optional zoom level

---

Parameters:

object_id

try_count

---

Parameters:

{String} object_id

The ID of the object.

{Number} try_count

Optional number of times to try (in case the object is still being loaded).

---

Parameters:

{Marker} marker

---

---

Parameters:

{String} name

The name of the action (event).

---

Parameters:

{String} category_id

Returns:

{String} The ID or null if not available.

---

Parameters:

{Marker} marker

Returns:

{LatLonPoint} The marker coordinates

---

Parameters:

{Marker} marker

Returns:

{Array} The mapped objects at the marker location

---

Parameters:

{LatLonPoint} point

The query location

Returns:

{Array} The mapped objects at the query location

---

Parameters:

{Array} objects

The objects to check

Since:

1.4.2

Returns:

{Array} The IDs of the "on" objects

---

Returns:

{DOMElement} The element, or undefined if none.

---

---

Parameters:

{String} category_id

Deprecated:

1.5

See:

GeoMashup.term_manager.setTermVisibility()

---

Parameters:

{String} category_id

The ID of the category to hide

Deprecated:

1.5

See:

GeoMashup.term_manager.searchTermHierarchy()

GeoMashup.term_manager.setHierarchyVisibility()

---

Parameters:

{Polyline} line

---

---

Parameters:

{Marker} marker

---

---

Parameters:

{String} ancestor_id

The category ID of the potential ancestor

{String} child_id

The category ID of the potential child

Deprecated:

1.5

See:

GeoMashup.term_manager.isTermAncestor()

---

Parameters:

{Marker} marker

{Boolean} False

if the marker is hidden or outside the current viewport.

---

Parameters:

{LatLonPoint} point

---

Parameters:

{Number} lat

Latitude

{Number} lng

Longitude

Returns:

{LatLonPoint} Coordinates

---

Parameters:

{Marker} marker

---

Parameters:

{DOMElement} node

The element to change

---

Parameters:

{String} markup

Returns:

{String} Modified markup

---

---

---

Parameters:

{Marker} marker

---

Parameters:

{String} category_id

Deprecated:

1.5

See:

GeoMashup.term_manager.setTermVisibility()

---

Parameters:

{String} category_id

The ID of the category to show

Deprecated:

1.5

See:

GeoMashup.term_manager.searchTermHierarchy()

GeoMashup.term_manager.setHierarchyVisibility()

---

Parameters:

{Polyline} line

---

---

Parameters:

{Marker} marker

---

Parameters:

{Marker} marker

---

---

Parameters:

taxonomy

term_id

property

Property name

Since:

1.5

Returns:

{*} Property value

---

Parameters:

taxonomy

term_id

Since:

1.5

Returns:

{String} The term name.

---

Parameters:

{String} ancestor_id

The term ID of the potential ancestor

{String} child_id

The term ID of the potential child

{String} taxonomy

The taxonomy of the terms.

Since:

1.5

Returns:

{boolean}

---

Since:

1.5

---

Parameters:

search_id

{object|string} hierarchy

Optional hierarchy structure or taxonomy name, defaults to 'category'.

Since:

1.5

Returns:

{object} Hierarchy tree rooted at the search term or null if not found.

---

Parameters:

term_id

hierarchy

The term hierarchy ID tree.

taxonomy

visible

Since:

1.5

---

Parameters:

term_id

taxonomy

visible

Since:

1.5

Returns:

{boolean} Whether visibility was set.

---

Parameters:

{number} old_zoom

Previous zoom level.

{number} new_zoom

New zoom level.

Since:

1.5

---

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{GeoMashupIcon} icon

{String} term_id

Deprecated:

Use GeoMashup#termIcon

Since:

1.5

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Polyline} line

Deprecated:

Use GeoMashup#termLine

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Object} clusterer_opts

Modifiable clusterer options for ClusterMarker.

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{GeoMashupIcon} icon

{String} color_name

Since:

1.5

---

---

Parameters:

{Array} objects

Objects included in the request

{ContentFilter} filter

---

Parameters:

{Array} objects

Objects included in the request

{AjaxRequestOptions} options

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Object} filter

Mofiable property: url

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Object} glow_options

Modifiable Mapstraction or Google marker options

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Map} map

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Object} map_opts

Modifiable Mapstraction or Google map options

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Marker} marker

---

Parameters:

{Marker} marker

{ContentFilter} filter

Modifiable property: content

---

Parameters:

{Marker} marker

{ContentFilter} filter

---

Parameters:

{Marker} marker

{AjaxRequestOptions} request_options

---

Parameters:

{Marker} marker

{AjaxRequestOptions} request

Modifiable property: url

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{VisibilityFilter} filter

Test and set filter.visible

{Marker} marker

The marker being tested

{Map} map

The map for context

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{String} plus_image

Icon URL

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Marker} marker

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Map} map

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{GeoMashupObject} object

Object whose icon property was set.

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Object} glow_options

Modifiable Mapstraction or Google marker options

{GeoMashupObject} object

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{VisibilityFilter} filter

Test and set filter.visible

{Object} object

The object being tested

{Map} map

The map for context

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Marker} marker

The selected marker

{Map} map

The map containing the marker

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Marker} single_marker

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Object} marker_opts

Mofifiable Mapstraction or Google marker options

---

Parameters:

{jQuery} $legend

Empty legend element with classes

{String} taxonomy

Since:

1.5

---

Parameters:

{jQuery} $title

Empty legend element with classes

{String} taxonomy

Since:

1.5

---

Parameters:

{GeoMashupIcon} icon

{String} taxonomy

{String} term_id

Since:

1.5

---

Parameters:

{jQuery} $key

Legend key node (td or dt)

{jQuery} $def

Legend definition node (td or dd)

{String} taxonomy

{String} term_id

Since:

1.5

---

Parameters:

{jQuery} $entry

Table row

{String} taxonomy

{String} term_id

Since:

1.5

---

Parameters:

{Polyline} line

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Object} options

Modifiable Mapstraction or Google Polyline options

Deprecated:

Use GeoMashup#termLineOptions

---

Parameters:

{GeoMashupOptions} properties

Geo Mashup configuration data

{Number} list_count

The number of items in the list

---