marker.js for React Native Documentation
    Preparing search index...

    Represents the public API for the MarkerArea component. Exposes methods to create markers, switch modes, and delete selected markers.

    interface MarkerAreaHandle {
        createMarker: (
            markerType: string,
            params?: Partial<MarkerBaseState>,
        ) => void;
        deleteSelectedMarker: () => void;
        switchToSelectMode: () => void;
    }
    Index

    Properties

    createMarker: (markerType: string, params?: Partial<MarkerBaseState>) => void

    Initiates marker creation with the specified type and parameters.

    Type declaration

      • (markerType: string, params?: Partial<MarkerBaseState>): void
      • Parameters

        • markerType: string

          Type of the marker to create.

        • Optionalparams: Partial<MarkerBaseState>

          Optional initial parameters for the marker.

        Returns void

    deleteSelectedMarker: () => void

    Deletes the currently selected marker. If no marker is selected, this method does nothing.

    switchToSelectMode: () => void

    Switches the MarkerArea to "select" mode. In this mode, users can select and edit existing markers.