xref: /expo/packages/expo-maps/src/Overlay.ts (revision ee0de234)
1import React from 'react';
2
3import { Point } from './Common.types';
4
5/**
6 * Overlay specific props.
7 */
8export type OverlayProps = {
9  /**
10   * South west, and north east corners of the image.
11   */
12  bounds: {
13    /**
14     * South west corner coordinates.
15     */
16    southWest: Point;
17    /**
18     * North east corner coordinates.
19     */
20    northEast: Point;
21  };
22  /**
23   * Custom overlay graphic
24   */
25  icon: string;
26};
27
28export type OverlayObject = {
29  type: 'overlay';
30} & OverlayProps;
31
32/**
33 * Ground Overlay component of Expo Maps library.
34 *
35 * Draws custom ground overlays on ExpoMap.
36 * This component should be ExpoMap component child to work properly.
37 *
38 * See {@link OverlayProps} for more details.
39 */
40export class Overlay extends React.Component<OverlayProps> {
41  render() {
42    return null;
43  }
44}
45