Class GSTrafficFlowOverlay

Allows adding a traffic flow overlay to the map.

Class Summary
Constructor Attributes	Constructor Name and Description
	GSTrafficFlowOverlay(map, options) Constructs a new `GSTrafficFlowOverlay` object and adds it to the map

Method Summary
Method Attributes	Method Name and Description
	isVisible() Returns a boolean value indicating the visibility of the traffic flow
	setVisible(visible) Sets the visibility of the traffic flow overlay.

Class Detail

GSTrafficFlowOverlay(map, options)

Constructs a new GSTrafficFlowOverlay object and adds it to the map

Parameters:
{GSMap} map: the map to add the traffic flow overlay to (defaults to 15)
{Object} options Optional: an object literal specifying the traffic flow overlay options to set:
{int} options.zIndex: the zIndex to display the overlay at
{GSBounds} options.maxExtent: restict the extent of traffic flow overlay (defaults to all of New Zealand)
{boolean} options.visible: true if this layer should initially be visible on the map (defaults to true)

Method Detail

{boolean} isVisible()

Returns a boolean value indicating the visibility of the traffic flow

setVisible(visible)

Sets the visibility of the traffic flow overlay. Note that the traffic flow overlay is only visible on zoom levels 8 to 16.