<< Click to Display Table of Contents >>

KML.js

 

 

Namespace

OGC.KML



Class

_altitudeModeType()






Enum

altitudeModeEnumType




(clampToGround,


define elevation type as clampToGround.


relativeToGround,


define elevation type as releativeToGround.


absolute)


define elevation type as absolute.









Class

coordinateType(string Text)

control the coordinates.

Method

number

getX()

return x coordinate.

Method

void

setX(number v)

set x coordinate.

Method

number

getY()

return y coordinate.

Method

void

setY(number v)

set y coordinate.

Method

number

getZ()

return z coordinate.

Method

void

setZ(number v)

set z coordinate.

Method

Point

GetPoint()

return point object.





Class

coordinatesType(object Elem)


return coord object.





Enum

colorModeEnumType




(normal,


define the color mode as normal.


random)


define the color mode as random.





Enum

displayModeEnumType




(default,


define the display mode as default.


hide)


define the display mode as hide.





Enum

gridOriginEnumType




(lowerLeft,


define the grid origin as lowerLeft.


upperLeft)


define the grid origin as upperLeft.





Class

itemIconState

Type(object Elem)

controls the icon state.





Enum

itemIconStateEnumType




(open,


define the item icon state as open.


closed,


define the item icon state as closed.


error,


define the item icon state as error.


fetching0,


define the item icon state as fetching0.


fetching1,


define the item icon state as fetching1.


fetching2)


define the item icon state as fetching2.





Enum

listItemTypeEnumType




(radioFolder,


define the list item type as radioFolder.


check,


define the list item type as check.


checkHideChildren,


define the list item type as checkHideChildren.


checkOffOnly)


define the list item type as checkOffOnly.





Enum

refreshModeEnumType




(onChange,


define the refresh mode as onChange.


onNumbererval,


define the refresh mode as onNumbererval.


onExpire)


define the refresh mode as onExpire.





Enum

viewRefreshModeEnum




(never,


define the view refresh mode as never.


onRequest,


define the view refresh mode as onRequest.


onStop,


define the view refresh mode as onStop.


onRegion)


define the view refresh mode as onRegion.





Enum

shpaeEnumType




(rectangle,


define the shape as rectangle.


cylinder,


define the shape as cylinder.


sphere)


define the shape as sphere.





Enum

styleStateEnumType




(normal,


define style as normal.


highlight)


define style as highlight.





Enum

unitsEnumType




(fraction,


define units as fraction.


pixels,


define units as pixels.


insetPixels,


define units as insetPixels.


pixel)


define units as pixel.





Enum

timeResolutionEnum




(second,


define time resolution as second.


day,


define time resolution as day.


month,


define time resolution as month.


year)


define time resolution as year.





Class

vec2Type(object Elem)


Method

number

getX()

return the x coordinate.

Method

void

setX(number v)

set the x coordinate.

Method

number

getY()

return the y coordinate.

Method

void

setY(number v)

set the y coordinate.

Method

xunits

getXunit()

return the unit of the x coordinate.

Method

yunits

getYunit()

return the unit of the y coordinate.

Method

number

getFraction(number v, number r, number u)


Method

number

getFractionXY(number w, number h)

return the fraction of width and height.





Property

_FeatureSimpleExtension







Class

KmlType(object Elem)

control the kml type.

Method

NetworkLinkControl

getNetworkLinkControl()

return NetworkLinkControl.

Method

Feature

get_Feature()

return Feature.

Method

void

Initialize(object KML)






Class

SnippetType(object Elem)







Class

ExtendedDataType(object Elem)


Method

Data

getData()

return data.

Method

SchemaData

getSchemaData()

return schema data.





Class

SimpleDataType(object Elem)







Class

NetworkLinkControlType(object Elem)







Class

SchemaType(object Elem)







Class

SimpleFieldType(object Elem)











Class

BoundaryType(object Elem)


Method

LinearRing

getLinearRing()

return linear ring.





Class

UpdateType(object Elem)


Method

targetHref

getTargetHref()

return TargetHref.

Method

Operator

getOperator()

return Operator.





Class

_Operator()







Class

CreateType(object Elem)






Class

DeleteType(object Elem)






Class

_ObjectType(object Elem, funcElemProc)

control object

Method

id

getID()

return object id.

Method

targetId

getTargetID()

return target object id.





Class

_FeatureType(object Elem, funcElemProc)


Method

name

getName()

return feature name.

Method

visibility

