Class quad

The quad class represents a quad tile within three dimensional coordinate space.

class

quad

Index

Methods

Functions

Methods

public equals(q: quad): boolean

Compares this quad tile with another quad tile and determines whether or not they are equal.

Parameters

Returns

boolean

Result of the equality test.

public factoryParent(ancestorsBack: number): quad

Generates the quad tile which is a given number of levels above this tile in the pyramid and in which this quad tile is contained.

Parameters

  • ancestorsBack: number

    Number of levels above this tile the generated tile should be.

Returns

quad

The generated parent tile.

public getEnvelope(): envelope

Gets the envelope in map units which encompasses this quad tile.

Returns

envelope

The encompassing envelope of this quad tile.

public getKey(): string

Gets the quad key for this quad tile as a string.

Returns

string

Quad key for this quad tile as a string.

public getLevel(): number

Gets the z coordinate of this quad tile, or depth.

Returns

number

The z coordinate of this quad tile.

public getX(): number

Gets the x coodinate of this quad tile.

Returns

number

The x coordinate of this quad tile.

public getY(): number

Gets the y coordinate of this quad tile.

Returns

number

The y coordinate of this quad tile.

public toString(): string

Gets the string representation of this quad tile as a quad key.

Returns

string

Quad key for this quad tile as a string.

Functions

factoryQuadFromKey(key: string): quad

Generates a new quad tile based on a given quad key.

Parameters

  • key: string

    The quad key from which to generate the quad tile.

Returns

quad

The generated quad tile.