Class: KML::HotSpot

Inherits:
Object
  • Object
show all
Defined in:
lib/kml/hot_spot.rb

Overview

Specifies the position within the Icon that is “anchored” to the <Point> specified in the Placemark. The x and y values can be specified in three different ways: as pixels (“pixels”), as fractions of the icon (“fraction”), or as inset pixels (“insetPixels”), which is an offset in pixels from the upper right corner of the icon. The x and y positions can be specified in different ways—for example, x can be in pixels and y can be a fraction. The origin of the coordinate system is in the lower left corner of the icon.

  • x - Either the number of pixels, a fractional component of the icon, or a pixel inset indicating the x component of a point on the icon.

  • y - Either the number of pixels, a fractional component of the icon, or a pixel inset indicating the y component of a point on the icon.

  • xunits - Units in which the x value is specified. Default=“fraction”. A value of “fraction” indicates the x value is a fraction of the icon. A value of “pixels” indicates the x value in pixels. A value of “insetPixels” indicates the indent from the right edge of the icon.

  • yunits - Units in which the y value is specified. Default=“fraction”. A value of “fraction” indicates the y value is a fraction of the icon. A value of “pixels” indicates the y value in pixels. A value of “insetPixels” indicates the indent from the top edge of the icon.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(x, y, xunits, yunits) ⇒ HotSpot

Returns a new instance of HotSpot.



24
25
26
27
28
29
 
# File 'lib/kml/hot_spot.rb', line 24

def initialize(x, y, xunits, yunits)
  @x = x
  @y = y
  @xunits = xunits
  @yunits = yunits
end

Instance Attribute Details

#x ⇒ Object (readonly)

Returns the value of attribute x.



20
21
22
 
# File 'lib/kml/hot_spot.rb', line 20

def x
  @x
end

#xunits ⇒ Object (readonly)

Returns the value of attribute xunits.



22
23
24
 
# File 'lib/kml/hot_spot.rb', line 22

def xunits
  @xunits
end

#y ⇒ Object (readonly)

Returns the value of attribute y.



21
22
23
 
# File 'lib/kml/hot_spot.rb', line 21

def y
  @y
end

#yunits ⇒ Object (readonly)

Returns the value of attribute yunits.



23
24
25
 
# File 'lib/kml/hot_spot.rb', line 23

def yunits
  @yunits
end