Class

com.scalakml.kml

FeaturePart

Related Doc: package kml

Permalink

case class FeaturePart(name: Option[String] = None, visibility: Option[Boolean] = None, open: Option[Boolean] = None, atomAuthor: Option[Author] = None, atomLink: Option[atom.Link] = None, address: Option[String] = None, addressDetails: Option[AddressDetails] = None, phoneNumber: Option[String] = None, extendedData: Option[ExtendedData] = None, description: Option[String] = None, snippet: Option[Snippet] = None, abstractView: Option[AbstractView] = None, timePrimitive: Option[TimePrimitive] = None, styleUrl: Option[String] = None, styleSelector: Seq[StyleSelector] = Nil, region: Option[Region] = None, featureSimpleExtensionGroup: Seq[Any] = Nil, featureObjectExtensionGroup: Seq[Any] = Nil) extends Product with Serializable

This is a base class and cannot be used directly in a KML file. FeaturePart is a field in the Feature trait. That trait is extended by: Document, Folder, Placemark, NetworkLink, PhotoOverlay, ScreenOverlay, GroundOverlay, Tour. In these classes FeaturePart is a component field. Note: do not confuse FeaturePart and a Feature that encapsulate it, that is the concrete classes that extend Feature trait.

name

User-defined text displayed in the 3D viewer as the label for the object (for example, for a Placemark, Folder, or NetworkLink).

visibility

Specifies whether the feature is drawn in the 3D viewer when it is initially loaded. In order for a feature to be visible, the visibility of all its ancestors must also be set to true. Defaults to true.

open

Specifies whether a Document or Folder appears closed or open when first loaded into the Places panel. False=collapsed (the default), true=expanded. This element applies only to Document, Folder, and NetworkLink.

atomAuthor

KML "2.2" supports new elements for including data about the author and related website in your KML file. This information is displayed in geo search results, both in Earth browsers such as Google Earth, and in other applications such as Google Maps. The ascription elements used in KML are as follows:

  • atom:author element - parent element for atom:name
  • atom:name element - the name of the author
  • atom:link element - contains the href attribute
  • href attribute - URL of the web page containing the KML/KMZ file These elements are defined in the Atom Syndication Format. The complete specification is found at http://atompub.org. The <atom:author> element is the parent element for <atom:name&gt, which specifies the author of the KML feature.
atomLink

Specifies the URL of the website containing this KML or KMZ file. Implementation note: Be sure to include the namespace for this element in any KML file that uses it: xmlns:atom="http://www.w3.org/2005/Atom" .

address

A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the

tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if a is provided, it takes precedence over the
.) To find out which locales are supported for this tag in Google Earth, go to the Google Maps Help.

addressDetails

A string value representing a telephone number. This element is used by Google Maps Mobile only. The industry standard for Java-enabled cellular phones is RFC2806. For more information, see http://www.ietf.org/rfc /rfc2806.txt.

phoneNumber

A string value representing a telephone number. This element is used by Google Maps Mobile only. The industry standard for Java-enabled cellular phones is RFC2806. For more information, see http://www.ietf.org/rfc /rfc2806.txt.

extendedData

Allows you to add custom data to a KML file. This data can be:

  • (1) data that references an external XML schema,
  • (2) untyped data/value pairs, or
  • (3) typed data. A given KML Feature can contain a combination of these types of custom data.
description

User-supplied content that appears in the description balloon. The supported content for the <description> element changed from Google Earth 4.3 to 5.0. See the on-line documentation for extensive details.

snippet

A short description of the feature. In Google Earth, this description is displayed in the Places panel under the name of the feature. If a Snippet is not supplied, the first two lines of the <description> are used. In Google Earth, if a Placemark contains both a description and a Snippet, the <Snippet> appears beneath the Placemark in the Places panel, and the <description> appears in the Placemark's description balloon. This tag does not support HTML markup. <Snippet> has a maxLines attribute, an integer that specifies the maximum number of lines to display.

abstractView

Defines a viewpoint associated with any element derived from Feature.

timePrimitive

Associates this Feature with a period of time (<TimeSpan>) or a point in time (<TimeStamp>).

styleUrl

