Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Text<ExtraData>

Type parameters

  • ExtraData = any

Hierarchy

Index

Constructors

Methods

Constructors

constructor

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

  • 纯文本标记

    Type parameters

    • ExtraData = any

    Parameters

    Returns Text<ExtraData>

Methods

emit

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

  • 触发事件

    Parameters

    • eventName: string

      事件名称

    • Optional data: any

      事件数据

    Returns Text<ExtraData>

getAnchor

  • 获取锚点

    Returns Anchor

getAngle

  • getAngle(): number
  • 获取点标记的旋转角度

    Returns number

getAnimation

getClickable

  • getClickable(): boolean
  • 获取点标记是否支持鼠标单击事件

    Returns boolean

getContent

  • getContent(): string | HTMLElement

  • 获取点标记内容

    Returns string | HTMLElement

getDraggable

  • getDraggable(): boolean

  • 获取点标记对象是否可拖拽移动

    Returns boolean

getExtData

  • getExtData(): {} | ExtraData

  • 获取自定义数据

    Returns {} | ExtraData

getHeight

  • getHeight(): string | number

  • Returns string | number

getIcon

  • getIcon(): string | Icon

  • 获取Icon内容

    Returns string | Icon

getLabel

  • 获取点标记文本标签内容

    Returns Label

getMap

  • getMap(): Map

  • 获取所属地图

    Returns Map

getOffset

  • 获取偏移量

    Returns Pixel

getPosition

  • 获取点标记的位置

    Returns LngLat

getShadow

  • getShadow(): string | Icon

  • 获取阴影图标

    Returns string | Icon

getShape

getText

  • getText(): string

  • 标记显示的文本内容

    Returns string

getTitle

  • getTitle(): string

  • 获取点标记的文字提示

    Returns string

getTop

  • getTop(): boolean

  • 获取是否展示在最顶层

    Returns boolean

getzIndex

  • getzIndex(): number

  • 获取点标记的叠加顺序

    Returns number

hide

  • hide(): void

  • 隐藏覆盖物

    Returns void

markOnAMAP

  • markOnAMAP(obj?: { name?: string; position?: LocationValue }): void

  • 唤起高德地图客户端标注页

    Parameters

    Returns void

moveAlong

  • moveAlong(path: LngLat[], speed: number, timingFunction?: (t: number) => number, circleable?: boolean): void

  • 以指定的速度，点标记沿指定的路径移动

    Parameters

    • path: LngLat[]

      移动轨迹

    • speed: number

      速度

    • Optional timingFunction: (t: number) => number

      缓动函数

        • (t: number): number

        • Parameters

          • t: number

          Returns number

    • Optional circleable: boolean

      是否循环

    Returns void

moveTo

  • moveTo(lnglat: LocationValue, speed: number, timingFunction?: (t: number) => number): void

  • 以给定速度移动点标记到指定位置

    Parameters

    • lnglat: LocationValue

      目标位置

    • speed: number

      速度

    • Optional timingFunction: (t: number) => number

      缓动函数

        • (t: number): number

        • Parameters

          • t: number

          Returns number

    Returns void

off

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

  • 移除事件绑定

    Type parameters

    • C = Text<ExtraData>

    Parameters

    • eventName: string

      事件名称

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

      事件功能函数

    • Optional context: C

      事件上下文

    Returns Text<ExtraData>

on

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

  • 注册事件

    Type parameters

    • C = Text<ExtraData>

    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 Text<ExtraData>

pauseMove

  • pauseMove(): boolean
  • 暂定点标记的动画效果

    Returns boolean

resumeMove

  • resumeMove(): boolean

  • 重新开始点标记的动画效果

    Returns boolean

setAnchor

  • setAnchor(anchor?: Anchor): void

  • 设置锚点

    Parameters

    Returns void

setAngle

  • setAngle(angle: number): void
  • 设置点标记的旋转角度

    Parameters

    • angle: number

      旋转角度

    Returns void

setAnimation

  • 设置点标记的动画效果

    Parameters

    • animate: AnimationName

      动画效果类型

    • Optional prevent: boolean

    Returns void

setClickable

  • setClickable(cilckable: boolean): void

  • 设置点标记是支持鼠标单击事件

    Parameters

    • cilckable: boolean

      是否支持点击

    Returns void

setContent

  • setContent(content: string | HTMLElement): void
  • 设置点标记显示内容，可以是HTML要素字符串或者HTML DOM对象

    Parameters

    • content: string | HTMLElement

      显示内容

    Returns void

setCursor

  • setCursor(cursor: string): void

  • 设置鼠标悬停时的光标

    Parameters

    • cursor: string

      光标

    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

setIcon

  • setIcon(content: string | Icon): void

  • 设置点标记的显示图标

    Parameters

    • content: string | Icon

      图标

    Returns void

setLabel

  • setLabel(label?: Label): void

  • 设置点标记文本标签内容

    Parameters

    • Optional label: Label

      标签内容

    Returns void

setMap

  • setMap(map: Map): void

  • 指定目标显示地图

    Parameters

    • map: Map

      地图

    Returns void

setOffset

  • setOffset(offset: Pixel): void
  • 设置偏移量

    Parameters

    • offset: Pixel

      偏移量

    Returns void

setPosition

  • 设置点标记位置

    Parameters

    Returns void

setShadow

  • setShadow(icon?: string | Icon): void

  • 设置阴影效果

    Parameters

    • Optional icon: string | Icon

      阴影效果

    Returns void

setShape

  • 设置可点击区域

    Parameters

    Returns void

setStyle

  • setStyle(style: object): void

  • 设置文本样式

    Parameters

    • style: object

      文本样式

    Returns void

setText

  • setText(text: string): void

  • 修改文本内容

    Parameters

    • text: string

      文本内容

    Returns void

setTitle

  • setTitle(title: string): void

  • 鼠标滑过点标时的文字提示

    Parameters

    • title: string

      提示文字

    Returns void

setTop

  • setTop(isTop: boolean): void

  • 设置是否展示在最顶层

    Parameters

    • isTop: boolean

      是否展示在最顶层

    Returns void

setzIndex

  • setzIndex(index: number): void

  • 设置点标记的叠加顺序

    Parameters

    • index: number

      层级

    Returns void

show

  • show(): void

  • 显示覆盖物

    Returns void

stopMove

  • stopMove(): void

  • 点标记停止动画

    Returns void

Generated using TypeDoc