Class

com.scalakml.kml

Link

Related Doc: package kml

Permalink

case class Link(href: Option[String] = None, refreshMode: Option[RefreshMode] = None, refreshInterval: Option[Double] = None, viewRefreshMode: Option[ViewRefreshMode] = None, viewRefreshTime: Option[Double] = None, viewBoundScale: Option[Double] = None, viewFormat: Option[String] = None, httpQuery: Option[String] = None, id: Option[String] = None, targetId: Option[String] = None, linkSimpleExtensionGroup: Seq[Any] = Nil, linkObjectExtensionGroup: Seq[Any] = Nil, basicLinkSimpleExtensionGroup: Seq[Any] = Nil, basicLinkObjectExtensionGroup: Seq[Any] = Nil, objectSimpleExtensionGroup: Seq[Any] = Nil) extends BasicLinkType with Product with Serializable

specifies the location of any of the following:

When a file is fetched, the URL that is sent to the server is composed of three pieces of information:

The <Link> element replaces the <Url> element of <NetworkLink> contained in earlier KML releases and adds functionality for the <Region> element (introduced in KML 2.1). In Google Earth releases 3.0 and earlier, the <Link> element is ignored.

href

A URL (either an HTTP address or a local file specification). When the parent of <Link> is a NetworkLink, <href> is a KML file. When the parent of <Link> is a Model, <href> is a COLLADA file. When the parent of <Icon> (same fields as <Link>) is an Overlay, <href> is an image. Relative URLs can be used in this tag and are evaluated relative to the enclosing KML file. See KMZ Files for details on constructing relative references in KML and KMZ files.

refreshMode

Specifies a time-based refresh mode, which can be one of the following: onChange - refresh when the file is loaded and whenever the Link parameters change (the default). onInterval - refresh every n seconds (specified in <refreshInterval>). onExpire - refresh the file when the expiration time is reached. If a fetched file has a NetworkLinkControl, the <expires> time takes precedence over expiration times specified in HTTP headers. If no <expires> time is specified, the HTTP max-age header is used (if present). If max-age is not present, the Expires HTTP header is used (if present). (See Section RFC261b of the Hypertext Transfer Protocol - HTTP 1.1 for details on HTTP header fields.)

refreshInterval

Indicates to refresh the file every n seconds.

viewRefreshMode

Specifies how the link is refreshed when the "camera" changes. Can be one of the following: never (default) - Ignore changes in the view. Also ignore <viewFormat> parameters, if any. onStop - Refresh the file n seconds after movement stops, where n is specified in <viewRefreshTime>. onRequest - Refresh the file only when the user explicitly requests it. (For example, in Google Earth, the user right-clicks and selects Refresh in the Context menu.) onRegion - Refresh the file when the Region becomes active. See <Region>.

viewRefreshTime

After camera movement stops, specifies the number of seconds to wait before refreshing the view. (See <viewRefreshMode> and onStop above.)

viewBoundScale

Scales the BBOX parameters before sending them to the server. A value less than 1 specifies to use less than the full view (screen). A value greater than 1 specifies to fetch an area that extends beyond the edges of the current view.

viewFormat

Specifies the format of the query string that is appended to the Link's <href> before the file is fetched.(If the <href> specifies a local file, this element is ignored.) If you specify a <viewRefreshMode> of onStop and do not include the <viewFormat> tag in the file, the following information is automatically appended to the query string: BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth] This information matches the Web Map Service (WMS) bounding box specification. If you specify an empty <viewFormat> tag, no information is appended to the query string. You can also specify a custom set of viewing parameters to add to the query string. If you supply a format string, it is used instead of the BBOX information. If you also want the BBOX information, you need to add those parameters along with the custom parameters. You can use any of the following parameters in your format string (and Google Earth will substitute the appropriate current value at the time it creates the query string): [lookatLon], [lookatLat] - longitude and latitude of the point that <LookAt> is viewing [lookatRange], [lookatTilt], [lookatHeading] - values used by the <LookAt> element (see descriptions of <range>, <tilt>, and <heading> in <LookAt>) [lookatTerrainLon], [lookatTerrainLat], [lookatTerrainAlt] - point on the terrain in degrees/meters that <LookAt> is viewing [cameraLon], [cameraLat], [cameraAlt] - degrees/meters of the eyepoint for the camera [horizFov], [vertFov] - horizontal, vertical field of view for the camera [horizPixels], [vertPixels] - size in pixels of the 3D viewer [terrainEnabled] - indicates whether the 3D viewer is showing terrain

