Fork me on GitHub
Show:

MarkerCluster

Summary

Strategy for rendering a collection of markers in a cluster.

Constructor

aeris.maps.gmaps.markers.MarkerCluster

Syntax

aeris.maps.gmaps.markers.MarkerCluster

(
  • object
  • opt_options
)

Summary

Parameters:

Methods

addClusterer_

Syntax

addClusterer_

(
  • clusterer
  • groupName
)
private

Summary

Adds a MarkerClusterer with the given group name to the view.

Will overwrite any existing clusterer with the same group name.

Parameters:

addMarker

Syntax

addMarker

(
  • marker
)

Summary

Add a marker to the appropriate {MarkerClusterer} view.

Parameters:

addMarkers

Syntax

addMarkers

(
  • markers
)

Summary

Add a set of markers to the appropriate {MarkerClusterer} views.

Parameters:

afterRemove_

Syntax

afterRemove_

() protected

Summary

This method is called after this.mapView_ is set to null;

beforeRemove_

Syntax

beforeRemove_

()

Summary

Sets the map to null on all {MarkerClusterer} objects.

bindToMarkerCollection_

Syntax

bindToMarkerCollection_

() private

Summary

clearClusters

Syntax

clearClusters

()

Summary

Remove all markers from all clusterers.

createClusterer_

Syntax

createClusterer_

(
  • groupName
  • opt_markers
)
MarkerClusterer private

Summary

Create a MarkerClusterer object.

Parameters:

Returns:

createView_

Syntax

createView_

() Object private

Summary

Returns:

destroy

Syntax

destroy

()

Summary

getAllMarkers_

Syntax

getAllMarkers_

() Array.<Marker> private

Summary

Return all marker views from all clusterers.

Returns:

getClusterer

Syntax

getClusterer

(
  • groupName
)
MarkerClusterer

Summary

Get a MarkerClusterer by group name.

Parameters:

Returns:

getClusterStyle_

Syntax

getClusterStyle_

() private

Summary

getMarkerGroup_

Syntax

getMarkerGroup_

(
  • marker
)
String private

Summary

Get the group name for a marker, using the object's 'clusterBy' setting.

Parameters:

Returns:

getView

Syntax

getView

() ?Object

Summary

Return the view instance created by the map-rendering API.

Returns:

?Object:

proxyClustererEvents_

Syntax

proxyClustererEvents_

(
  • clusterer
)
private

Summary

Proxy events emitted by a {MarkerClusterer} object over to our {aeris.maps.MapObject}

Parameters:

remove

Syntax

remove

()

Summary

Remove the object view from the map view.

removeMarker

Syntax

removeMarker

(
  • marker
)

Summary

Remove a marker from it's clusterer.

Parameters:

removeMarkers

Syntax

removeMarkers

(
  • markers
)

Summary

Remove a set of markers from their clusterers.

Parameters:

repaint

Syntax

repaint

()

Summary

Redraws all MarkerClusterers.

resetClusters

Syntax

resetClusters

()

Summary

Refresh the clusters view, using our object's models.

setMap

Syntax

setMap

()

Summary

Sets the map on all {MarkerClusterer} objects.

Properties

googleEvents_

Syntax

googleEvents_

aeris.maps.gmaps.GoogleEvents protected

Summary

Helper for binding google.maps.event events.

mapView_

Syntax

mapView_

?google.maps.Map

Summary

The map associated with this object

MarkerClusterer_

Syntax

MarkerClusterer_

Function private

Summary

Constructor for the MarkerClusterer object.

objectEvents_

Syntax

objectEvents_

Unknown private

Summary

Evens to bind the map view to the object.

Binds object attribute 'change' events to strategy methods.

view

Syntax

view

Object.

Summary

A hash of MarkerClusterer objects, referenced by group name.

eg. { snow: {MarkerClusterer}, rain: {MarkerClusterer} }

view_

Syntax

view_

Object

Summary

The view instance created by the map rendering API.

Events

clusterer:add

Syntax

clusterer:add

Summary

When a MarkerClusterer instance is added to the view.

Event Payload:

  • clusterer MarkerClusterer
  • groupName String

clusterer:create

Syntax

clusterer:create

Summary

When a MarkerClusterer instance is created.

Event Payload:

  • clusterer MarkerClusterer

clusterer:remove

Syntax

clusterer:remove

Summary

When a MarkerClusterer instance is removed from the view.

Event Payload:

  • clusterer MarkerClusterer
  • groupName String