react-native-mobilex 开发文档
    Preparing search index...

    Type Alias INavigation

    导航模块

    包含导航引导、语音播报等

    支持模拟，真实导航。

    type INavigation = {
        getGuideState: () => Promise<NavGuideState>;
        initNavigation: () => Promise<boolean>;
        pause: () => Promise<void>;
        resume: () => Promise<void>;
        setEndPosPos: (start: ICoordinate) => Promise<void>;
        setHeadingUp: (headingUp: boolean) => Promise<void>;
        setLocation: (pos: IGeolocation) => Promise<void>;
        setRouteInfo: (routeInfo: INavigationInfo) => Promise<boolean>;
        setSpeed: (speed: number) => Promise<void>;
        setStartPos: (start: ICoordinate) => Promise<void>;
        start: (mode: "Simulated" | "walk" | "car") => Promise<void>;
        stop: () => Promise<void>;
    }
    Index

    Properties

    getGuideState initNavigation pause resume setEndPosPos setHeadingUp setLocation setRouteInfo setSpeed setStartPos start stop

    Properties

    getGuideState: () => Promise<NavGuideState>

    获取导航状态。

    Type declaration

    initNavigation: () => Promise<boolean>

    初始化导航实例。

    调用其它导航接口前应先完成初始化。

    Type declaration

      • (): Promise<boolean>

      • Returns Promise<boolean>

        是否初始化成功。

    pause: () => Promise<void>

    暂停导航

    resume: () => Promise<void>

    恢复导航

    setEndPosPos: (start: ICoordinate) => Promise<void>

    设置导航终点。

    Type declaration

    setHeadingUp: (headingUp: boolean) => Promise<void>

    设置是否车头向上。

    Type declaration

      • (headingUp: boolean): Promise<void>

      • Parameters

        • headingUp: boolean

          是否启用车头向上模式，默认 false。

        Returns Promise<void>

    setLocation: (pos: IGeolocation) => Promise<void>

    设置当前定位。

    Type declaration

      • (pos: IGeolocation): Promise<void>

      • Parameters

        • pos: IGeolocation

          应用定位能力返回的当前位置。

        Returns Promise<void>

    setRouteInfo: (routeInfo: INavigationInfo) => Promise<boolean>

    设置路径分析后的导航路径信息。

    Type declaration

      • (routeInfo: INavigationInfo): Promise<boolean>

      • Parameters

        Returns Promise<boolean>

        是否设置成功；未初始化导航实例时返回 false。

    setSpeed: (speed: number) => Promise<void>

    设置模拟导航速度。

    Type declaration

      • (speed: number): Promise<void>

      • Parameters

        • speed: number

          模拟导航速度，默认值为 1。

        Returns Promise<void>

    setStartPos: (start: ICoordinate) => Promise<void>

    设置导航起点。

    Type declaration

    start: (mode: "Simulated" | "walk" | "car") => Promise<void>

    开始导航。

    开始后会通过 onNavgationInfoChange 和 onNavgationAudioMessageChange 推送导航引导事件。

    Type declaration

      • (mode: "Simulated" | "walk" | "car"): Promise<void>

      • Parameters

        • mode: "Simulated" | "walk" | "car"

          导航模式，支持模拟导航、步行导航和驾车导航。

        Returns Promise<void>

    stop: () => Promise<void>

    停止导航

    Settings

    Member Visibility

    On This Page

    Properties