MapInfo (Meridian API)

java.lang.Object
- com.arubanetworks.meridian.maps.MapInfo

```
public class MapInfo
extends java.lang.Object
```
A class to retrieve and provide read-only access to properties of a Meridian map.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MapInfo.ZoomLevel
An enumeration to qualify real world zoom levels.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MapInfo.ZoomLevel` An enumeration to qualify real world zoom levels.

Constructor Summary

Constructors
Constructor and Description

MapInfo()

Constructors
Constructor and Description
`MapInfo()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static MapInfo`	`fromClientLocationDataJSON(org.json.JSONObject json, EditorKey appKey)`
`static java.util.List<MapInfo>`	`fromJSONArray(org.json.JSONObject json, EditorKey appKey)`
`static MapInfo`	`fromJSONObject(org.json.JSONObject json, EditorKey appKey)`
`double`	`getGpsMultiplier()` Multiplier for latitude vs longitude multiplier to adjust aspect ratio (affected by distance from equator)
`android.graphics.Matrix`	`getGpsTransform()` A transform for converting between this map’s coordinate space and GPS coordinates.
`EditorKey`	`getGroupKey()` The EditorKey of the map group that this map belongs to.
`java.lang.String`	`getGroupName()` The human readable name of this map’s map group.
`double`	`getHeight()` The height of this map’s image in pixels.
`double`	`getHeightMeters()` The height of this map’s image in meters.
`android.net.Uri`	`getImageURI()` The URI of the image associated with this map.
`EditorKey`	`getKey()` The EditorKey for this map.
`int`	`getLevel()` This map’s integer floor level.
`java.lang.String`	`getLevelLabel()` A human readable name for this map’s floor.
`double`	`getMaxZoom()` The map’s maximum zoom scale.
`double`	`getMaxZoomScale()` Get the maximum zoom scale for the map.
`java.lang.String`	`getName()` This map’s human readable name.
`double`	`getNorth()` The map’s rotation as set in the editor in radians.
`double`	`getNorthOffset()` The map’s offset from magnetic northOffset in radians.
`EditorKey`	`getOverviewKey()` The EditorKey of this map’s overview map.
`android.net.Uri`	`getSvgURI()` The URI of the SVG associated with this map.
`double`	`getUnitsPerMeter()` The number of map distance units per meter.
`double`	`getWidth()` The width of this map’s image in pixels.
`double`	`getWidthMeters()` The width of this map’s image in meters.
`boolean`	`isDefaultMap()` True if it’s the default map of its location
`boolean`	`isInvalid()` True if the map is invalid
`boolean`	`isOutdoor()` Whether this map is outdoors.
`boolean`	`isPublished()` True if the map is published
`android.graphics.PointF`	`latLongToMapPoint(float latitude, float longitude)` Convert from latitude and longitude to a point on the map.
`android.graphics.PointF`	`mapPointLatLong(float x, float y)` Get the latitude and longitude of a map point.
`android.graphics.PointF`	`mapPointLatLong(int x, int y)` Deprecated. Use float version instead.
`org.json.JSONObject`	`toClientLocationDataJSON()`
`float`	`zoomLevelFromScale(double zoomScale)` Convert from scale to `MapInfo.ZoomLevel`.
`double`	`zoomScaleFromLevel(MapInfo.ZoomLevel zoomLevel)` Convert from `MapInfo.ZoomLevel` to scale.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapInfo
```
public MapInfo()
```
- Method Detail
  - fromJSONObject
```
public static MapInfo fromJSONObject(org.json.JSONObject json,
                                     EditorKey appKey)
                              throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - fromClientLocationDataJSON
```
public static MapInfo fromClientLocationDataJSON(org.json.JSONObject json,
                                                 EditorKey appKey)
                                          throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - toClientLocationDataJSON
```
public org.json.JSONObject toClientLocationDataJSON()
                                             throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - fromJSONArray
```
public static java.util.List<MapInfo> fromJSONArray(org.json.JSONObject json,
                                                    EditorKey appKey)
                                             throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - latLongToMapPoint
```
public android.graphics.PointF latLongToMapPoint(float latitude,
                                                 float longitude)
```
    Convert from latitude and longitude to a point on the map.
    
    Parameters:
    
    latitude - Latitude of the point to convert.
    
    longitude - Longitude of the point to convert.
    
    Returns:
    
    The corresponding point on the map.
  - mapPointLatLong
```
public android.graphics.PointF mapPointLatLong(int x,
                                               int y)
