Class

com.scalakml.kml

NetworkLink

Related Doc: package kml

Permalink

case class NetworkLink(featurePart: FeaturePart = new FeaturePart(), refreshVisibility: Option[Boolean] = None, flyToView: Option[Boolean] = None, link: Option[Link] = None, id: Option[String] = None, targetId: Option[String] = None, networkLinkSimpleExtensionGroup: Seq[Any] = Nil, networkLinkObjectExtensionGroup: Seq[Any] = Nil, objectSimpleExtensionGroup: Seq[Any] = Nil) extends Feature with Product with Serializable

References a KML file or KMZ archive on a local or remote network. Use the <Link> element to specify the location of the KML file. Within that element, you can define the refresh options for updating the file, based on time and camera change. NetworkLinks can be used in combination with Regions to handle very large datasets efficiently.

featurePart

the Feature part of this object

refreshVisibility

Boolean value. A value of 0 leaves the visibility of features within the control of the Google Earth user. Set the value to 1 to reset the visibility of features each time the NetworkLink is refreshed. For example, suppose a Placemark within the linked KML file has <visibility> set to 1 and the NetworkLink has <refreshVisibility> set to 1. When the file is first loaded into Google Earth, the user can clear the check box next to the item to turn off display in the 3D viewer. However, when the NetworkLink is refreshed, the Placemark will be made visible again, since its original visibility state was TRUE.

flyToView

Boolean value. A value of 1 causes Google Earth to fly to the view of the LookAt or Camera in the NetworkLinkControl (if it exists). If the NetworkLinkControl does not contain an AbstractView element, Google Earth flies to the LookAt or Camera element in the Feature child within the <kml> element in the refreshed file. If the <kml> element does not have a LookAt or Camera specified, the view is unchanged. For example, Google Earth would fly to the <LookAt> view of the parent Document, not the <LookAt> of the Placemarks contained within the Document.

link

Spcifies the location of the KML resource fetched by NetworkLink.

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

Instance Constructors

  1. new NetworkLink(featurePart: FeaturePart, refreshVisibility: Boolean, flyToView: Boolean, link: Link, id: String)

    Permalink
  2. new NetworkLink(name: String, refreshVisibility: Boolean, flyToView: Boolean, link: Link)

    Permalink
  3. new NetworkLink(name: String, refreshVisibility: Boolean, link: Link)

    Permalink
  4. new NetworkLink(name: String, link: Link)

    Permalink
  5. new NetworkLink(link: Link)

    Permalink
  6. new NetworkLink(featurePart: FeaturePart = new FeaturePart(), refreshVisibility: Option[Boolean] = None, flyToView: Option[Boolean] = None, link: Option[Link] = None, id: Option[String] = None, targetId: Option[String] = None, networkLinkSimpleExtensionGroup: Seq[Any] = Nil, networkLinkObjectExtensionGroup: Seq[Any] = Nil, objectSimpleExtensionGroup: Seq[Any] = Nil)

    Permalink

    featurePart

    the Feature part of this object

    refreshVisibility

    Boolean value. A value of 0 leaves the visibility of features within the control of the Google Earth user. Set the value to 1 to reset the visibility of features each time the NetworkLink is refreshed. For example, suppose a Placemark within the linked KML file has <visibility> set to 1 and the NetworkLink has <refreshVisibility> set to 1. When the file is first loaded into Google Earth, the user can clear the check box next to the item to turn off display in the 3D viewer. However, when the NetworkLink is refreshed, the Placemark will be made visible again, since its original visibility state was TRUE.

    flyToView

    Boolean value. A value of 1 causes Google Earth to fly to the view of the LookAt or Camera in the NetworkLinkControl (if it exists). If the NetworkLinkControl does not contain an AbstractView element, Google Earth flies to the LookAt or Camera element in the Feature child within the <kml> element in the refreshed file. If the <kml> element does not have a LookAt or Camera specified, the view is unchanged. For example, Google Earth would fly to the <LookAt> view of the parent Document, not the <LookAt> of the Placemarks contained within the Document.

    link

    Spcifies the location of the KML resource fetched by NetworkLink.

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. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  7. val featurePart: FeaturePart

    Permalink

    the Feature part of this object

    the Feature part of this object

    Definition Classes
    NetworkLinkFeature
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. val flyToView: Option[Boolean]

    Permalink

    Boolean value.

    Boolean value. A value of 1 causes Google Earth to fly to the view of the LookAt or Camera in the NetworkLinkControl (if it exists). If the NetworkLinkControl does not contain an AbstractView element, Google Earth flies to the LookAt or Camera element in the Feature child within the <kml> element in the refreshed file. If the <kml> element does not have a LookAt or Camera specified, the view is unchanged. For example, Google Earth would fly to the <LookAt> view of the parent Document, not the <LookAt> of the Placemarks contained within the Document.

  10. final def getClass(): Class[_]

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

    Permalink

    a unique identification of this KML element

    a unique identification of this KML element

    Definition Classes
    NetworkLinkFeatureKmlObject
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. val link: Option[Link]

    Permalink

    Spcifies the location of the KML resource fetched by NetworkLink.

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. val networkLinkObjectExtensionGroup: Seq[Any]

    Permalink
  16. val networkLinkSimpleExtensionGroup: Seq[Any]

    Permalink
  17. final def notify(): Unit

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

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

    Permalink
    Definition Classes
    NetworkLinkFeatureKmlObject
  20. val refreshVisibility: Option[Boolean]

    Permalink

    Boolean value.

    Boolean value. A value of 0 leaves the visibility of features within the control of the Google Earth user. Set the value to 1 to reset the visibility of features each time the NetworkLink is refreshed. For example, suppose a Placemark within the linked KML file has <visibility> set to 1 and the NetworkLink has <refreshVisibility> set to 1. When the file is first loaded into Google Earth, the user can clear the check box next to the item to turn off display in the 3D viewer. However, when the NetworkLink is refreshed, the Placemark will be made visible again, since its original visibility state was TRUE.

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

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

    Permalink

    a reference to objects that have already been loaded into Google Earth

    a reference to objects that have already been loaded into Google Earth

    Definition Classes
    NetworkLinkFeatureKmlObject
  23. final def wait(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. 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 Feature

Inherited from KmlObject

Inherited from AnyRef

Inherited from Any

Ungrouped