URL of a <Style> or <StyleMap> defined in a Document. If the style is in the same file, use a # reference. If the style is defined in an external file, use a full URL along with # referencing.

styleSelector

One or more Styles and StyleMaps can be defined to customize the appearance of any element derived from Feature or of the Geometry in a Placemark. A style defined within a Feature is called an "inline style" and applies only to the Feature that contains it. A style defined as the child of a <Document> is called a "shared style." A shared style must have an id defined for it. This id is referenced by one or more Features within the <Document>. In cases where a style element is defined both in a shared style and in an inline style for a Feature—that is, a Folder, GroundOverlay, NetworkLink, Placemark, or ScreenOverlay—the value for the Feature's inline style takes precedence over the value for the shared style.

region

Features and geometry associated with a Region are drawn only when the Region is active.

featureSimpleExtensionGroup

Simple Element Substitution. This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the <Update> mechanism is to be used.

featureObjectExtensionGroup

Complex Element Substitution. This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the <Update> mechanism is to be used.

See also

BalloonStyle, ListStyle, StyleSelector, ColorStyle

Camera and LookAt

ListStyle

Feature

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

Instance Constructors

  1. new FeaturePart(name: String, visibility: Boolean, open: Boolean, atomAuthor: Author, atomLink: atom.Link, address: String, addressDetails: AddressDetails, phoneNumber: String, extendedData: ExtendedData, description: String, snippet: Snippet, abstractView: AbstractView, timePrimitive: TimePrimitive, styleUrl: String, styleSelector: Seq[StyleSelector], region: Region)

    Permalink
  2. new FeaturePart(name: String, visibility: Boolean)

    Permalink
  3. new FeaturePart(name: String)

    Permalink
  4. new FeaturePart(name: Option[String] = None, visibility: Option[Boolean] = None, open: Option[Boolean] = None, atomAuthor: Option[Author] = None, atomLink: Option[atom.Link] = None, address: Option[String] = None, addressDetails: Option[AddressDetails] = None, phoneNumber: Option[String] = None, extendedData: Option[ExtendedData] = None, description: Option[String] = None, snippet: Option[Snippet] = None, abstractView: Option[AbstractView] = None, timePrimitive: Option[TimePrimitive] = None, styleUrl: Option[String] = None, styleSelector: Seq[StyleSelector] = Nil, region: Option[Region] = None, featureSimpleExtensionGroup: Seq[Any] = Nil, featureObjectExtensionGroup: Seq[Any] = Nil)

    Permalink

    name

    User-defined text displayed in the 3D viewer as the label for the object (for example, for a Placemark, Folder, or NetworkLink).

    visibility

    Specifies whether the feature is drawn in the 3D viewer when it is initially loaded. In order for a feature to be visible, the visibility of all its ancestors must also be set to true. Defaults to true.

    open

    Specifies whether a Document or Folder appears closed or open when first loaded into the Places panel. False=collapsed (the default), true=expanded. This element applies only to Document, Folder, and NetworkLink.

    atomAuthor

    KML "2.2" supports new elements for including data about the author and related website in your KML file. This information is displayed in geo search results, both in Earth browsers such as Google Earth, and in other applications such as Google Maps. The ascription elements used in KML are as follows:

    • atom:author element - parent element for atom:name
    • atom:name element - the name of the author
    • atom:link element - contains the href attribute
    • href attribute - URL of the web page containing the KML/KMZ file These elements are defined in the Atom Syndication Format. The complete specification is found at http://atompub.org. The <atom:author> element is the parent element for <atom:name&gt, which specifies the author of the KML feature.
    atomLink

    Specifies the URL of the website containing this KML or KMZ file. Implementation note: Be sure to include the namespace for this element in any KML file that uses it: xmlns:atom="http://www.w3.org/2005/Atom" .

    address

    A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the

    tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if a is provided, it takes precedence over the
    .) To find out which locales are supported for this tag in Google Earth, go to the Google Maps Help.

    addressDetails

    A string value representing a telephone number. This element is used by Google Maps Mobile only. The industry standard for Java-enabled cellular phones is RFC2806. For more information, see http://www.ietf.org/rfc /rfc2806.txt.

    phoneNumber

    A string value representing a telephone number. This element is used by Google Maps Mobile only. The industry standard for Java-enabled cellular phones is RFC2806. For more information, see http://www.ietf.org/rfc /rfc2806.txt.

    extendedData

    Allows you to add custom data to a KML file. This data can be:

    • (1) data that references an external XML schema,
    • (2) untyped data/value pairs, or
    • (3) typed data. A given KML Feature can contain a combination of these types of custom data.
    description

    User-supplied content that appears in the description balloon. The supported content for the <description> element changed from Google Earth 4.3 to 5.0. See the on-line documentation for extensive details.

    snippet

    A short description of the feature. In Google Earth, this description is displayed in the Places panel under the name of the feature. If a Snippet is not supplied, the first two lines of the <description> are used. In Google Earth, if a Placemark contains both a description and a Snippet, the <Snippet> appears beneath the Placemark in the Places panel, and the <description> appears in the Placemark's description balloon. This tag does not support HTML markup. <Snippet> has a maxLines attribute, an integer that specifies the maximum number of lines to display.

    abstractView

    Defines a viewpoint associated with any element derived from Feature.

    timePrimitive

    Associates this Feature with a period of time (<TimeSpan>) or a point in time (<TimeStamp>).

    styleUrl

    URL of a <Style> or <StyleMap> defined in a Document. If the style is in the same file, use a # reference. If the style is defined in an external file, use a full URL along with # referencing.

    styleSelector

    One or more Styles and StyleMaps can be defined to customize the appearance of any element derived from Feature or of the Geometry in a Placemark. A style defined within a Feature is called an "inline style" and applies only to the Feature that contains it. A style defined as the child of a <Document> is called a "shared style." A shared style must have an id defined for it. This id is referenced by one or more Features within the <Document>. In cases where a style element is defined both in a shared style and in an inline style for a Feature—that is, a Folder, GroundOverlay, NetworkLink, Placemark, or ScreenOverlay—the value for the Feature's inline style takes precedence over the value for the shared style.

    region

    Features and geometry associated with a Region are drawn only when the Region is active.

    featureSimpleExtensionGroup

    Simple Element Substitution. This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the <Update> mechanism is to be used.

    featureObjectExtensionGroup

    Complex Element Substitution. This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the <Update> mechanism is to be used.

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. val abstractView: Option[AbstractView]

    Permalink

    Defines a viewpoint associated with any element derived from Feature.

  5. def addToStyleSelector(value: StyleSelector): FeaturePart

    Permalink

    returns a new object with value added to the sequence

    returns a new object with value added to the sequence

    value

    to add to styleSelector

    returns

    a new FeaturePart with value added to the sequence of styleSelector

  6. val address: Option[String]

    Permalink

    A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code.

    A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the

    tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if a is provided, it takes precedence over the
    .) To find out which locales are supported for this tag in Google Earth, go to the Google Maps Help.

  7. val addressDetails: Option[AddressDetails]

    Permalink

    A string value representing a telephone number.

    A string value representing a telephone number. This element is used by Google Maps Mobile only. The industry standard for Java-enabled cellular phones is RFC2806. For more information, see http://www.ietf.org/rfc /rfc2806.txt.

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. val atomAuthor: Option[Author]

    Permalink

    KML "2.2" supports new elements for including data about the author and related website in your KML file.

    KML "2.2" supports new elements for including data about the author and related website in your KML file. This information is displayed in geo search results, both in Earth browsers such as Google Earth, and in other applications such as Google Maps. The ascription elements used in KML are as follows:

    • atom:author element - parent element for atom:name
    • atom:name element - the name of the author
    • atom:link element - contains the href attribute
    • href attribute - URL of the web page containing the KML/KMZ file These elements are defined in the Atom Syndication Format. The complete specification is found at http://atompub.org. The <atom:author> element is the parent element for <atom:name&gt, which specifies the author of the KML feature.
  10. val atomLink: Option[atom.Link]

    Permalink

    Specifies the URL of the website containing this KML or KMZ file.

    Specifies the URL of the website containing this KML or KMZ file. Implementation note: Be sure to include the namespace for this element in any KML file that uses it: xmlns:atom="http://www.w3.org/2005/Atom" .

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. val description: Option[String]

    Permalink

    User-supplied content that appears in the description balloon.

    User-supplied content that appears in the description balloon. The supported content for the <description> element changed from Google Earth 4.3 to 5.0. See the on-line documentation for extensive details.

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. val extendedData: Option[ExtendedData]

    Permalink

    Allows you to add custom data to a KML file.

    Allows you to add custom data to a KML file. This data can be:

    • (1) data that references an external XML schema,
    • (2) untyped data/value pairs, or
    • (3) typed data. A given KML Feature can contain a combination of these types of custom data.
  15. val featureObjectExtensionGroup: Seq[Any]

    Permalink

    Complex Element Substitution.

    Complex Element Substitution. This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the <Update> mechanism is to be used.

  16. val featureSimpleExtensionGroup: Seq[Any]

    Permalink

    Simple Element Substitution.

    Simple Element Substitution. This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the <Update> mechanism is to be used.

  17. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. val name: Option[String]

    Permalink

    User-defined text displayed in the 3D viewer as the label for the object (for example, for a Placemark, Folder, or NetworkLink).

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

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

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

    Permalink
    Definition Classes
    AnyRef
  24. val open: Option[Boolean]

    Permalink

    Specifies whether a Document or Folder appears closed or open when first loaded into the Places panel.

    Specifies whether a Document or Folder appears closed or open when first loaded into the Places panel. False=collapsed (the default), true=expanded. This element applies only to Document, Folder, and NetworkLink.

  25. val phoneNumber: Option[String]

    Permalink

    A string value representing a telephone number.

    A string value representing a telephone number. This element is used by Google Maps Mobile only. The industry standard for Java-enabled cellular phones is RFC2806. For more information, see http://www.ietf.org/rfc /rfc2806.txt.

  26. val region: Option[Region]

    Permalink

    Features and geometry associated with a Region are drawn only when the Region is active.

  27. val snippet: Option[Snippet]

    Permalink

    A short description of the feature.

    A short description of the feature. In Google Earth, this description is displayed in the Places panel under the name of the feature. If a Snippet is not supplied, the first two lines of the <description> are used. In Google Earth, if a Placemark contains both a description and a Snippet, the <Snippet> appears beneath the Placemark in the Places panel, and the <description> appears in the Placemark's description balloon. This tag does not support HTML markup. <Snippet> has a maxLines attribute, an integer that specifies the maximum number of lines to display.

  28. val styleSelector: Seq[StyleSelector]

    Permalink

    One or more Styles and StyleMaps can be defined to customize the appearance of any element derived from Feature or of the Geometry in a Placemark.

    One or more Styles and StyleMaps can be defined to customize the appearance of any element derived from Feature or of the Geometry in a Placemark. A style defined within a Feature is called an "inline style" and applies only to the Feature that contains it. A style defined as the child of a <Document> is called a "shared style." A shared style must have an id defined for it. This id is referenced by one or more Features within the <Document>. In cases where a style element is defined both in a shared style and in an inline style for a Feature—that is, a Folder, GroundOverlay, NetworkLink, Placemark, or ScreenOverlay—the value for the Feature's inline style takes precedence over the value for the shared style.

  29. val styleUrl: Option[String]

    Permalink

    URL of a <Style> or <StyleMap> defined in a Document.

    URL of a <Style> or <StyleMap> defined in a Document. If the style is in the same file, use a # reference. If the style is defined in an external file, use a full URL along with # referencing.

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

    Permalink
    Definition Classes
    AnyRef
  31. val timePrimitive: Option[TimePrimitive]

    Permalink

    Associates this Feature with a period of time (<TimeSpan>) or a point in time (<TimeStamp>).

  32. val visibility: Option[Boolean]

    Permalink

    Specifies whether the feature is drawn in the 3D viewer when it is initially loaded.

    Specifies whether the feature is drawn in the 3D viewer when it is initially loaded. In order for a feature to be visible, the visibility of all its ancestors must also be set to true. Defaults to true.

  33. final def wait(): Unit

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

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

Inherited from Any

Ungrouped