Grid Bounds

Hierarchy

  • GeometryEnvelope
    • Bounds

Constructors

  • Returns Bounds

  • Parameters

    • envelope: GeometryEnvelope

    Returns Bounds

  • Parameters

    • hasZ: boolean
    • hasM: boolean

    Returns Bounds

  • Parameters

    • minX: number
    • minY: number
    • maxX: number
    • maxY: number

    Returns Bounds

  • Parameters

    • minX: number
    • minY: number
    • minZ: number
    • maxX: number
    • maxY: number
    • maxZ: number

    Returns Bounds

  • Parameters

    • minX: number
    • minY: number
    • minZ: number
    • minM: number
    • maxX: number
    • maxY: number
    • maxZ: number
    • maxM: number

    Returns Bounds

Accessors

  • get centroid(): Point
  • Get the envelope centroid point

    Returns

    centroid point

    Returns Point

  • get hasM(): boolean
  • Has m coordinates

    Returns

    true if has m coordinates

    Returns boolean

  • set hasM(hasM: boolean): void
  • Set has m coordinates

    Parameters

    • hasM: boolean

      has m

    Returns void

  • get hasZ(): boolean
  • True if has Z coordinates

    Returns

    has z

    Returns boolean

  • set hasZ(hasZ: boolean): void
  • Set has z coordinates

    Parameters

    • hasZ: boolean

      has z

    Returns void

  • get mRange(): number
  • Get the m range

    Returns

    m range

    Returns number

  • get maxM(): number
  • Get max m

    Returns

    max m

    Returns number

  • set maxM(maxM: number): void
  • Set max m

    Parameters

    • maxM: number

      max m

    Returns void

  • get maxX(): number
  • Get max x

    Returns

    max x

    Returns number

  • set maxX(maxX: number): void
  • Set max x

    Parameters

    • maxX: number

      max x

    Returns void

  • get maxY(): number
  • Get max y

    Returns

    max y

    Returns number

  • set maxY(maxY: number): void
  • Set max y

    Parameters

    • maxY: number

      max y

    Returns void

  • get maxZ(): number
  • Get max z

    Returns

    max z

    Returns number

  • set maxZ(maxZ: number): void
  • Set max z

    Parameters

    • maxZ: number

      max z

    Returns void

  • get minM(): number
  • Get min m

    Returns

    min m

    Returns number

  • set minM(minM: number): void
  • Set min m

    Parameters

    • minM: number

      min m

    Returns void

  • get minX(): number
  • Get min x

    Returns

    min x

    Returns number

  • set minX(minX: number): void
  • Set min x

    Parameters

    • minX: number

      min x

    Returns void

  • get minY(): number
  • Get min y

    Returns

    min y

    Returns number

  • set minY(minY: number): void
  • Set min y

    Parameters

    • minY: number

      min y

    Returns void

  • get minZ(): number
  • Get min z

    Returns

    min z

    Returns number

  • set minZ(minZ: number): void
  • Set min z

    Parameters

    • minZ: number

      min z

    Returns void

  • get xRange(): number
  • Get the x range

    Returns

    x range

    Returns number

  • get yRange(): number
  • Get the y range

    Returns

    y range

    Returns number

  • get zRange(): number
  • Get the z range

    Returns

    z range

    Returns number

