Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Circle<ExtraData>

Type parameters

  • ExtraData = any

Hierarchy

Index

Constructors

Methods

Constructors

constructor

  • new Circle<ExtraData>(options?: Options<ExtraData>): Circle<ExtraData>

  • 圆形覆盖物

    Type parameters

    • ExtraData = any

    Parameters

    • Optional options: Options<ExtraData>

      覆盖物选项

    Returns Circle<ExtraData>

Methods

contains

  • 判断指定点坐标是否在圆内

    Parameters

    Returns boolean

emit

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

  • 触发事件

    Parameters

    • eventName: string

      事件名称

    • Optional data: any

      事件数据

    Returns Circle<ExtraData>

getBounds

  • 获取圆外切矩形范围

    Returns Bounds

getCenter

  • 获取圆中心点

    Returns LngLat

getExtData

  • getExtData(): {} | ExtraData

  • 获取自定义数据

    Returns {} | ExtraData

getHeight

  • getHeight(): string | number

  • Returns string | number

getMap

  • getMap(): Map

  • 获取所属地图

    Returns Map

getOptions

getPath

  • getPath(count?: number): LngLat[]

  • Parameters

    • Optional count: number

    Returns LngLat[]

getRadius

  • getRadius(): number

  • 获取圆形的半径

    Returns number

getVisible

  • getVisible(): boolean

  • 返回可见

    Returns boolean

getzIndex

  • getzIndex(): number

  • 获得层级

    Returns number

hide

  • hide(): void

  • 隐藏覆盖物

    Returns void

off

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

  • 移除事件绑定

    Type parameters

    Parameters

    • eventName: string

      事件名称

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

      事件功能函数

    • Optional context: C

      事件上下文

    Returns Circle<ExtraData>

on

  • on<C>(eventName: string, handler: (event: any) => void, context?: C, once?: boolean, unshift?: boolean): Circle<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 Circle<ExtraData>

setCenter

  • 设置圆中心点

    Parameters

    • center: LocationValue

      中心点经纬度

    • Optional preventEvent: boolean

      阻止触发事件

    Returns void

setDraggable

  • setDraggable(draggable: boolean): void

  • 设置是否可以拖拽

    Parameters

    • draggable: boolean

    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

setOptions

  • setOptions(options?: Options<ExtraData>): void

  • 修改选项

    Parameters

    • Optional options: Options<ExtraData>

      选项

    Returns void

setRadius

  • setRadius(radius: number, preventEvent?: boolean): void

  • 设置圆形的半径

    Parameters

    • radius: number

      半径

    • Optional preventEvent: boolean

      阻止触发事件

    Returns void

setzIndex

  • setzIndex(zIndex: number): void

  • 设置层级

    Parameters

    • zIndex: number

      层级

    Returns void

show

  • show(): void

  • 显示覆盖物

    Returns void

Generated using TypeDoc