Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ContextMenu<ExtraData>

Type parameters

  • ExtraData = any

Hierarchy

Index

Constructors

Methods

Constructors

constructor

  • 地图右键菜单

    Type parameters

    • ExtraData = any

    Parameters

    Returns ContextMenu<ExtraData>

Methods

addItem

  • addItem(text: string, fn: () => void, num?: number): void

  • 右键菜单中添加菜单项

    Parameters

    • text: string

      菜单显示内容

    • fn: () => void

      该菜单下需进行的操作

        • (): void

        • Returns void

    • Optional num: number

      当前菜单项在右键菜单中的排序位置，以0开始

    Returns void

close

  • close(): void

  • 关闭右键菜单

    Returns void

emit

  • emit(eventName: string, data?: any): ContextMenu<ExtraData>

  • 触发事件

    Parameters

    • eventName: string

      事件名称

    • Optional data: any

      事件数据

    Returns ContextMenu<ExtraData>

getExtData

  • getExtData(): {} | ExtraData

  • 获取自定义数据

    Returns {} | ExtraData

getHeight

  • getHeight(): string | number

  • Returns string | number

getMap

  • getMap(): Map

  • 获取所属地图

    Returns Map

hide

  • hide(): void

  • 隐藏覆盖物

    Returns void

off

  • off<C>(eventName: string, handler: "mv" | ((event: any) => void), context?: C): ContextMenu<ExtraData>

  • 移除事件绑定

    Type parameters

    Parameters

    • eventName: string

      事件名称

    • handler: "mv" | ((event: any) => void)

      事件功能函数

    • Optional context: C

      事件上下文

    Returns ContextMenu<ExtraData>

on

  • on<C>(eventName: string, handler: (event: any) => void, context?: C, once?: boolean, unshift?: boolean): ContextMenu<ExtraData>

  • 注册事件

    Type parameters

    Parameters

    • eventName: string

      事件名称

    • handler: (event: any) => void

      事件回调函数

        • (event: any): void

        • Parameters

          • event: any

          Returns void

    • Optional context: C

      事件回调中的上下文

    • Optional once: boolean

      触发一次

    • Optional unshift: boolean

      更改事件顺序

    Returns ContextMenu<ExtraData>

open

  • 在地图的指定位置打开右键菜单。

    Parameters

    Returns void

removeItem

  • removeItem(text: string, fn: () => void): void

  • 删除一个菜单项

    Parameters

    • text: string

      菜单显示内容

    • fn: () => void

      该菜单下需进行的操作

        • (): void

        • Returns void

    Returns void

setExtData

  • setExtData(extData: ExtraData): void

  • 设置自定义数据

    Parameters

    • extData: ExtraData

      自定义数据

    Returns void

setHeight

  • setHeight(height?: string | number): void

  • Parameters

    • Optional height: string | number

    Returns void

setMap

  • setMap(map: Map): void

  • 设置所属地图

    Parameters

    • map: Map

      地图

    Returns void

show

  • show(): void

  • 显示覆盖物

    Returns void

Generated using TypeDoc