On this page

Interface ITransformGetters

interface ITransformGetters {
    get autoCalculateNearFarZ(): boolean;
    get bearing(): number;
    get bearingInRadians(): number;
    get cameraToCenterDistance(): number;
    get center(): LngLat;
    get constrainOverride(): TransformConstrainFunction;
    get elevation(): number;
    get farZ(): number;
    get fov(): number;
    get fovInRadians(): number;
    get height(): number;
    get latRange(): [number, number];
    get lngRange(): [number, number];
    get maxPitch(): number;
    get maxZoom(): number;
    get minElevationForCurrentTile(): number;
    get minPitch(): number;
    get minZoom(): number;
    get nearZ(): number;
    get padding(): PaddingOptions;
    get pitch(): number;
    get pitchInRadians(): number;
    get renderWorldCopies(): boolean;
    get roll(): number;
    get rollInRadians(): number;
    get scale(): number;
    get tileSize(): number;
    get tileZoom(): number;
    get unmodified(): boolean;
    get width(): number;
    get worldSize(): number;
    get zoom(): number;
}

Hierarchy (View Summary)

Index

Accessors

  • get autoCalculateNearFarZ(): boolean

    Returns boolean

  • get bearing(): number

    Bearing in degrees.

    Returns number

  • get bearingInRadians(): number

    Returns number

  • get cameraToCenterDistance(): number

    The distance from the camera to the center of the map in pixels space.

    Returns number

  • get elevation(): number

    Returns number

  • get farZ(): number

    Returns number

  • get fov(): number

    Vertical field of view in degrees.

    Returns number

  • get fovInRadians(): number

    Returns number

  • get height(): number

    Gets the transform's height in pixels. Use ITransform.resize to set the transform's size.

    Returns number

  • get latRange(): [number, number]

    Returns [number, number]

  • get lngRange(): [number, number]

    Returns [number, number]

  • get maxPitch(): number

    Returns number

  • get maxZoom(): number

    Returns number

  • get minElevationForCurrentTile(): number

    Returns number

  • get minPitch(): number

    Returns number

  • get minZoom(): number

    Returns number

  • get nearZ(): number

    Returns number

  • get pitch(): number

    Pitch in degrees.

    Returns number

  • get pitchInRadians(): number

    Returns number

  • get renderWorldCopies(): boolean

    Returns boolean

  • get roll(): number

    Roll in degrees.

    Returns number

  • get rollInRadians(): number

    Returns number

  • get scale(): number

    How many times "larger" the world is compared to zoom 0. Usually computed as pow(2, zoom). Relevant mostly for mercator projection.

    Returns number

  • get tileSize(): number

    Returns number

  • get tileZoom(): number

    Returns number

  • get unmodified(): boolean

    Returns boolean

  • get width(): number

    Gets the transform's width in pixels. Use ITransform.resize to set the transform's size.

    Returns number

  • get worldSize(): number

    How many units the current world has. Computed by multiplying worldSize by tileSize. Relevant mostly for mercator projection.

    Returns number

  • get zoom(): number

    Returns number

Was this helpful?
SDK JS
Reference
ITransformGetters