Show:

ia.GoogleMap Class

Extends ia.CartesianSpace
Defined in: ia\maps\GoogleMap.js:1
Module: ia

Map defines the basic layout behavior of a google map.

Constructor

ia.GoogleMap

(
  • id
  • mapType
  • apiKey
  • minZoomLevel
  • maxZoomLevel
  • greyscaleText
  • offText
)

Defined in ia\maps\GoogleMap.js:1

Parameters:

  • id String

    The id of the map.

  • mapType String

    The initial map type.

  • apiKey String

    The api key.

  • minZoomLevel Number

    The min zoom (smaller number).

  • maxZoomLevel Number

    The max zoom (larger number).

  • greyscaleText String

    Toolbar greyscale text.

  • offText String

    Toolbar off text.

Methods

addEventListener

(
  • eventType
  • fnc
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:15

Add an event listener.

Parameters:

  • eventType String

    The type of event to listen for.

  • fnc Function

    The function to call when the event occurs.

  • obj Object

    An optional parent object.

addMapOverlay

(
  • map
)

Defined in ia\maps\GoogleMap.js:215

Adds an IA map as a google overlay.

Parameters:

adjustBBox

(
  • bb
)

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:352

Adjusts the bounding box to fit the pixel space whilst maintaining its aspect ratio.

Parameters:

adjustY

(
  • bb
)

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:396

Adjusts the y coords to fit the pixel space whilst maintaining x coords.

Parameters:

centerOnFeature

(
  • featureId
)
Boolean

Defined in ia\maps\GoogleMap.js:670

Centers a feature on the map.

Parameters:

  • featureId String

    The id of the feature.

Returns:

Boolean: true if the feature was found, otherwise false.

commitChanges

()

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:306

A call to commitChanges commits any changes made to canvasWidth, canvasHeight or bBox.

This function exists to allow properties to be changed without continuous updates to the object.

dispatchEvent

(
  • event
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:50

Dispatch an event to the listeners.

Parameters:

  • event Object

    The event object.

extra_zoom

(
  • b1
  • b2
  • The
)
private

Defined in ia\maps\GoogleMap.js:532

LatLngBounds b1, b2 -> zoom increment.

Parameters:

  • b1 google.maps.LatLngBounds

    The first LatLngBounds.

  • b2 google.maps.LatLngBounds

    The second LatLngBounds.

  • The Number

    zoom increment.

getBBox

() ia.BoundingBox

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:111

Gets the bounding box.

Returns:

ia.BoundingBox: The bounding box.

getDataBBox

(
  • rect
)
ia.BoundingBox

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:234

Converts a rectangle (pixel units) to a bBox (data units).

Parameters:

Returns:

ia.BoundingBox: A bBox (data units).

getDataHeight

(
  • dimension
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:292

Converts a height from pixel units to data units.

Parameters:

  • dimension Number

    A height (pixel units).

Returns:

Number: A height (data units).

getDataPoint

(
  • p
)
ia.Point

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:221

Converts a point from pixel units to data units.

Parameters:

Returns:

ia.Point: A point (data units).

getDataWidth

(
  • dimension
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:278

Converts a width from pixel units to data units.

Parameters:

  • dimension Number

    A width (pixel units).

Returns:

Number: A width (data units).

getDataX

(
  • x
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:252

Converts an x-coord from pixel units to data units.

Parameters:

  • x Number

    An x-coord (pixel units).

Returns:

Number: An x-coord (data units).

getDataY

(
  • y
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:265

Converts a y-coord from pixel units to data units.

Parameters:

  • y Number

    A y-coord (pixel units).

Returns:

Number: A y-coord (data units).

getPixelHeight

(
  • y
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:206

Converts a height from data units to pixel units.

Parameters:

  • y Number

    A height (data units).

Returns:

Number: A height (pixel units).

getPixelPoint

(
  • p
)
ia.Point

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:135

Converts a point from data units to pixel units.

Parameters:

Returns:

ia.Point: A point (pixel units).

getPixelRect

(
  • bb
)
ia.Rectangle

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:147

Converts a bounding box (data units) to a rectangle (pixel units).

Parameters:

Returns:

ia.Rectangle: A rectangle (pixel units).

getPixelWidth

(
  • x
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:191

Converts a width from data units to pixel units.

Parameters:

  • x Number

    A width (data units).

Returns:

Number: A width (pixel units).

getPixelX

(
  • x
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:163

Converts an x-coord from data units to pixel units.

Parameters:

  • x Number

    An x-coord (data units).

Returns:

Number: An x-coord (pixel units).

getPixelY

(
  • y
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:177

Converts a y-coord from data units to pixel units.

Parameters:

  • y Number

    A y-coord (data units).

Returns:

Number: A y-coord (pixel units).

hwpx

(
  • bnds
  • A
)
private

Defined in ia\maps\GoogleMap.js:516

LatLngBounds bnds -> height and width as a Point

Parameters:

  • bnds google.maps.LatLngBounds

    LatLngBounds.

  • A google.maps.Point

    google point.

init

() private

Defined in ia\maps\GoogleMap.js:100

Initialises.

mapWrapped

() Boolean private

Defined in ia\maps\GoogleMap.js:328

Checks if the IA map fits inside the google map.

Returns:

Boolean: True if it fits, otherwise false.

onIAMAPResize

() private

Defined in ia\maps\GoogleMap.js:307

Called when the IA map resizes.

removeListener

(
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:30

Removes all event listeners for the given object.

Parameters:

  • obj Object

    The object.

setBBox

(
  • bBox
)

Inherited from ia.CartesianSpace but overwritten in ia\maps\GoogleMap.js:477

Sets the bounding box.

Parameters:

setMapType

(
  • mapType
)

Defined in ia\maps\GoogleMap.js:426

Sets the map type.

Parameters:

  • mapType String

    The mapType.

updateBBox

() private

Defined in ia\maps\GoogleMap.js:443

Updates the bounding box after the bounds of the google map have changed.

updateIAMap

() private

Defined in ia\maps\GoogleMap.js:348

Updates the IA map.

zoomToFeature

(
  • featureId
)
Boolean

Defined in ia\maps\GoogleMap.js:613

Zooms to a feature in the map.

Parameters:

  • featureId String

    The id of the feature.

Returns:

Boolean: true if the feature was found, otherwise false.

zoomToFeatures

(
  • featureIds
  • optLayers
)

Defined in ia\maps\GoogleMap.js:628

Zooms to a set of features in the map.

Parameters:

  • featureIds String

    A list of feature ids.

  • optLayers ia.LayerBase[]

    An optional list of layers to check.

zoomToFeatureWithId

(
  • featureId
  • optLayers
)
Boolean

Defined in ia\maps\GoogleMap.js:560

Zooms to a feature in the map.

Parameters:

  • featureId String

    The id of the feature.

  • optLayers ia.LayerBase[]

    An optional list of layers to check.

Returns:

Boolean: true if the feature was found, otherwise false.

zoomToFeatureWithName

(
  • featureName
  • optLayers
)
Boolean

Defined in ia\maps\GoogleMap.js:586

Zooms to a feature in the map with the given name.

Parameters:

  • featureName String

    The name of the feature.

  • optLayers ia.LayerBase[]

    An optional list of layers to check.

Returns:

Boolean: true if the feature was found, otherwise false.

Properties

apiKey

String

Defined in ia\maps\GoogleMap.js:62

The google api key.

canvasHeight

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:67

The pixel height.

Default: 0

canvasWidth

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:58

The pixel width.

Default: 0

canvasX

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:40

The pixel x-position.

Default: 0

canvasY

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:49

The pixel y-position.

Default: 0

container

JQUERY Element

Defined in ia\maps\GoogleMap.js:70

The container that holds the object.

defaultBounds

ia.BoundingBox

Defined in ia\maps\GoogleMap.js:78

The map bounds - equivalent of defaultBBox.

gMap

google.maps.Map

Defined in ia\maps\GoogleMap.js:54

The google map object.

id

String

Defined in ia\maps\GoogleMap.js:86

The id.

maintainAspectRatio

Boolean

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:94

The data space will often be a different shape to the pixel space it has to fill.

If set to true the data space is adjusted to maintain the aspect ratio.

If set to false the data space stretches to fit the pixel space. This will generally result in the aspect ratio changing (a stretching effect).

Default: false

maxZoom

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:85

The maximum extent.

Default: -1

minZoom

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:76

The minimum extent.

Default: -1