getVisibility()

return feature visibility.

Method

void

setVisibility()

set feature visibility.

Method

address

getAddress()

return feature address.

Method

description

getDescription()

return feature description.

Method

ExtendedData

getExtendedData()

return feature extended data.

Method

styleUrl

getStyleUrl()

return feature styleUrl

Method

View

getView()

reture feature view.

Method

TimePrimitive

getTimePrimitive()

reture feature TimePrimitive.





Class

_ContainerType(object Elem, funcElemProc)


Method

Feature

get_Feature()

return feature.





Class

DocumentType(object Elem)







Class

FolderType(object Elem)







Class

_OverlayType(object Elem, funcElemProc)


Method

Icon

getIcon()

return icon.

Method

color

getColor()

return color.





Class

GroundOverlayType(object Elem)


Method

altitude

getAltitude()

return altitude.

Method

altitudeMode

getAltitudeMode()

return altitude mode.

Method

LatLonBox

getLatLonBox()

return a box defined by specific latitude and longitude.





Class

ScreenOverlayType(object Elem)


Method

overlayXY

getOverlayXY()

return the overlay coordinates which is a point on (or outside of) the overlay image that is mapped to the screen coordinate.

Method

screenXY

getScreenXY()

return the screen coordinates, which is a point relative to the screen origin that the overlay image is mapped to.

Method

rotationXY

getRotationXY()

return rotationXY, which is the point relative to the screen about which the screen overlay is rotated.

Method

size

getSize()

return size fo the image for the screen overlay as follows: A value of −1 indicates to use the native dimension; A value of 0 indicates to maintain the aspect ratio; A value of n sets the value of the dimension

Method

rotation

getRotation()

return rotation which indicates the angle of rotation of the parent object.





Class

PhotoOverlayType(object Elem)


Method

rotation

getRotation()

return rotation of the photo. Adjusts how the photo is placed inside the field of view. This element is useful if your photo has been rotated and deviates slightly from a desired horizontal view.

Method

ViewVolume

getViewVolume()

Defines how much of the current scene is visible. Specifying the?field of view?is analogous to specifying the lens opening in a physical camera. A small field of view, like a telephoto lens, focuses on a small part of the scene. A large field of view, like a wide-angle lens, focuses on a large part of the scene.

Method

ImagePyramid

getImagePyramid()

return ImagePyramid.

Method

Point

getPoint()

return Point.

Method

shape

getShape()

return shape.

Method

NormalStyle

getNormalStyle()

return NormalStyle object.

Method

HighlightStyle

getHighlightStyle()

return HighlightStyle object.





Class

PlacemarkType(object Elem)


Method

Geometry

get_Geometry()

return geometry of the place mark.

Method

NormalStyle

getNormalStyle()

return NormalStyle object.

Method

HighlightStyle

getHighlightStyle()

return HighlightStyle object.





Class

NetworkLinkType(object Elem)


Method

Object

getObject()

return Object.





Class

_ViewType(object Elem, funcElemProc)


Method

ViewSimpleExtension

get_ViewSimpleExtension()

return ViewSimpleExtension object.

Method

ViewObjectExtension

get_ViewObjectExtension()

return ViewObjectExtension object.





Class

_ViewSimpleExtension()







Class

_ViewObjectExtension()







Class

LookAtType(object Elem)


Method

longitude

getLongitude()

return the longitude of LookAt.

Method

latitude

getLatitude()

return the latitude of LookAt.

Method

altitude

getAltitude()

return the altitude of LookAt.

Method

heading

getHeading()

return the heading of LookAt.

Method

tilt

getTilt()

return the tilt of LookAt.

Method

range

getRange()

return the range of LookAt.

Method

altitudeMode

getAltitudeMode()

return the altitude mode of LookAt.





Class

CameraType(object Elem)


Method

longitude

getLongitude()

return the longitude of Camera.

Method

latitude

getLatitude()

return the latitude of Camera.

Method

altitude

getAltitude()

return the altitude of Camera.

Method

heading

getHeading()

return the heading of Camera.

Method

tilt

getTilt()

return the tilt of Camera.

Method

roll

getRoll()

return the range of Camera.

Method

altitudeMode

getAltitudeMode()

return the altitude mode of Camera.





Class

GeometryType(object Elem, funcElemProc)







Class

MultiGeometryType(object Elem)


Method

Geometry

getGeometry()

return Geometry object.





Class

PointType(object Elem)


Method

extrude

