react-native-maps 1.26.11 → 1.26.13

package/dist/src/MapPolyline.d.ts

@@ -0,0 +1,156 @@
+import * as React from 'react';
+import { View, type NativeSyntheticEvent, type ViewProps } from 'react-native';
+import { ProviderContext, type NativeComponent, type MapManagerCommand, type UIManagerCommand } from './decorateMapComponent';
+import type { LatLng, LineCapType, LineJoinType, Point } from './sharedTypes';
+export type MapPolylineProps = ViewProps & {
+    /**
+     * An array of coordinates to describe the polyline
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    coordinates: LatLng[];
+    /**
+     * The fill color to use for the path.
+     *
+     * @default `#000`, `rgba(r,g,b,0.5)`
+     * @platform iOS: Apple Maps only
+     * @platform Android: Not supported
+     */
+    fillColor?: string;
+    /**
+     * Boolean to indicate whether to draw each segment of the line as a geodesic as opposed to straight lines on the Mercator projection.
+     * A geodesic is the shortest path between two points on the Earth's surface.
+     * The geodesic curve is constructed assuming the Earth is a sphere.
+     *
+     * @platform iOS: Google Maps only
+     * @platform Android: Supported
+     */
+    geodesic?: boolean;
+    /**
+     * The line cap style to apply to the open ends of the path
+     *
+     * @default `round`
+     * @platform iOS: Apple Maps only
+     * @platform Android: supported
+     * */
+    lineCap?: LineCapType;
+    /**
+     * An array of numbers specifying the dash pattern to use for the path.
+     * The array contains one or more numbers that indicate the lengths (measured in points)
+     * of the line segments and gaps in the pattern.
+     * The values in the array alternate, starting with the first line segment length,
+     * followed by the first gap length, followed by the second line segment length, and so on.
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: supported
+     */
+    lineDashPattern?: number[];
+    /**
+     * The offset (in points) at which to start drawing the dash pattern.
+     * Use this property to start drawing a dashed line partway through a segment or gap.
+     * For example, a phase value of 6 for the patter 5-2-3-2 would cause drawing to begin in the middle of the first gap.
+     *
+     * @default 0
+     * @platform iOS: Apple Maps only
+     * @platform Android: Not supported
+     */
+    lineDashPhase?: number;
+    /**
+     * The line join style to apply to corners of the path.
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: supported
+     */
+    lineJoin?: LineJoinType;
+    /**
+     * The limiting value that helps avoid spikes at junctions between connected line segments.
+     * The miter limit helps you avoid spikes in paths that use the `miter` `lineJoin` style.
+     * If the ratio of the miter length—that is, the diagonal length of the miter join—to the line thickness exceeds the miter limit,
+     * the joint is converted to a bevel join.
+     * The default miter limit is 10, which results in the conversion of miters whose angle at the joint is less than 11 degrees.
+     *
+     * @default 10
+     * @platform iOS: Apple Maps only
+     * @platform Android: Not supported
+     */
+    miterLimit?: number;
+    /**
+     * Callback that is called when the user presses on the polyline
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    onPress?: (event: PolylinePressEvent) => void;
+    /**
+     * The stroke color to use for the path.
+     *
+     * @default `#000`, `rgba(r,g,b,0.5)`
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    strokeColor?: string;
+    /**
+     * The stroke colors to use for the path.
+     *
+     * Must be the same length as `coordinates`
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    strokeColors?: string[];
+    /**
+     * The stroke width to use for the path.
+     *
+     * @default 1
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    strokeWidth?: number;
+    /**
+     * Boolean to allow the polyline to be tappable and use the onPress function.
+     *
+     * @platform iOS: Google Maps only
+     * @platform Android: Supported
+     */
+    tappable?: boolean;
+    /**
+     * The order in which this tile overlay is drawn with respect to other overlays.
+     * An overlay with a larger z-index is drawn over overlays with smaller z-indices.
+     * The order of overlays with the same z-index is arbitrary.
+     *
+     * @platform iOS: Google Maps only
+     * @platform Android: Supported
+     */
+    zIndex?: number;
+};
+type NativeProps = MapPolylineProps & {
+    ref: React.RefObject<View | null>;
+};
+export declare class MapPolyline extends React.Component<MapPolylineProps> {
+    context: React.ContextType<typeof ProviderContext>;
+    getNativeComponent: () => NativeComponent<NativeProps>;
+    getMapManagerCommand: (name: string) => MapManagerCommand;
+    getUIManagerCommand: (name: string) => UIManagerCommand;
+    private polyline;
+    constructor(props: MapPolylineProps);
+    setNativeProps(props: Partial<NativeProps>): void;
+    render(): React.JSX.Element;
+}
+declare const _default: typeof MapPolyline;
+export default _default;
+export type PolylinePressEvent = NativeSyntheticEvent<{
+    action: 'polyline-press';
+    /**
+     * @platform iOS: Google Maps
+     */
+    id?: string;
+    /**
+     * @platform Android
+     */
+    coordinate?: LatLng;
+    /**
+     * @platform Android
+     */
+    position?: Point;
+}>;

