mgrs-ios 1.1.6 Documentation

Class Base​Grid 

open class BaseGrid: Hashable, Comparable
  • Base Grid
BaseGrid BaseGrid Comparable Comparable BaseGrid->Comparable Hashable Hashable BaseGrid->Hashable Grid Grid Grid->BaseGrid

Subclasses

Grid

Conforms To

Comparable
Hashable

Initializers

init() 

public init()
  • Initialize

Properties

enabled 

public var enabled: Bool = true
  • Enabled grid

min​Zoom 

public var minZoom: Int = 0
  • Minimum zoom level

max​Zoom 

public var maxZoom: Int?
  • Maximum zoom level

lines​Min​Zoom 

public var linesMinZoom: Int?
  • Minimum zoom level override for drawing grid lines

lines​Max​Zoom 

public var linesMaxZoom: Int?
  • Maximum zoom level override for drawing grid lines

style 

public var style: GridStyle
  • Grid line style

labeler 

open var labeler: Labeler?
  • Grid labeler

color 

public var color: UIColor?
  • The grid line color

width 

public var width: Double
  • The grid line width

Methods

has​Max​Zoom() 

public func hasMaxZoom() -> Bool
  • Has a maximum zoom level
  • @return true if has a maximum, false if unbounded

is​Within(_:​) 

public func isWithin(_ zoom: Int) -> Bool
  • Is the zoom level within the grid zoom range
  • @param zoom
  •        zoom level
  • @return true if within range

has​Lines​Min​Zoom() 

public func hasLinesMinZoom() -> Bool
  • Has a minimum zoom level override for drawing grid lines
  • @return true if has a minimum, false if not overridden

has​Lines​Max​Zoom() 

public func hasLinesMaxZoom() -> Bool
  • Has a maximum zoom level override for drawing grid lines
  • @return true if has a maximum, false if not overridden

is​Lines​Within(_:​) 

public func isLinesWithin(_ zoom: Int) -> Bool
  • Is the zoom level within the grid lines zoom range
  • @param zoom
  •        zoom level
  • @return true if within range

has​Labeler() 

public func hasLabeler() -> Bool
  • Has a grid labeler
  • @return true if has a grid labeler

is​Labeler​Within(_:​) 

public func isLabelerWithin(_ zoom: Int) -> Bool
  • Is labeler zoom level within the grid zoom range
  • @param zoom
  •        zoom level
  • @return true if within range

label​Buffer() 

public func labelBuffer() -> Double
  • Get the label grid edge buffer
  • @return label buffer (greater than or equal to 0.0 and less than 0.5)

equals(_:​) 

open func equals(_ grid: BaseGrid) -> Bool

hash(into:​) 

open func hash(into hasher: inout Hasher)

compare(_:​) 

open func compare(_ grid: BaseGrid) -> Bool

Operators

== 

public static func == (lhs: BaseGrid, rhs: BaseGrid) -> Bool

< 

public static func < (lhs: BaseGrid, rhs: BaseGrid) -> Bool