getExtrude()

return if the point feature is extruded.

Method

altitudeMode

getAltitudeMode()

return the altitude mode of the point.

Method

coordinates

getCoordinates()

return point coordinates.





Class

LineStringType(object Elem)


Method

extrude

getExtrude()

return if the line feature is extruded.

Method

tessellate

getTessellate()

return if the line feature is tessellated.

Method

altitudeMode

getAltitudeMode()

return the altitude mode of the line feature.

Method

void

setAltitudeMode()

set the altitude mode of the line feature.

Method

Coordinates

getCoordinates()

return coordinates of line vertexes.





Class

LinearRingType(object Elem)







Class

PolygonType(object Elem)


Method

extrude

getExtrude()

return if the polygon feature is extruded.

Method

tessellate

getTessellate()

return if the polygon feature is  tessellated.

Method

altitudeMode

getAltitudeMode()

return the altitude mode of the polygon feature.

Method

outerBoundaryIs

getOuterBoundaryIs()

return OuterBoundaryIs object.

Method

innerBoundaryIs

getInnerBoundaryIs()

return InnerBoundaryIs object.

Method

Coordinates

getCoordinates()

return coordinates of polygon vertexes.





Class

_StyleSelectorType(object Elem, funcElemProc)







Class

SyleType(object Elem)


Method

IconStyle

getIconStyle()

return IconStyle.

Method

void

setIconStyle(val)

set IconStyle.

Method

LabelStyle

getLabelStyle()

return LabelStyle.

Method

void

setLabelStyle(val)

set LabelStyle.

Method

LineStyle

getLineStyle()

return LineStyle.

Method

void

setLineStyle(val)

set LineStyle.

Method

PolyStyle

getPolyStyle()

return PolyStyle for polygons.

Method

void

setPolyStyle(val)

set PolyStyle for polygons.

Method

BalloonStyle

getBalloonStyle()

return BalloonStyle.

Method

void

setBalloonStyle(val)

set BalloonStyle.

Method

ListStyle

getListStyle()

return ListStyle.

Method

void

setListStyle(val)

set ListStyle.





Class

StyleMapType(object Elem)


Method

Pair

getPair()

return Pair object.





Class

PairType(object Elem)


Method

key

getKey()

return key object.

Method

styleUrl

getStyleUrl()

return StyleUrl object.





Class

_SubStyleType(object Elem, funcElemProc)







Class

_ColorStyleType(object Elem, funcElemProc)


Method

color

getColor()

return color object.

Method

colorMode

getColorMode()

return colorMode object.

Method

string

getRGBA()

return the value of red, green, blue, and alpha in text format.

Method

array

getVColor()






Class

IconStyleType(object Elem)

control the icon style.

Method

scale

getScale()

return the scale of the icon.

Method

heading

getHeading()

return the heading object.

Method

Icon

getIcon()

return the icon.

Method

void

setIcon(number v)

set the icon.

Method

hotspot

getHotSpot()

return the hotspot object.

Method

void

setHotSpot(number v)

set the hotspot object.





Class

LabelStyleType(object Elem)


control the label style.





Class

LineStyleType(object Elem)

control the line style.

Method

width

getWidth()

return line width.





Class

PolyStyleType(object Elem)

control the polygon style.

Method

fill

getFill()

return polygon fill.

Method

outline

getOutline()

return polygon outline.





Class

BalloonStyleType(object Elem)

control the balloon style.

Method

bgColor

getBgColor()

return the background color of the balloon.

Method

textColor

getTextColor()

return the color of the text in the balloon.

Method

text

getText()

return the text in the balloon.

Method

displayMode

getDisplayMode()

return the display mode





Class

ListStyleType(object Elem)

control the list style.

Method

listItemType

getListItemType()

return the type of the list items, which specifies how a Feature is displayed in the list view.

Method

bgColor

getBgColor()

return the background color for the snippet. Color and opacity values are expressed in hexadecimal notation.

Method

ItemIcon

getItemIcon()

return the icon of the item. Icon used in the List view that reflects the state of a Folder or Link fetch.

Method

maxSnippetLines

getmaxSnippetLines()

return the maxSnippetLines object.





Class

BasicLinkType(object Elem, funcElemProc)


Method

href

getHref()

return href object.

Method

void

setHref()

set href object.





Class

LinkType(object Elem)


Method

refreshMode

getRefreshMode()

return the refresh mode to specify how the link is refreshed when the "camera" changes.

