Module symbology/grid/mgrs/MGRSGridOverlayTextProvider

createDefaultMGRSOverlayTextSettings

• (mgrsGrid: MGRSGrid, mgrsCoordinates?: boolean): OverlayTextSetting[]

• Creates default overlay text settings, based on a MGRS grid. These settings format MGRS points to a precision that's appropriate for the current scale range. For example:

  • when zoomed out so only grid zones are visible, it will show the grid zone coordinate, e.g. "32U"
  • when you zoom in further until 100km squares are visible, it will show the grid zone + 100km square coordinate, e.g. "32U MD"
  • when you zoom in even further until 10km squares are visible, it will show the grid zone + 100km and 10km and square coordinate, e.g. "32U MD 5 4"
  • this goes on until you zoom in to 1m squares, e.g. "32U MD 4545 5728"

  since

  2022.0

  Parameters

  • mgrsGrid: MGRSGrid

    an MGRS grid to create overlay text settings for. Note that this grid must have settings for all MGRS levels for this to work, otherwise an error is thrown.

  • Optional mgrsCoordinates: boolean

    Indicates if MGRS coordinates should be used. If false, UTM coordinates are used. Defaults to true.

  Returns OverlayTextSetting[]