Methods

  • Build a geometry representation of the geometry envelope

    Returns

    geometry, polygon or point

    Returns Geometry

  • Determine if inclusively contains the provided envelope

    Returns

    true if contains

    Parameters

    • envelope: GeometryEnvelope

      geometry envelope

    Returns boolean

  • Determine if contains the coordinate

    Returns

    true if contains

    Since

    1.1.1

    Parameters

    • x: number

      x value

    • y: number

      y value

    Returns boolean

  • Determine if contains the coordinate

    Returns

    true if contains

    Since

    1.1.1

    Parameters

    • x: number

      x value

    • y: number

      y value

    • epsilon: number

      epsilon equality tolerance

    Returns boolean

  • Determine if contains the point

    Returns

    true if contains

    Since

    1.1.1

    Parameters

    • point: Point

      point

    Returns boolean

  • Determine if contains the point

    Returns

    true if contains

    Since

    1.1.1

    Parameters

    • point: Point

      point

    • epsilon: number

      epsilon equality tolerance

    Returns boolean

  • Determine if inclusively contains the provided envelope

    Returns

    true if contains

    Since

    1.1.1

    Parameters

    • envelope: GeometryEnvelope

      geometry envelope

    • epsilon: number

      epsilon equality tolerance

    Returns boolean

  • {@inheritDoc}

    Parameters

    • other: GeometryEnvelope

    Returns boolean

  • Get the bottom line

    Returns

    bottom line

    Since

    1.1.1

    Returns Line

  • Get the bottom left point

    Returns

    bottom left point

    Since

    1.1.1

    Returns Point

  • Get the bottom right point

    Returns

    bottom right point

    Since

    1.1.1

    Returns Point

  • Get the centroid latitude

    Returns

    centroid latitude

    Returns number

  • Get the centroid longitude

    Returns

    centroid longitude

    Returns number

  • Get the left line

    Returns

    left line

    Since

    1.1.1

    Returns Line

  • Get the envelope mid x

    Returns

    mid x

    Since

    1.0.3

    Returns number

  • Get the envelope mid y

    Returns

    mid y

    Since

    1.0.3

    Returns number

  • Get the pixel range where the bounds fit into the provided bounds

    Returns

    pixel range

    Parameters

    • width: number

      width

    • height: number

      height

    • bounds: Bounds

      bounds

    Returns PixelRange

  • Get the right line

    Returns

    right line

    Since

    1.1.1

    Returns Line

  • Get the top line

    Returns

    top line

    Since

    1.1.1

    Returns Line

  • Get the top left point

    Returns

    top left point

    Since

    1.1.1

    Returns Point

  • Get the top right point

    Returns

    top right point

    Since

    1.1.1

    Returns Point

  • Determine if intersects with the provided envelope

    Returns

    true if intersects

    Parameters

    • envelope: GeometryEnvelope

      geometry envelope

    • allowEmpty: boolean

      allow empty ranges when determining intersection

    Returns boolean

  • True if has Z coordinates

    Returns

    has z

    See

    #hasZ()

    Returns boolean

  • Determine if the envelope is empty

    Returns

    true if empty

    Since

    1.1.1

    Returns boolean

  • True if has M measurements

    Returns

    has m

    See

    #hasM()

    Returns boolean

  • Determine if the envelope is of a single point

    Returns

    true if a single point bounds

    Since

    2.0.5

    Returns boolean

  • Create a new bounds as the overlapping between this bounds and the provided

    Returns

    overlap bounds

    Parameters

    Returns GeometryEnvelope

  • Set the eastern longitude

    Parameters

    • east: number

      eastern longitude

    Returns void

  • Set the max latitude

    Parameters

    • maxLatitude: number

      max latitude

    Returns void

  • Set the max longitude

    Parameters

    • maxLongitude: number

      max longitude

    Returns void

  • Set the min latitude

    Parameters

    • minLatitude: number

      min latitude

    Returns void

  • Set the min longitude

    Parameters

    • minLongitude: number

      min longitude

    Returns void

  • Set the northern latitude

    Parameters

    • north: number

      northern latitude

    Returns void

  • Set the southern latitude

    Parameters

    • south: number

      southern latitude

    Returns void

  • Set the western longitude

    Parameters

    • west: number

      western longitude

    Returns void

  • Convert the bounds to be precision accurate minimally containing the bounds. Each bound is equal to or larger by the precision degree amount.

    Returns

    precision bounds

    Parameters

    • precision: number

      precision in degrees

    Returns Bounds

  • Create a new bounds as the union between this bounds and the provided

    Returns

    union bounds

    Parameters

    Returns GeometryEnvelope

  • Create bounds

    Returns

    bounds

    Parameters

    • minLongitude: number

      min longitude

    • minLatitude: number

      min latitude

    • maxLongitude: number

      max longitude

    • maxLatitude: number

      max latitude

    • unit: Unit

      unit

    Returns Bounds

  • Create bounds

    Returns

    bounds

    Parameters

    • envelope: GeometryEnvelope

      geometry envelope

    • Optional unit: Unit

      unit

    Returns Bounds

  • Create bounds in degrees

    Returns

    bounds

    Parameters

    • minLongitude: number

      min longitude

    • minLatitude: number

      min latitude

    • maxLongitude: number

      max longitude

    • maxLatitude: number

      max latitude

    Returns Bounds

  • Create bounds in meters

    Returns

    bounds

    Parameters

    • minLongitude: number

      min longitude

    • minLatitude: number

      min latitude

    • maxLongitude: number

      max longitude

    • maxLatitude: number

      max latitude

    Returns Bounds

Generated using TypeDoc