Method

refreshNumbererval

getRegreshNumbererval()

return the refreshNumbererval object.

Method

viewRefreshMode

getViewRefreshMode()

return the refresh mode of the view.

Method

viewRefreshTime

getViewRefreshTime()

return the refresh time of the view, which specifies the number of seconds to wait before refreshing the view after camera movement stops.

Method

viewBoundScale

getViewBoundScale()

return the boundScale of the view, which 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.

Method

viewFormat

getViewFormat()

return the view format, which specifies the format of the query string that is appended to the Link's <href> before the file is fetched.

Method

httpQuery

getHttpQuery()

return the httpQuery object, which appends information to the query string, based on the parameters specified.





Class

_TimePrimitiveType(object Elem, funcElemProc)







Class

TimeSpanType(object Elem)


Method

begin

getBegin()

return begin time.

Method

end

getEnd()

return end time.





Class

TimeStampType(object Elem)


Method

when

getWhen()

return current time.

Method

resolution

getResolution()

return time resolution.





Class

_LatLonBoxType(object Elem, funcElemProc)


Method

north

getNorth()

return the north boundary.

Method

south

getSouth()

return the south boundary.

Method

east

getEast()

return the east boundary.

Method

west

getWest()

return the west boundary.





Class

LatLonAltBoxType(object Elem)







Class

LatLonBoxType(object Elem)







Class

SchemaDataType(object Elem)


Method

SimpleData

getSimpleData()

return SimpleData object.

Method

schemaUrl

getschemaUrl()

return schemaUrl object.





Class

RegionType(object Elem)







Class

DataType(object Elem)







Class

LodType(object Elem)







Class

ViewVolumeType(object Elem)


Method

leftFov

getleftFov()

Angle, in degrees, between the camera's viewing direction and the left side of the view volume.

Method

rightFov

getRightFov()

Angle, in degrees, between the camera's viewing direction and the right side of the view volume.

Method

bottomFov

getBottomFov()

Angle, in degrees, between the camera's viewing direction and the bottom side of the view volume.

Method

topFov

getTopFov()

Angle, in degrees, between the camera's viewing direction and the top side of the view volume.

Method

near

getNear()

Measurement in meters along the viewing direction from the camera viewpoint to the PhotoOverlay shape.





Class

ImagePyramidType(object Elem)







Namespace

OGC.KMLgx



Enum

altitudeModeEnumType




(clampToGround,


defines the altitude mode as clampToGround.


relativeToGround)


defines the altitude mode as relativeToGround.





Enum

flyToModeEnumType




(bounce,


defines the flyToMode as bounce.


smooth)


defines the flyToMode as smooth.





Enum

playModeEnumType




(pause)


define the playMode as pause.

Class

TimeSpanType(object Elem)







Class

TimeStampType(object Elem)







Class

balloonVisibility(object Elem)


Method

string

toString()

convert the input to string type.

Method

number

ValueOf()

return the value of input.





Class

TourTpe(object Elem)


Method

Playlist

getPlayList()

return the Playlist of the tour.





Class

PlaylistType(object Elem)


Method

TourPrimitive

getTourPrimitive()

return TourPrimitive object, providing instructions to KML browsers during tours, including points to fly to and the duration of those flights, pauses, updates to KML features, and sound files to play.





Class

_TourPrimitiveType(object Elem, funcElemProc)







Class

AnimatedUpdateType(object Elem)


Method

duration

getDuration()

return duration.

Method

Update

getUpdate()

return Update object.

Method

delayedStart

getDelayedStart()

return delayedStart object.





Class

FlyToType(object Elem)


Method

duration

getDuration()

return duration of the fly to animation.

Method

flyToMode

getFlyToMode()

return fly to mode.

Method

View

getView()

return the view object.





Class

SoundCueType(object Elem)


Method

href

getHref()

return Href.

Method

delayedStart

getDelayedStart()

return delayedStart object.





Class

TourControlType(object Elem)


Method

playMode

getPlayMode()

return play mode of the tour.





Class

WaitType(object Elem)


Method

duration

getDuration()

return duration.





Class

LatLonQuadType(object Elem)







Class

TrackType(object Elem)







Class

MultiTrackType(object Elem)







Class

SimpleArrayFieldType(object Elem)







Class

SimpleArrayDataType(object Elem)







Class

ViewerOptionsType(object Elem)







Class

optionType(object Elem)



 

 


© 2017 Supergeo Technologies Inc.