Grid

Hierarchy

  • BaseGrid
    • Grid

Implements

Constructors

Properties

DEFAULT_WIDTH: undefined | number = ...

Default line width

Methods

  • Clear the propagated grid type precision styles

    Returns void

  • {@inheritDoc}

    Parameters

    • obj: any

    Returns boolean

  • Get the grid type precision line color

    Returns

    grid type line color

    Parameters

    Returns undefined | Color

  • Get the label grid edge buffer

    Returns

    label buffer (greater than or equal to 0.0 and less than 0.5)

    Returns number

  • Get the labels for the zoom and tile bounds

    Returns

    labels

    Parameters

    • zoom: number

      zoom level

    • tileBounds: Bounds

      tile bounds

    Returns undefined | GridLabel[]

  • Get the labels for the tile

    Returns

    labels

    Parameters

    • tile: GridTile

      tile

    Returns undefined | GridLabel[]

  • Get the lines for the tile bounds

    Returns

    lines

    Parameters

    • zoom: number

      zoom level

    • tileBounds: Bounds

      tile bounds

    Returns undefined | GridLine[]

  • Get the lines for the tile

    Returns

    lines

    Parameters

    • tile: GridTile

      tile

    Returns undefined | GridLine[]

  • Get the maximum zoom level for drawing grid lines

    Returns

    maximum zoom level

    Returns undefined | number

  • Get the minimum zoom level for drawing grid lines

    Returns

    minimum zoom level

    Returns number

  • Get the maximum zoom level

    Returns

    maximum zoom level

    Returns undefined | number

  • Get the minimum zoom level

    Returns

    minimum zoom level

    Returns number

  • Get the precision in degrees

    Returns

    precision degrees

    Returns number

  • Get the grid type precision line style for the grid type

    Returns

    grid type line style

    Parameters

    Returns GridStyle

  • Get the grid type precision line width

    Returns

    grid type line width

    Parameters

    Returns number

  • Has a grid labeler

    Returns

    true if has a grid labeler

    Returns boolean

  • Has a maximum zoom level override for drawing grid lines

    Returns

    true if has a maximum, false if not overridden

    Returns boolean

  • Has a minimum zoom level override for drawing grid lines

    Returns

    true if has a minimum, false if not overridden

    Returns boolean

  • Has a maximum zoom level

    Returns

    true if has a maximum, false if unbounded

    Returns boolean

  • Returns number

  • Is the grid enabled

    Returns

    enabled flag

    Returns boolean

  • Is labeler zoom level within the grid zoom range

    Returns

    true if within range

    Parameters

    • zoom: number

      zoom level

    Returns boolean

  • Is the zoom level within the grid lines zoom range

    Returns

    true if within range

    Parameters

    • zoom: number

      zoom level

    Returns boolean

  • Is the zoom level within the grid zoom range

    Returns

    true if within range

    Parameters

    • zoom: number

      zoom level

    Returns boolean

  • Set the grid type precision line color

    Parameters

    • Optional color: Color

      grid line color

    • Optional gridType: GridType

      grid type

    Returns void

  • Set the enabled flag

    Parameters

    • enabled: boolean

      enabled flag

    Returns void

  • Set the maximum level override for drawing grid lines

    Parameters

    • Optional linesMaxZoom: number

      maximum zoom level or undefined to remove

    Returns void

  • Set the minimum level override for drawing grid lines

    Parameters

    • Optional linesMinZoom: number

      minimum zoom level or undefined to remove

    Returns void

  • Set the maximum zoom level

    Parameters

    • Optional maxZoom: number

      maximum zoom level

    Returns void

  • Set the minimum zoom level

    Parameters

    • minZoom: number

      minimum zoom level

    Returns void

  • Set the grid type precision line style

    Parameters

    • Optional style: GridStyle

      grid line style

    • Optional gridType: GridType

      grid type

    Returns void

  • Set the grid type precision line width

    Parameters

    • width: number

      grid line width

    • Optional gridType: GridType

      grid type

    Returns void

Generated using TypeDoc