```
    Deprecated. Use float version instead.
    
    Get the latitude and longitude of a map point.
    
    Parameters:
    
    x - X coordinate of map point to convert.
    
    y - Y coordinate of map point to convert.
    
    Returns:
    
    The (latitude, longitude) of the map point in PointF structure.
  - mapPointLatLong
```
public android.graphics.PointF mapPointLatLong(float x,
                                               float y)
```
    Get the latitude and longitude of a map point.
    
    Parameters:
    
    x - X coordinate of map point to convert.
    
    y - Y coordinate of map point to convert.
    
    Returns:
    
    The (latitude, longitude) of the map point in PointF structure.
  - zoomLevelFromScale
```
public float zoomLevelFromScale(double zoomScale)
```
    Convert from scale to MapInfo.ZoomLevel.
    
    Parameters:
    
    zoomScale - zoom scale to convert.
    
    Returns:
    
    resulting MapInfo.ZoomLevel.
  - zoomScaleFromLevel
```
public double zoomScaleFromLevel(MapInfo.ZoomLevel zoomLevel)
```
    Convert from MapInfo.ZoomLevel to scale.
    
    Parameters:
    
    zoomLevel - MapInfo.ZoomLevel to convert.
    
    Returns:
    
    resulting zoom scale.
  - getMaxZoomScale
```
public double getMaxZoomScale()
```
    Get the maximum zoom scale for the map.
    
    Returns:
    
    resulting maximum zoom scale.
  - getKey
```
public EditorKey getKey()
```
    The EditorKey for this map.
  - getGroupKey
```
public EditorKey getGroupKey()
```
    The EditorKey of the map group that this map belongs to. This may be null.
  - getOverviewKey
```
public EditorKey getOverviewKey()
```
    The EditorKey of this map’s overview map. This may be null.
  - getImageURI
```
public android.net.Uri getImageURI()
```
    The URI of the image associated with this map. This may be null.
  - getSvgURI
```
public android.net.Uri getSvgURI()
```
    The URI of the SVG associated with this map. This may be null.
  - getLevel
```
public int getLevel()
```
    This map’s integer floor level.
  - getName
```
public java.lang.String getName()
```
    This map’s human readable name.
  - getGroupName
```
public java.lang.String getGroupName()
```
    The human readable name of this map’s map group.
  - getLevelLabel
```
public java.lang.String getLevelLabel()
```
    A human readable name for this map’s floor.
  - getWidth
```
public double getWidth()
```
    The width of this map’s image in pixels.
  - getHeight
```
public double getHeight()
```
    The height of this map’s image in pixels.
  - getWidthMeters
```
public double getWidthMeters()
```
    The width of this map’s image in meters.
  - getHeightMeters
```
public double getHeightMeters()
```
    The height of this map’s image in meters.
  - isOutdoor
```
public boolean isOutdoor()
```
    Whether this map is outdoors.
  - getGpsTransform
```
public android.graphics.Matrix getGpsTransform()
```
    A transform for converting between this map’s coordinate space and GPS coordinates.
  - getGpsMultiplier
```
public double getGpsMultiplier()
```
    Multiplier for latitude vs longitude multiplier to adjust aspect ratio (affected by distance from equator)
    
    Returns:
    
    Multiplier for latitude vs longitude multiplier to adjust aspect ratio.
  - getUnitsPerMeter
```
public double getUnitsPerMeter()
```
    The number of map distance units per meter.
  - getMaxZoom
```
public double getMaxZoom()
```
    The map’s maximum zoom scale.
  - getNorthOffset
```
public double getNorthOffset()
```
    The map’s offset from magnetic northOffset in radians.
  - getNorth
```
public double getNorth()
```
    The map’s rotation as set in the editor in radians.
  - isInvalid
```
public boolean isInvalid()
```
    True if the map is invalid
  - isDefaultMap
```
public boolean isDefaultMap()
```
    True if it’s the default map of its location
  - isPublished
```
public boolean isPublished()
```
    True if the map is published

Class MapInfo

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapInfo

Method Detail

fromJSONObject

fromClientLocationDataJSON

toClientLocationDataJSON

fromJSONArray

latLongToMapPoint

mapPointLatLong

mapPointLatLong

zoomLevelFromScale

zoomScaleFromLevel

getMaxZoomScale

getKey

getGroupKey

getOverviewKey

getImageURI

getSvgURI

getLevel

getName

getGroupName

getLevelLabel

getWidth

getHeight

getWidthMeters

getHeightMeters

isOutdoor

getGpsTransform

getGpsMultiplier

getUnitsPerMeter

getMaxZoom

getNorthOffset

getNorth

isInvalid

isDefaultMap

isPublished