expo-maps/src/Common.types.ts

/**
 * Basic point type for representing a coordinate on a map.
 */
export type Point = {
  /**
   * The latitude of the point in degrees. Use decimal degrees as opposed to degrees/minutes/seconds.
   * @required
   */
  latitude: number;
  /**
   * The longitude of the point in degrees. Use decimal degrees as opposed to degrees/minutes/seconds.
   * @required
   */
  longitude: number;
};

/**
 * Type for representing width and height on a map using latitude and longitude.
 */
export type LatLngDelta = {
  /**
   * The north-to-south distance.
   * @required
   */
  latitudeDelta: number;
  /**
   * The east-to-west distance.
   * @required
   */
  longitudeDelta: number;
};

/**
 * Generic object that associates numerical data with a georgaphic coordinate.
 */
export type PointWithData = Point & {
  /**
   * Numerical data associated with the point. (optional)
   * @default 1
   */
  data?: number;
};

/**
 * PatternItem is used to define a repeating pattern for polyline and polygon line.
 * PatternItem with type `stroke` and length 0 will represent a dot.
 * Use an array of PatternItem to define a pattern.
 */
export type PatternItem = {
  /**
   * The type of the pattern item.
   * * `'stroke'` - rendered line segment
   * * `'gap'` - transparent gap between pattern items
   * @required
   */
  type: 'stroke' | 'gap';
  /**
   * Length of the pattern item in pixels.
   * @required
   */
  length: number;
};

export type CameraPosition = {
  /**
   * The location that the camera is pointing at.
   * @required
   */
  target: Point;

  /**
   * The Direction that the camera is pointing in, in degrees clockwise from north
   * @required
   */
  bearing: number;

  /**
   * The angle, in degrees, of the camera angle from the nadir (directly facing the Earth).
   * @required
   */

  tilt: number;

  /**
   * Zoom level near the center of the screen.
   * @platform iOS: Google maps only.
   * @platform Android: Supported
   */
  zoom: number;

  /**
   * The amount of north-to-south distance (measured in degrees) to display on the map.
   * @required for Apple Maps Only
   */
  latitudeDelta: number;

  /**
   * The amount of east-to-west distance (measured in degrees) to display for the map region.
   * @required for Apple Maps Only
   */
  longitudeDelta: number;
};

/**
 * Information about animation of the camera, contains target position and animation parameters.
 * Camera will animate only the values which have been set, unset parameters won't be affected
 *
 * Note: If latLngDelta is set the camera move is going to ignore the zoom,
 * tilt and bearing properties.Instead the camera will move to a smallest view containing a rectangle
 * created around the center point by the deltas.
 */
export type CameraMove = {
  /**
   * Location to which the camera should animate. This will be in the center of the view
   */
  target?: Point;

  /**
   * Bearing to which the camera should animate.
   */
  bearing?: number;

  /**
   * Tilt to which the camera should animate.
   */

  tilt?: number;

  /**
   * Zoom to which the camera should animate.
   */
  zoom?: number;

  latLngDelta?: LatLngDelta;

  /**
   * Duration in milliseconds of the animation
   * @default 1000
   */
  duration?: number;
  /**
   * When true camera will smoothly animate it's position over the time provided in `duration` prop.
   * Otherwise the camera will instantly move to provided position
   * @default true
   */
  animate?: boolean;
};

/**
 * Type describing points of interest on the map
 */
export type PointOfInterest = {
  /**
   * Position of the point of interest
   * @required
   */
  position: Point;
  /**
   * Name of the point of interest
   * @required
   */
  name: string;
  /**
   * Unique ID of the point of interest
   * @required
   */
  placeId: string;
};

/**
 * Type describing a marker (pin) placed on the map
 */
export type Marker = {
  /**
   * Id given to the marker
   */
  id: string;
  /**
   * Position of the marker
   * @required
   */
  position: Point;
};

export type MapCluster = {
  /**
   * ID of the cluster
   */
  id: string;
  /**
   * Position of the point of the cluster
   * @required
   */
  position: Point;
};

export type UserLocation = {
  /**
   * Current position of the user represented by
   * {@link Point}
   */
  position: Point;
  /**
   * Current altitude of the user
   */
  altitude: number;
  /**
   * The radius of uncertainty for the user'slocation, measured in meters.
   */
  accuracy: number;
  /**
   * Accuracy of current altitude estimate
   */
  verticalAccuracy: number;
  /**
   * Current speed of the user measured im meters per second
   */
  speed: number;
  /**
   * Accuracy of the current speed estimate
   */
  speedAccuracy: number;
  /**
   * Direction the user is heading
   */
  heading: number;
  /**
   * The time at which this location was determined
   */
  timestamp: number;
};

export type Color =
  | 'red'
  | 'blue'
  | 'green'
  | 'black'
  | 'white'
  | 'gray'
  | 'cyan'
  | 'magenta'
  | 'yellow'
  | 'lightgray'
  | 'darkgray'
  | 'aqua'
  | 'fuchsia'
  | 'lime'
  | 'maroon'
  | 'navy'
  | 'olive'
  | 'purple'
  | 'silver'
  | 'teal';

/**
 * Possible power priorities for OnLocationChange event
 */
export enum LocationChangePriority {
  /**
   * Best accuracy that the device can acquire. Will consume more power.
   */
  PRIORITY_HIGH_ACCURACY = 100,
  /**
   * Bock level accuracy. Block level accuracy is considered to be about 100 meter accuracy.
   */
  PRIORITY_BALANCED_POWER_ACCURACY = 102,
  /**
   * City level accuracy. City level accuracy is considered to be about 10km accuracy.
   * Using a coarse accuracy such as this often consumes less power
   */
  PRIORITY_LOW_POWER = 104,
  /**
   * No locations will be returned unless a different client has requested location updates in which case
   * this request will act as a passive listener to those locations. Will use no additional power
   */
  PRIORITY_NO_POWER = 105,
}