Fork me on GitHub
Show:

FireMarkers

Summary

Constructor

aeris.maps.markercollections.FireMarkers

Syntax

aeris.maps.markercollections.FireMarkers

()

Summary

Methods

_onModelEvent

Syntax

_onModelEvent

()

Summary

From Backbone.Collection#_onModelEvent

addFilter

Syntax

addFilter

(
  • filter
)

Summary

Add a filter to the Aeris API request.

Parameters:

addQuery

Syntax

addQuery

(
  • query
)

Summary

Add a query term to Aeris API request.

Parameters:

createStrategy_

Syntax

createStrategy_

(
  • Strategy
)
AbstractStrategy protected

Summary

Create a {aeris.maps.AbstractStrategy} instance.

Override to adjust how strategy objects are instantiated.

Parameters:

  • Strategy Function

    AbstractStrategy object ctor.

Returns:

getClusterOptions

Syntax

getClusterOptions

() Object

Summary

Returns:

getClusterStyle

Syntax

getClusterStyle

(
  • opt_group
)
Object

Summary

Returns a copy of the cluster styles for the specified cluster group.

Parameters:

  • opt_group String=

    Defaults to 'defaultStyles.'.

Returns:

Object:

Cluster styles object.

getParams

Syntax

getParams

() Params

Summary

Return params used to query the Aeris API.

Returns:

getQuery

Syntax

getQuery

() ChainedQueries

Summary

Returns the query for the Aeris API request.

Returns:

removeFilter

Syntax

removeFilter

(
  • filter
)

Summary

Remove a filter from the Aeris API request.

Parameters:

removeQuery

Syntax

removeQuery

(
  • Query
)

Summary

Remove a query from the Aeris API request

Parameters:

removeStrategy

Syntax

removeStrategy

()

Summary

Remove and clean up the StrategyObject's strategy.

resetFilter

Syntax

resetFilter

(
  • opt_filter
)

Summary

Reset a filter from the Aeris API request.

Parameters:

resetQuery

Syntax

resetQuery

(
  • opt_replacementQuery
)

Summary

Resets the query for the Aeris API request.

Parameters:

resetStrategy

Syntax

resetStrategy

()

Summary

Reset the rendering strategy used by the object. Useful for re-enabled a strategy which has previously been removed with StrategyObject#removeStrategy

setBounds

Syntax

setBounds

(
  • bounds
)

Summary

Set the latLon bounds for querying the Aeris API.

Parameters:

setFrom

Syntax

setFrom

(
  • from
)

Summary

Set the from parameter for querying the Aeris API.

Parameters:

setMap

Syntax

setMap

()

Summary

Set the map on all child MapObjects.

Any newly created map objects will be instantiated with the map set here.

setParams

Syntax

setParams

(
  • params
)

Summary

Set params used to query the Aeris API.

Parameters:

setStrategy

Syntax

setStrategy

(
  • Strategy
)

Summary

Set the strategy to use for rendering the StrategyObject.

Parameters:

  • Strategy Function

    Constructor for an {aeris.maps.AbstractStrategy} object.

setTo

Syntax

setTo

(
  • to
)

Summary

Set the to parameter for querying the Aeris API.

Parameters:

startClustering

Syntax

startClustering

()

Summary

Starts up the strategy defined by this.clusterStrategy_.

stopClustering

Syntax

stopClustering

()

Summary

Destroys the clustering strategy started up by #startClustering.

Properties

clusterOptions_

Syntax

clusterOptions_

Object private

Summary

clusterStrategy_

Syntax

clusterStrategy_

function():aeris.maps.AbstractStrategy private

Summary

isClustering_

Syntax

isClustering_

Boolean private

Summary

Whether a clustering strategy is currently active.

map_

Syntax

map_

?aeris.maps.Map private

Summary

strategy_

Syntax

strategy_

?aeris.maps.AbstractStrategy protected

Summary

The strategy used to interact with the map view.

StrategyType_

Syntax

StrategyType_

function():aeris.maps.AbstractStrategy private

Summary

Events

cluster:click

Syntax

cluster:click

Summary

Event Payload:

cluster:mouseout

Syntax

cluster:mouseout

Summary

When the mouse exits a cluster.

Event Payload:

cluster:mouseover

Syntax

cluster:mouseover

Summary

When the mouse enters a cluster.

Event Payload:

strategy:set

Syntax

strategy:set

Summary

When a strategy is set on the object.

Event Payload: