Telogis.GeoBase.MapLayers.ClusterLayer

Arguments

• config (Object) - Configuration options for the MapLayers.ClusterLayer.

  Properties

  Name	Type	Description
  preSendCallback (XMLHttpRequest request)	Function	A callback that is fired before each XMLHttpRequest is sent. It takes the request as an argument. It can be used to set a header, for example: JavaScript Copy function addHeader(request) { request.setRequestHeader('HeaderName', 'value'); } var clusterLayer = new ClusterLayer({ usePost: true, preSendCallback: addHeader, // id, map, other options }); Only applicable when usePost is set to true. Arguments request (XMLHttpRequest) - The POST request which is being sent, after .open() has been called.
  url	String	The URL to use when fetching cluster information.
  usePost	Boolean	Whether to use HTTP POST request method instead of GET method. Defaults to false.

Creates a ImageObject for a given cluster. This may be overridden to enable advanced ImageObject features such as balloons.

// Create a new ClusterLayer
var clusterlayer = new ClusterLayer({
    id: 'main_map_clusters',
    map: map,
    url: 'tutorial.clustering.ashx'
});

// Override createCluster to add balloons displaying cluster count
clusterlayer.createCluster = function(cluster) {
    return new ImageObject({
        layer : this,
        src : this.getClusterImageUrl(cluster),
        location : cluster.centerOfGravityLatLon,
        anchorPoint : this.getClusterImageAnchor(cluster),
        balloonConfig : {    content : "Cluster Count: " + cluster.count}
    });
};

• cluster (Cluster) - The cluster.

Gets the image anchor for a given cluster.

• cluster (Cluster) - The cluster to get an image anchor for.

Gets the image URL for a given cluster.

• cluster (Cluster) - The cluster to get a URL for.

Called when a cluster is created. Override this to bind events.

// Create a new ClusterLayer
var clusterlayer = new ClusterLayer({
    id: 'main_map_clusters',
    map: map,
    url: 'tutorial.clustering.ashx'
});

// Override onClusterCreated to add a mouse event. Clicking on a cluster
// will zoom/center the map to display the area represented by that cluster.
clusterlayer.onClusterCreated = function(cluster, object) {
    object.RightClick.append(function(e) {
        map.zoomTo(cluster.boundingBox);
    });
};

• cluster (Cluster) - The newly created cluster.

• object (AbstractObject) - The associated AbstractObject.

Called each time a ClusterSet is returned from the server while updating a ClusterLayer.

• result (ClusterSet) - The clusters returned from the server

Refresh the cluster layer(s) immediately.

Set the cluster layer url.

• url (String) - The cluster url to use. If no url is supplied in string format, no clusters will be rendered on the map.

Triggered when ClusterLayer receives cluster error from GeoStream

Triggered when ClusterLayer sends a request for clusters to GeoStream

Triggered when ClusterLayer receives clusters from GeoStream

Amount of time in MS to delay refreshing clusters.