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

    Type Alias ICallouts

    Callout 模块。

    管理二维地图上的 HTML 气泡标注。Callout 会显示在地图视图上，位置随地图坐标变化同步更新。

    type ICallouts = {
        addCallout: (
            name: string,
            options: Omit<CalloutOption, "className"> & {
                html?: string;
                location?: IPoint2D;
                style?: Partial<ICalloutStyle>;
            },
        ) => void;
        getCallout: (
            name: string,
        ) => { location: IPoint2D | undefined; name: string } | undefined;
        removeAllCallouts: () => void;
        removeCallout: (name: string) => void;
        updateCallout: (
            name: string,
            options: Omit<CalloutOption, "className"> & {
                html?: string;
                location?: IPoint2D;
                style?: Partial<ICalloutStyle>;
            },
        ) => void;
    }
    Index

    Properties

    addCallout getCallout removeAllCallouts removeCallout updateCallout

    Properties

    addCallout: (
        name: string,
        options: Omit<CalloutOption, "className"> & {
            html?: string;
            location?: IPoint2D;
            style?: Partial<ICalloutStyle>;
        },
    ) => void

    添加 callout。

    若同名 callout 已存在，会由底层 callout 管理器按同名对象处理。

    Type declaration

      • (
            name: string,
            options: Omit<CalloutOption, "className"> & {
                html?: string;
                location?: IPoint2D;
                style?: Partial<ICalloutStyle>;
            },
        ): void

      • Parameters

        • name: string

          callout 名称，用于后续查询、更新和移除。

        • options: Omit<CalloutOption, "className"> & {
              html?: string;
              location?: IPoint2D;
              style?: Partial<ICalloutStyle>;
          }

          callout 参数，可设置样式、地图位置和 HTML 内容。

        Returns void

    getCallout: (
        name: string,
    ) => { location: IPoint2D | undefined; name: string } | undefined

    获取指定 callout 的基础信息。

    Type declaration

      • (name: string): { location: IPoint2D | undefined; name: string } | undefined

      • Parameters

        • name: string

          callout 名称。

        Returns { location: IPoint2D | undefined; name: string } | undefined

        callout 名称和当前位置；指定名称不存在时返回 undefined。

    removeAllCallouts: () => void

    移除所有 callout。

    removeCallout: (name: string) => void

    移除指定 callout。

    Type declaration

      • (name: string): void

      • Parameters

        • name: string

          要移除的 callout 名称。

        Returns void

    updateCallout: (
        name: string,
        options: Omit<CalloutOption, "className"> & {
            html?: string;
            location?: IPoint2D;
            style?: Partial<ICalloutStyle>;
        },
    ) => void

    修改已存在的 callout。

    未传入的选项会保持原值；当指定名称不存在时不产生效果。

    Type declaration

      • (
            name: string,
            options: Omit<CalloutOption, "className"> & {
                html?: string;
                location?: IPoint2D;
                style?: Partial<ICalloutStyle>;
            },
        ): void

      • Parameters

        • name: string

          callout 名称。

        • options: Omit<CalloutOption, "className"> & {
              html?: string;
              location?: IPoint2D;
              style?: Partial<ICalloutStyle>;
          }

          要更新的 callout 参数。

        Returns void

    Settings

    Member Visibility

    On This Page

    Properties