httpQuery

Appends information to the query string, based on the parameters specified. (Google Earth substitutes the appropriate current value at the time it creates the query string.) The following parameters are supported: [clientVersion] [kmlVersion] [clientName] [language]

Linear Supertypes
Serializable, Serializable, Product, Equals, BasicLinkType, KmlObject, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Link
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. BasicLinkType
  7. KmlObject
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Link(href: String, refreshMode: RefreshMode, refreshInterval: Double, viewRefreshMode: ViewRefreshMode, viewFreshTime: Double, viewBoundScale: Double, viewFormat: String, httpQuery: String, id: String)

    Permalink
  2. new Link(href: String, refreshMode: RefreshMode, refreshInterval: Double, viewRefreshMode: ViewRefreshMode, viewFreshTime: Double)

    Permalink
  3. new Link(href: String, refreshMode: RefreshMode, refreshInterval: Double)

    Permalink
  4. new Link(href: String, refreshMode: RefreshMode)

    Permalink
  5. new Link(href: String)

    Permalink
  6. new Link(href: Option[String] = None, refreshMode: Option[RefreshMode] = None, refreshInterval: Option[Double] = None, viewRefreshMode: Option[ViewRefreshMode] = None, viewRefreshTime: Option[Double] = None, viewBoundScale: Option[Double] = None, viewFormat: Option[String] = None, httpQuery: Option[String] = None, id: Option[String] = None, targetId: Option[String] = None, linkSimpleExtensionGroup: Seq[Any] = Nil, linkObjectExtensionGroup: Seq[Any] = Nil, basicLinkSimpleExtensionGroup: Seq[Any] = Nil, basicLinkObjectExtensionGroup: Seq[Any] = Nil, objectSimpleExtensionGroup: Seq[Any] = Nil)

    Permalink

    href

    A URL (either an HTTP address or a local file specification). When the parent of <Link> is a NetworkLink, <href> is a KML file. When the parent of <Link> is a Model, <href> is a COLLADA file. When the parent of <Icon> (same fields as <Link>) is an Overlay, <href> is an image. Relative URLs can be used in this tag and are evaluated relative to the enclosing KML file. See KMZ Files for details on constructing relative references in KML and KMZ files.

    refreshMode

    Specifies a time-based refresh mode, which can be one of the following: onChange - refresh when the file is loaded and whenever the Link parameters change (the default). onInterval - refresh every n seconds (specified in <refreshInterval>). onExpire - refresh the file when the expiration time is reached. If a fetched file has a NetworkLinkControl, the <expires> time takes precedence over expiration times specified in HTTP headers. If no <expires> time is specified, the HTTP max-age header is used (if present). If max-age is not present, the Expires HTTP header is used (if present). (See Section RFC261b of the Hypertext Transfer Protocol - HTTP 1.1 for details on HTTP header fields.)

    refreshInterval

    Indicates to refresh the file every n seconds.

    viewRefreshMode

    Specifies how the link is refreshed when the "camera" changes. Can be one of the following: never (default) - Ignore changes in the view. Also ignore <viewFormat> parameters, if any. onStop - Refresh the file n seconds after movement stops, where n is specified in <viewRefreshTime>. onRequest - Refresh the file only when the user explicitly requests it. (For example, in Google Earth, the user right-clicks and selects Refresh in the Context menu.) onRegion - Refresh the file when the Region becomes active. See <Region>.

    viewRefreshTime

    After camera movement stops, specifies the number of seconds to wait before refreshing the view. (See <viewRefreshMode> and onStop above.)

    viewBoundScale

    Scales the BBOX parameters before sending them to the server. A value less than 1 specifies to use less than the full view (screen). A value greater than 1 specifies to fetch an area that extends beyond the edges of the current view.

    viewFormat

    Specifies the format of the query string that is appended to the Link's <href> before the file is fetched.(If the <href> specifies a local file, this element is ignored.) If you specify a <viewRefreshMode> of onStop and do not include the <viewFormat> tag in the file, the following information is automatically appended to the query string: BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth] This information matches the Web Map Service (WMS) bounding box specification. If you specify an empty <viewFormat> tag, no information is appended to the query string. You can also specify a custom set of viewing parameters to add to the query string. If you supply a format string, it is used instead of the BBOX information. If you also want the BBOX information, you need to add those parameters along with the custom parameters. You can use any of the following parameters in your format string (and Google Earth will substitute the appropriate current value at the time it creates the query string): [lookatLon], [lookatLat] - longitude and latitude of the point that <LookAt> is viewing [lookatRange], [lookatTilt], [lookatHeading] - values used by the <LookAt> element (see descriptions of <range>, <tilt>, and <heading> in <LookAt>) [lookatTerrainLon], [lookatTerrainLat], [lookatTerrainAlt] - point on the terrain in degrees/meters that <LookAt> is viewing [cameraLon], [cameraLat], [cameraAlt] - degrees/meters of the eyepoint for the camera [horizFov], [vertFov] - horizontal, vertical field of view for the camera [horizPixels], [vertPixels] - size in pixels of the 3D viewer [terrainEnabled] - indicates whether the 3D viewer is showing terrain

    httpQuery

    Appends information to the query string, based on the parameters specified. (Google Earth substitutes the appropriate current value at the time it creates the query string.) The following parameters are supported: [clientVersion] [kmlVersion] [clientName] [language]

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val basicLinkObjectExtensionGroup: Seq[Any]

    Permalink
    Definition Classes
    LinkBasicLinkType
  6. val basicLinkSimpleExtensionGroup: Seq[Any]

    Permalink
    Definition Classes
    LinkBasicLinkType
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. val href: Option[String]

    Permalink

    A URL (either an HTTP address or a local file specification).

    A URL (either an HTTP address or a local file specification). When the parent of <Link> is a NetworkLink, <href> is a KML file. When the parent of <Link> is a Model, <href> is a COLLADA file. When the parent of <Icon> (same fields as <Link>) is an Overlay, <href> is an image. Relative URLs can be used in this tag and are evaluated relative to the enclosing KML file. See KMZ Files for details on constructing relative references in KML and KMZ files.

    Definition Classes
    LinkBasicLinkType
  12. val httpQuery: Option[String]

    Permalink

    Appends information to the query string, based on the parameters specified.

    Appends information to the query string, based on the parameters specified. (Google Earth substitutes the appropriate current value at the time it creates the query string.) The following parameters are supported: [clientVersion] [kmlVersion] [clientName] [language]

  13. val id: Option[String]

    Permalink
    Definition Classes
    LinkBasicLinkTypeKmlObject
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. val linkObjectExtensionGroup: Seq[Any]

    Permalink
  16. val linkSimpleExtensionGroup: Seq[Any]

    Permalink
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. val objectSimpleExtensionGroup: Seq[Any]

    Permalink
    Definition Classes
    LinkBasicLinkTypeKmlObject
  21. val refreshInterval: Option[Double]

    Permalink

    Indicates to refresh the file every n seconds.

  22. val refreshMode: Option[RefreshMode]

    Permalink

    Specifies a time-based refresh mode, which can be one of the following: onChange - refresh when the file is loaded and whenever the Link parameters change (the default).

    Specifies a time-based refresh mode, which can be one of the following: onChange - refresh when the file is loaded and whenever the Link parameters change (the default). onInterval - refresh every n seconds (specified in <refreshInterval>). onExpire - refresh the file when the expiration time is reached. If a fetched file has a NetworkLinkControl, the <expires> time takes precedence over expiration times specified in HTTP headers. If no <expires> time is specified, the HTTP max-age header is used (if present). If max-age is not present, the Expires HTTP header is used (if present). (See Section RFC261b of the Hypertext Transfer Protocol - HTTP 1.1 for details on HTTP header fields.)

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. val targetId: Option[String]

    Permalink
    Definition Classes
    LinkBasicLinkTypeKmlObject
  25. val viewBoundScale: Option[Double]

    Permalink

    Scales the BBOX parameters before sending them to the server.

    Scales the BBOX parameters before sending them to the server. A value less than 1 specifies to use less than the full view (screen). A value greater than 1 specifies to fetch an area that extends beyond the edges of the current view.

  26. val viewFormat: Option[String]

    Permalink

    Specifies the format of the query string that is appended to the Link's <href> before the file is fetched.(If the <href> specifies a local file, this element is ignored.) If you specify a <viewRefreshMode> of onStop and do not include the <viewFormat> tag in the file, the following information is automatically appended to the query string: BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth] This information matches the Web Map Service (WMS) bounding box specification.

    Specifies the format of the query string that is appended to the Link's <href> before the file is fetched.(If the <href> specifies a local file, this element is ignored.) If you specify a <viewRefreshMode> of onStop and do not include the <viewFormat> tag in the file, the following information is automatically appended to the query string: BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth] This information matches the Web Map Service (WMS) bounding box specification. If you specify an empty <viewFormat> tag, no information is appended to the query string. You can also specify a custom set of viewing parameters to add to the query string. If you supply a format string, it is used instead of the BBOX information. If you also want the BBOX information, you need to add those parameters along with the custom parameters. You can use any of the following parameters in your format string (and Google Earth will substitute the appropriate current value at the time it creates the query string): [lookatLon], [lookatLat] - longitude and latitude of the point that <LookAt> is viewing [lookatRange], [lookatTilt], [lookatHeading] - values used by the <LookAt> element (see descriptions of <range>, <tilt>, and <heading> in <LookAt>) [lookatTerrainLon], [lookatTerrainLat], [lookatTerrainAlt] - point on the terrain in degrees/meters that <LookAt> is viewing [cameraLon], [cameraLat], [cameraAlt] - degrees/meters of the eyepoint for the camera [horizFov], [vertFov] - horizontal, vertical field of view for the camera [horizPixels], [vertPixels] - size in pixels of the 3D viewer [terrainEnabled] - indicates whether the 3D viewer is showing terrain

  27. val viewRefreshMode: Option[ViewRefreshMode]

    Permalink

    Specifies how the link is refreshed when the "camera" changes.

    Specifies how the link is refreshed when the "camera" changes. Can be one of the following: never (default) - Ignore changes in the view. Also ignore <viewFormat> parameters, if any. onStop - Refresh the file n seconds after movement stops, where n is specified in <viewRefreshTime>. onRequest - Refresh the file only when the user explicitly requests it. (For example, in Google Earth, the user right-clicks and selects Refresh in the Context menu.) onRegion - Refresh the file when the Region becomes active. See <Region>.

  28. val viewRefreshTime: Option[Double]

    Permalink

    After camera movement stops, specifies the number of seconds to wait before refreshing the view.

    After camera movement stops, specifies the number of seconds to wait before refreshing the view. (See <viewRefreshMode> and onStop above.)

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from BasicLinkType

Inherited from KmlObject

Inherited from AnyRef

Inherited from Any

Ungrouped