com.google.geo.type.viewport

Members list

Concise view

Type members

Classlikes

final case class Viewport(low: Option[LatLng], high: Option[LatLng], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Viewport]

A latitude-longitude viewport, represented as two diagonally opposite low and high points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include:

A latitude-longitude viewport, represented as two diagonally opposite low and high points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include:

  • If low = high, the viewport consists of that single point.

  • If low.longitude > high.longitude, the longitude range is inverted (the viewport crosses the 180 degree longitude line).

  • If low.longitude = -180 degrees and high.longitude = 180 degrees, the viewport includes all longitudes.

  • If low.longitude = 180 degrees and high.longitude = -180 degrees, the longitude range is empty.

  • If low.latitude > high.latitude, the latitude range is empty.

Both low and high must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error.

For example, this viewport fully encloses New York City:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Attributes

high

Required. The high point of the viewport.

low

Required. The low point of the viewport.

Companion:
object
Source:
Viewport.scala
Graph
Supertypes
trait Updatable[Viewport]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Viewport extends GeneratedMessageCompanion[Viewport]

Attributes

Companion:
class
Source:
Viewport.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Viewport]
trait Serializable
class Object
trait Matchable
class Any
Self type
object ViewportProto extends GeneratedFileObject

Attributes

Source:
ViewportProto.scala
Graph
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type