package/dist/src/MapUrlTile.d.ts

@@ -0,0 +1,134 @@
+import * as React from 'react';
+import { ProviderContext, type NativeComponent, type MapManagerCommand, type UIManagerCommand } from './decorateMapComponent';
+import type { ViewProps } from 'react-native';
+export type MapUrlTileProps = ViewProps & {
+    /**
+     * Doubles tile size from 256 to 512 utilising higher zoom levels
+     * i.e loading 4 higher zoom level tiles and combining them for one high-resolution tile.
+     * iOS does this automatically, even if it is not desirable always.
+     * NB! using this makes text labels smaller than in the original map style.
+     *
+     * @platform iOS: Not supported
+     * @platform Android: Supported
+     */
+    doubleTileSize?: boolean;
+    /**
+     * Allow tiles using the TMS coordinate system (origin bottom left) to be used,
+     * and displayed at their correct coordinates.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    flipY?: boolean;
+    /**
+     * The maximum native zoom level for this tile overlay i.e. the highest zoom level that the tile server provides.
+     * Tiles are auto-scaled for higher zoom levels.
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    maximumNativeZ?: number;
+    /**
+     * The maximum zoom level for this tile overlay.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    maximumZ?: number;
+    /**
+     * The minimum zoom level for this tile overlay.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    minimumZ?: number;
+    /**
+     * In offline-mode tiles are not fetched from the tile servers, rather only tiles stored in the cache directory are used.
+     * Furthermore automated tile scaling is activated: if tile at a desired zoom level is not found from the cache directory,
+     * then lower zoom level tile is used (up to 4 levels lower) and scaled.
+     *
+     * @default false
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    offlineMode?: boolean;
+    /**
+     * Map layer opacity. Value between 0 - 1, with 0 meaning fully transparent.
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    opacity?: number;
+    /**
+     * Corresponds to MKTileOverlay canReplaceMapContent i.e. if true then underlying iOS basemap is not shown.
+     *
+     * @default false
+     * @platform iOS: Apple Maps only
+     * @platform Android: Not supported
+     */
+    shouldReplaceMapContent?: boolean;
+    /**
+     * Defines maximum age in seconds for a cached tile before it's refreshed.
+     *
+     * NB! Refresh logic is "serve-stale-while-refresh"
+     * i.e. to ensure map availability a stale (over max age) tile is served
+     * while a tile refresh process is started in the background.
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    tileCacheMaxAge?: number;
+    /**
+     * Enable caching of tiles in the specified directory.
+     * Directory can be specified either as a normal path or in URL format (`file://`).
+     *
+     * Tiles are stored in tileCachePath directory as `/{z}/{x}/{y}` i.e. in sub-directories 2-levels deep,
+     * filename is tile y-coordinate without any filetype-extension.
+     *
+     * NB! All cache management needs to be implemented by client e.g. deleting tiles to manage use of storage space etc.
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    tileCachePath?: string;
+    /**
+     * Tile size, default size is 256 (for tiles of 256 _ 256 pixels).
+     * High-res (aka 'retina') tiles are 512 (tiles of 512 _ 512 pixels)
+     *
+     * @platform iOS: Apple Maps only
+     * @platform Android: Supported
+     */
+    tileSize?: number;
+    /**
+     * The url template of the map tileserver.
+     * (URLTile) The patterns {x} {y} {z} will be replaced at runtime.
+     * For example, http://c.tile.openstreetmap.org/{z}/{x}/{y}.png.
+     *
+     * It is also possible to refer to tiles in local filesystem with file:///top-level-directory/sub-directory/{z}/{x}/{y}.png URL-format.
+     * (WMSTile) The patterns {minX} {maxX} {minY} {maxY} {width} {height} will be replaced at runtime according to EPSG:900913 specification bounding box.
+     * For example, https://demo.geo-solutions.it/geoserver/tiger/wms?service=WMS&version=1.1.0&request=GetMap&layers=tiger:poi&styles=&bbox={minX},{minY},{maxX},{maxY}&width={width}&height={height}&srs=EPSG:900913&format=image/png&transparent=true&format_options=dpi:213.
+     *
+     * @platform iOS: Supported
+     * @platform Android: Supported
+     */
+    urlTemplate: string;
+    /**
+     * The order in which this tile overlay is drawn with respect to other overlays.
+     * An overlay with a larger z-index is drawn over overlays with smaller z-indices.
+     * The order of overlays with the same z-index is arbitrary.
+     *
+     * @platform iOS: Google Maps only
+     * @platform Android: Supported
+     */
+    zIndex?: number;
+};
+type NativeProps = MapUrlTileProps;
+export declare class MapUrlTile extends React.Component<MapUrlTileProps> {
+    context: React.ContextType<typeof ProviderContext>;
+    getNativeComponent: () => NativeComponent<NativeProps>;
+    getMapManagerCommand: (name: string) => MapManagerCommand;
+    getUIManagerCommand: (name: string) => UIManagerCommand;
+    render(): React.JSX.Element;
+}
+declare const _default: typeof MapUrlTile;
+export default _default;