Grids

Hierarchy

Constructors

Properties

properties: GridProperties

Grid properties

Methods

  • Create the zoom level grids

    Returns void

  • Delete propagated styles for the grid types

    Parameters

    Returns void

  • Disable the grid

    Parameters

    Returns void

  • Disable grids

    Parameters

    • grids: Grid[]

      grids

    Returns void

  • Enable the grid

    Parameters

    Returns void

  • Enable all grid labelers

    Returns void

  • Enable grids

    Parameters

    • grids: Grid[]

      grids

    Returns void

  • {@inheritDoc}

    Returns number

  • Get a combined grid style from the provided color, width, and grid

    Returns

    grid style

    Parameters

    • grid: Grid

      grid

    • Optional color: Color

      color

    • Optional width: number

      width

    Returns GridStyle

  • Get the grids for the zoom level

    Returns

    grids

    Parameters

    • zoom: number

      zoom level

    Returns undefined | ZoomGrids

  • Get the label grid edge buffer

    Returns

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

    Parameters

    Returns number

  • Get the grid precision for the zoom level

    Returns

    grid type precision

    Parameters

    • zoom: number

      zoom level

    Returns undefined | GridType

  • Is a labeler enabled for the grid type

    Returns

    true if labeler enabled

    Parameters

    Returns boolean

  • Load the grid

    Parameters

    • grid: Grid

      name

    • gridKey: string

      grid name key

    • labeler: Labeler

      grid labeler

    • Optional enabled: boolean

      enable created grids

    Returns void

  • Load the grid style color

    Returns

    color

    Parameters

    • gridKey: string

      grid name key

    • gridKey2: string

      second grid name key

    Returns undefined | Color

  • Load the grid style width

    Returns

    width

    Parameters

    • gridKey: string

      grid name key

    • gridKey2: string

      second grid name key

    Returns undefined | number

  • Set all grid line colors

    Parameters

    • color: Color

      grid line color

    Returns void

  • Set all label grid edge buffers

    Parameters

    • buffer: number

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

    Returns void

  • Set all label colors

    Parameters

    • color: Color

      label color

    Returns void

  • Set all label text sizes

    Parameters

    • textSize: number

      label text size

    Returns void

  • Set all grid line widths

    Parameters

    • width: number

      grid line width

    Returns void

  • Set the grid type precision line color for the grid types

    Parameters

    • types: GridType[]

      grid types

    • color: Color

      grid line color

    • Optional precisionTypes: GridType[]

      precision grid types

    Returns void

  • Set the label grid edge buffer for the grid types

    Parameters

    • buffer: number

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

    • types: GridType[]

      grid types

    Returns void

  • Set the label color for the grid types

    Parameters

    • color: Color

      label color

    • types: GridType[]

      grid types

    Returns void

  • Set the grid maximum zoom

    Parameters

    • type: GridType

      grid type

    • maxZoom: number

      maximum zoom

    Returns void

  • Set the grid minimum zoom

    Parameters

    • type: GridType

      grid type

    • minZoom: number

      minimum zoom

    Returns void

  • Set the label text size for the grid types

    Parameters

    • textSize: number

      label text size

    • types: GridType[]

      grid types

    Returns void

  • Set the grid zoom range

    Parameters

    • type: GridType

      grid type

    • minZoom: number

      minimum zoom

    • maxZoom: number

      maximum zoom

    Returns void

  • Set the grid maximum level override for drawing grid lines

    Parameters

    • type: GridType

      grid type

    • Optional maxZoom: number

      maximum zoom level or null to remove

    Returns void

  • Set the grid minimum level override for drawing grid lines

    Parameters

    • type: GridType

      grid type

    • minZoom: number

      minimum zoom level or null to remove

    Returns void

  • Set the grid maximum zoom

    Parameters

    • grid: Grid

      grid

    • Optional maxZoom: number

      maximum zoom

    Returns void

  • Set the grid maximum zoom

    Parameters

    • type: GridType

      grid type

    • maxZoom: number

      maximum zoom

    Returns void

  • Set the grid minimum zoom

    Parameters

    • grid: Grid

      grid

    • minZoom: number

      minimum zoom

    Returns void

  • Set the grid minimum zoom

    Parameters

    • type: GridType

      grid type

    • minZoom: number

      minimum zoom

    Returns void

  • Set the grid type precision line width for the grid types

    Parameters

    • types: GridType[]

      grid types

    • width: number

      grid line width

    • Optional precisionTypes: GridType[]

    Returns void

  • Set the grid zoom range

    Parameters

    • grid: Grid

      grid

    • minZoom: number

      minimum zoom

    • Optional maxZoom: number

      maximum zoom

    Returns void

  • Set the grid zoom range

    Parameters

    • type: GridType

      grid type

    • minZoom: number

      minimum zoom

    • maxZoom: number

      maximum zoom

    Returns void

Generated using TypeDoc