Type alias TMiMapViewProps

Type declaration

• Optional onBlueDotPositionUpdated?: ((prop) => void)

  • • (prop): void

    • Called when Blue Dot position is updated

      Parameters

      • prop: {
            update: TBlueDotPositionUpdate;
        }

        • update: TBlueDotPositionUpdate

      Returns void

• Optional onBlueDotStateChanged?: ((prop) => void)

  • • (prop): void

    • Called when Blue Dot State is updated. This can be used to figure out why the Blue Dot is not visible

      Parameters

      • prop: {
            stateChange: TBlueDotStateChange;
        }

        • stateChange: TBlueDotStateChange

      Returns void

• Optional onCameraChanged?: ((prop) => void)

  • • (prop): void

    • Called when the camera is updated

      Parameters

      • prop: TCameraChange

      Returns void

• Optional onClick?: ((prop) => void)

  • • (prop): void

    • Called when the map is clicked. Payload contains the lat-lon of the click event, an array of interactive polygons that were clicked, and a flag indicating whether the click is likely above the blue dot.

      Parameters

      • prop: TMapClickEvent

      Returns void

• Optional onDataLoaded?: ((prop) => void)

  • • (prop): void

    • Called when data is loaded for this venue

      Parameters

      • prop: {
            venueData: Mappedin;
        }

        • venueData: Mappedin

      Returns void

• Optional onFirstMapLoaded?: (() => void)

  • • (): void

    • Called when the map is ready for interaction

      Returns void

• Optional onMapChanged?: ((prop) => void)

  • • (prop): void

    • Called when the map changes

      Parameters

      • prop: {
            map: MappedinMap;
        }

        • map: MappedinMap

      Returns void

• Optional onNothingClicked?: (() => void)

  • • (): void

    • Returns void

      Deprecated

      Use onClick. Called when clicking outside any interactive polygons

• Optional onPolygonClicked?: ((prop) => void)

  • • (prop): void

    • Parameters

      • prop: {
            polygon: MappedinPolygon;
        }

        • polygon: MappedinPolygon

      Returns void

      Deprecated

      Use onClick. Called when an interactive polygon is clicked

• Optional onStateChanged?: ((prop) => void)

  • • (prop): void

    • Called when the SDK state changes

      Parameters

      • prop: {
            state: STATE;
        }

        • state: STATE

      Returns void

• Optional onVenueLoadError?: ((prop) => void)

  • • (prop): void

    • Called if an error occurs loading the venue map

      Parameters

      • prop: {
            error: {
                message: ERROR_MESSAGES;
                name: ERROR;
                stack?: string;
            };
        }

        • error: {
              message: ERROR_MESSAGES;
              name: ERROR;
              stack?: string;
          }

          • message: ERROR_MESSAGES

          • name: ERROR

          • Optional stack?: string

      Returns void

• options: TMiMapViewOptions & TMapViewRNOptions

  Options to initialze MiMapView with

• ref: React.ForwardedRef<MapViewStore>

  The MapViewStore instance will be returned here

• Optional style?: React.CSSProperties

• Optional venueData?: Mappedin

  Venue Data to render inside the MapView. This is returned by getVenue or getVenueBundle