addPolygon: Add Polygon features to a kml

In brent0/kmlbuilder: Build KML Files from Data Frames

Add Polygon features to a kml

Description

After creating a kml object, you can add Polygon features with this function so they are viewable in the graphics window of the google API. A data-frame x must be supplied to this function to define the the polygons and geography. A second data-frame y may also be supplied to define an inner region of a polygon for cutting out. At a minimum, x and y must contain columns pid, lat and lon. Each unique pid represents an individual Polygon. To style these features, use addLineStyle and match styleid to styleUrl.

Usage

yourKMLobj$addPolygon(x)
yourKMLobj$addLineString(x, y, altitude, styleUrl)

Arguments

x	Mandatory. A data-frame with columns pid, lat and lon. There must be 3 or more records for each unique pid. x may also contain additional columns. All of the listed optional arguments can be supplied in the function call to apply to records of x, or can be a column of x(column name = argument name) with unique values at each unique pid to apply to that LineString only.
y	A data-frame with columns pid, lat and lon that define an inner region to remove from polygons in x, matched on pid. There must be 3 or more records for each unique pid.
altitude	numeric with 1 or more elements cycled by pid. Meters above/below altiudeMode. 'clamp' altitudeModes ignore altitude. (Default: 0)
extrude	boolean (0-not extrude or 1-extrude) with 1 or more elements cycled by pid. Choose weather to extrude(connect) the LineString to the ground. If you wish to extrude, altitudeMode must be one of relativeToGround, relativeToSeaFloor, or absolute. (Default: 1)
tessellate	boolean (0-not tessellate or 1-tessellate) with 1 or more elements cycled by pid. Choose weather Polygon will tessellate(follow terrain). If you wish to tessellate, altitudeMode must be one of clampToGround or clampToSeaFloor. (Default: 1)
altitudeMode	character with 1 or more elements cycled by pid, one of "clampToGround", "relativeToGround", "absolute", "clampToSeaFloor", "relativeToSeaFloor". (Default:"clampToGround")
name	character with 1 or more elements cycled by pid, what the feature will be called in the graphics environment. (Default:NULL)
visibility	boolean (0-invisible or 1-visible) with 1 or more elements cycled by pid. Specify if this feature will be visible. (Default: 1)
open	boolean (0-closed or 1-open) with 1 or more elements cycled by pid. Specify if the feature is open or closed in the kml object tree. (Default: 0)
atomauthor	character with 1 or more elements cycled by pid, text identifying an author relevant to the topic. See Ascription Elements under References(Default: NULL)
atomlinkhref	character with 1 or more elements cycled by pid, text identifying a web link relevant to the topic. See Ascription Elements under References (Default: NULL)
address	character with 1 or more elements cycled by pid, specify an unstructured address that is associated with the polygon. (Default:NULL)
xalAddressDetails	character with 1 or more elements cycled by pid, specify a structured address in eXtensible Address Language(See xal:AddressDetails under References) that is associated with the polygon. (Default:NULL)
phoneNumber	character with 1 or more elements cycled by pid, represent a phone number, useful for mobile apps. (Default:NULL)
Snippet	character with 1 or more elements cycled by pid, supply details in addition to description. (Default:NULL)
description	character with 1 or more elements cycled by pid, supply details relevant to the feature. May contain CDATA. See NOTES section for more info. (Default:NULL)
AbstractView	character with 1 or more elements cycled by pid, the id of the desired AbstractView. Must create AbstractView with addAbstractView() function. (Default:NULL)
TimeStamp	character with 1 or more elements cycled by pid, define a moment of date-time in one of the following formats: (YYYY)(YYYY-MM)(YYYY-MM-DD)(YYYY-MM-DDThh:mm:ssZ)(YYYY-MM-DDThh:mm:ss). Used to create kml time-series. (Default:NULL)
TimeSpanStart	character with 1 or more elements cycled by pid, define the start of a span of date-time in one of the following formats(overrides TimeStamp): (YYYY)(YYYY-MM)(YYYY-MM-DD)(YYYY-MM-DDThh:mm:ssZ)(YYYY-MM-DDThh:mm:ss). Used to create time-series. (Default:NULL)
TimeSpanEnd	character with 1 or more elements cycled by pid, define the end of a span of date-time in one of the following formats(overrides TimeStamp): (YYYY)(YYYY-MM)(YYYY-MM-DD)(YYYY-MM-DDThh:mm:ssZ)(YYYY-MM-DDThh:mm:ss). Used to create time-series. (Default:NULL)
styleUrl	character with 1 or more elements cycled by pid, the id of the desired Style. Must create a style with one of the addStyle() or interactiveStyle() functions. (Default:NULL)
Region	Currently not supported
ExtendedData	Currently not supported
inFolder	Allows the adding of data to a specified folder, (EXPERIMENTAL) Usage: inFolder = 'this\that'

You can add styles directly by defining any of the following variables. This is however discouraged as a new style is created for each row of x. These will be ignored if styleid is defined.

icon_color, icon_href, icon_transparency, icon_scale, icon_heading, icon_xunits, icon_x, icon_yunits, icon_y, icon_colorMode, bal_bgColor, bal_textColor, bal_text, bal_displayMode, label_color, label_transparency, label_colorMode, label_scale, line_color, line_transparency, line_width, line_outerColor, line_outerTransparency, line_outerPortion, line_colorMode, line_labelVisibility

You can define these but it is POOR FORM!!! see icon, balloon, label, and line style documentation for values.

Note

description
For advanced description arguments, wrap html in CDATA tags. You can use packages to build html such as R2HTML(uses headers that are not required by CDATA) or, if you are comfortable with html, just add your html text inside CDATA enclosures.
text = ''<!\[CDATA\[
<b><font color="#CC0000" size='+3'>Example Text</font></b>
<br/><br/>
<font face='Courier'>Example Text</font>
]]>''

See also: Description Example

Author(s)

Brent Cameron
Department of Fisheries and Oceans Canada
Population Ecology Division

References

KML polygon Reference
Ascription Elements
xal:AddressDetails

Examples

mykml = RKmlObject()

pid = c(1, 1, 1, 2, 2, 2, 6, 6, 6, 6)
lat = c(44, 44.1, 44, 44.2, 44.2, 44.1, 44, 44.1, 44.1, 44)
lon = c(-60, -59.9, -59.8, -60.2, -60.1, -60, -60.5, -60.5, -60.2, -60.2)
altitude=c(2000,2000,4000,4000,5000,2000,0,0,0,0)
x = cbind(pid, lat, lon, altitude)

mykml$addPolygon(x)

  
#Create styles
mykml$addPolyStyle(styleid = "polystyle1", color = "red", transparency = .5)
mykml$addPolyStyle(styleid = "polystyle2", color = "yellow", transparency = 1, fill = 0)
mykml$addPolyStyle(styleid = "polystyle3", color = "yellow", transparency = 1, outline = 0)

#Shift lats up to see style applied next to non style
lat = lat + .2

x = cbind(pid, lat, lon)

style = c("polystyle1", "polystyle2", "polystyle3") #Cycles with pid
##Add altitude
altitude = c(2000, 4000, 8000) #Cycles with pid
mykml$addPolygon(x, styleUrl = style, altitude = altitude)

##All optional arguments can be supplied in the function call and will cycle by pid
#mykml$preview()

brent0/kmlbuilder documentation built on Feb. 2, 2024, 2:05 a.m.