Hierarchy (view full)

Constructors

Properties

_getHandle: any
_mapManagerCommand: any
_onChange: any
_onMapReady: any
_runCommand: any
context: unknown

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

Example

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>

See

React Docs

map: any
refs: {
    [key: string]: ReactInstance;
}

Type declaration

Deprecated

See

Legacy React Docs

state: Readonly<State>
Animated: AnimatedComponent<typeof MapView>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Example

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

See

https://react.dev/reference/react/Component#static-contexttype

Methods

  • Convert a coordinate to address by using default Geocoder

    Parameters

    Returns Promise<Address>

    Promise with return type Address

  • Parameters

    • camera: Partial<Camera>
    • Optional opts: {
          duration?: number;
      }
      • Optional duration?: number

    Returns void

  • Parameters

    • region: Region
    • Optional duration: number

    Returns void

  • Get bounding box from region

    Parameters

    Returns BoundingBox

    Object Object bounding box ({ northEast: , southWest: })

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    Returns void

  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Convert a user-space point to a map coordinate

    Parameters

    Returns Promise<LatLng>

    Promise Promise with the coordinate ({ latitude: Number, longitude: Number })

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Returns Promise<Camera>

  • Get visible boudaries

    Returns Promise<BoundingBox>

    Promise Promise with the bounding box ({ northEast: , southWest: })

  • Get markers' centers and frames in user-space coordinates

    Parameters

    • Optional onlyVisible: boolean

      boolean true to include only visible markers, false to include all

    Returns Promise<{
        [key: string]: {
            frame: Frame;
            point: Point;
        };
    }>

    Promise Promise with { : { point: Point, frame: Frame } }

  • Runs before React applies the result of Component.render render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before Component.render render causes changes to it.

    Note: the presence of this method prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Convert a map coordinate to user-space point

    Parameters

    Returns Promise<Point>

    Promise Promise with the point ({ x: Number, y: Number })

  • Parameters

    Returns void

  • Parameters

    • activeLevelIndex: number

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Type Parameters

    • K extends "isReady"

    Parameters

    Returns void

  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component.render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

  • Takes a snapshot of the map and saves it to a picture file or returns the image as a base64 encoded string.

    Parameters

    Returns Promise<string>

    Promise Promise with either the file-uri or base64 encoded string