Class Label

constructor

• new Label(opts?): Label

• 构造函数，默认参数如下

  {
      text: '',
      position: new LatLng(39.914935, 116.403119),
      bgcolorstr: '#999',
      fontcolorstr: '#fff',
      fontsize: 12,
      fontType: SysEnum.FontType.NORMAL,
      rotate: 0,
      alignX: SysEnum.FontAlign.ALIGN_CENTER_HORIZONTAL,
      alignY: SysEnum.FontAlign.ALIGN_CENTER_VERTICAL
  }
  Copy

  Parameters

  • Optional opts: ILabelOption

  Returns Label

uuid

type

eventListener

isDestroyed

rotate

• set rotate(rotate): void

• 设置旋转角度

  Parameters

  • rotate: number

  Returns void

  Since

  1.0.0

typeName

• get typeName(): string

• Returns string

visible

• get visible(): boolean

• 获取显示状态

  Returns boolean

  Since

  1.0.0

• set visible(val): void

• 设置显示状态

  Parameters

  • val: boolean

  Returns void

  Since

  1.0.0

zIndex

• get zIndex(): number

• 获取覆盖物显示层级

  Returns number

  Since

  1.0.0

• set zIndex(val): void

• 设置覆盖物显示层级

  Parameters

  • val: number

  Returns void

  Since

  1.0.0

scaleX

• scaleX(scaleX): Label

• 设置X轴图标缩放比例

  Parameters

  • scaleX: number

    取值范围[0,}

  Returns Label

  Since

  1.0.0

getScaleX

• getScaleX(): number

• 获取X轴图标缩放比例

  Returns number

  Since

  1.0.0

setScaleX

• setScaleX(scaleX): void

• 设置X轴图标缩放比例

  Parameters

  • scaleX: number

    取值范围[0,}

  Returns void

  Since

  1.0.0

scaleY

• scaleY(scaleY): Label

• 设置Y轴图标缩放比例

  Parameters

  • scaleY: number

  Returns Label

  Since

  1.0.0

getScaleY

• getScaleY(): number

• 获取Y轴图标缩放比例

  Returns number

  Since

  1.0.0

setScaleY

• setScaleY(scaleY): void

• 设置Y轴图标缩放比例

  Parameters

  • scaleY: number

  Returns void

  Since

  1.0.0

yOffset

• yOffset(yOffset): Label

• 设置Y轴图标偏移量

  Parameters

  • yOffset: number

  Returns Label

  Since

  1.0.0

getYOffset

• getYOffset(): number

• 获取Y轴图标偏移量

  Returns number

  Since

  1.0.0

setYOffset

• setYOffset(yOffset): void

• 设置Y轴图标偏移量

  Parameters

  • yOffset: number

  Returns void

  Since

  1.0.0

xOffset

• xOffset(xOffset): Label

• 设置X轴图标偏移量

  Parameters

  • xOffset: number

  Returns Label

  Since

  1.1.0

getXOffset

• getXOffset(): number

• 获取X轴图标偏移量

  Returns number

  Since

  1.1.0

setXOffset

• setXOffset(xOffset): void

• 设置X轴图标偏移量

  Parameters

  • xOffset: number

  Returns void

  Since

  1.1.0

draggable

• draggable(draggable): Label

• 设置是否可拖动

  Parameters

  • draggable: boolean

  Returns Label

  Deprecated

  Since

  1.0.0

getDraggable

• getDraggable(): boolean

• 获取是否可拖动状态

  Returns boolean

  Deprecated

  Since

  1.0.0

setDraggable

• setDraggable(draggable): void

• 设置是否可拖动

  Parameters

  • draggable: boolean

  Returns void

  Deprecated

  Since

  1.0.0

flat

• flat(flat): Label

• 设置是否使用旋转基准是地理北方向

  Parameters

  • flat: boolean

  Returns Label

  Since

  1.2.0

getFlat

• getFlat(): boolean

• 获取是否使用旋转基准是地理北方向

  Returns boolean

  Since

  1.2.0

setFlat

• setFlat(flat): void

• 设置是否使用旋转基准是地理北方向

  Parameters

  • flat: boolean

  Returns void

  Since

  1.2.0

period

• period(period): Label

• 设置多少帧刷新一次图片资源

  Parameters

  • period: number

    帧数，刷新周期，值越小速度越快。默认为20，最小为1

  Returns Label

  Since

  1.0.0

getPeriod

• getPeriod(): number

• 获取多少帧刷新一次图片资源

  Returns number

  Since

  1.0.0

setPeriod

• setPeriod(period): void

• 设置多少帧刷新一次图片资源

  Parameters

  • period: number

    帧数，刷新周期，值越小速度越快。默认为20，最小为1

  Returns void

  Since

  1.0.0

position

• position(position): Label

• 设置图标位置

  Parameters

  • position: LatLng

  Returns Label

  Since

  1.0.0

getPosition

• getPosition(): LatLng

• 获取图标位置

  Returns LatLng

  Since

  1.0.0

setPosition

• setPosition(position): void

• 设置图标位置

  Parameters

  • position: LatLng

  Returns void

  Since

  1.0.0

changePosition

• changePosition(position): void

• 改变图标位置

  Parameters

  • position: LatLng

  Returns void

  Since

  1.0.0

popView

• popView(popView): Label

• 设置消息气泡

  Parameters

  • popView: PopView

  Returns Label

  Since

  1.1.0

setPopView

• setPopView(popView): void

• 设置消息气泡

  Parameters

  • popView: PopView

  Returns void

  Since

  1.1.0

getPopView

• getPopView(): PopView

• 获取消息气泡

  Returns PopView

  Since

  1.1.0

located

• located(located): void

• 设置绘制元素位于「基准Anchor」的方位

  Parameters

  • located: Located

  Returns void

  Since

  1.1.0

setLocated

• setLocated(located): void

• 设置绘制元素位于「基准Anchor」的方位

  Parameters

  • located: Located

  Returns void

  Since

  1.1.0

getLocated

• getLocated(): Located

• 获取绘制元素位于「基准Anchor」的方位

  Returns Located

  Since

  1.1.0

anchor

• anchor(anchorX, anchorY): Label

• 设置 marker 覆盖物的锚点比例，默认（0.5, 1.0）水平居中，垂直下对齐

  Parameters

  • anchorX: number

    取值范围[0.0 , 1.0]， 否则不生效
  • anchorY: number

    取值范围[0.0 , 1.0]， 否则不生效

  Returns Label

  Deprecated

  请使用located替代

  Since

  1.0.0

getAnchor

• getAnchor(): {
      anchorX: number;
      anchorY: number;
  }

• 获取 marker 覆盖物的锚点比例

  Returns {
      anchorX: number;
      anchorY: number;
  }

  • anchorX: number

  • anchorY: number

  Deprecated

  请使用getLocated替代

  Since

  1.0.0

setAnchor

• setAnchor(anchorX, anchorY): undefined | Label

• 设置 marker 覆盖物的锚点比例，默认（0.5, 1.0）水平居中，垂直下对齐

  Parameters

  • anchorX: number

    取值范围[0.0 , 1.0]， 否则不生效
  • anchorY: number

    取值范围[0.0 , 1.0]， 否则不生效

  Returns undefined | Label

  Deprecated

  请使用setLocated替代

  Since

  1.0.0

getRotate

• getRotate(): number

• 获取旋转角度

  Returns number

  Since

  1.0.0

setRotate

• setRotate(rotate): void

• 设置旋转角度

  Parameters

  • rotate: number

  Returns void

  Since

  1.0.0

isJoinCollision

• isJoinCollision(isJoinCollision): Label

• 设置marker是否参与碰撞检测

  Parameters

  • isJoinCollision: CollisionBehavior

  Returns Label

  Since

  1.1.0

getIsJoinCollision

• getIsJoinCollision(): CollisionBehavior

• 获取置marker是否参与碰撞检测

  Returns CollisionBehavior

  Since

  1.1.0

setIsJoinCollision

• setIsJoinCollision(isJoinCollision): void

• 设置marker是否参与碰撞检测

  Parameters

  • isJoinCollision: CollisionBehavior

  Returns void

  Since

  1.1.0

isFixed

• isFixed(isFix): void

• 设置 Marker 覆盖物是否固定屏幕位置

  Parameters

  • isFix: boolean

  Returns void

  Since

  1.0.0

setIsFixed

• setIsFixed(isFix): void

• 设置 Marker 覆盖物是否固定屏幕位置

  Parameters

  • isFix: boolean

  Returns void

  Since

  1.0.0

getFixedScreen

• getFixedScreen(): boolean

• 获取 Marker 是否启用屏幕固定位置

  Returns boolean

  Since

  1.0.0

fixedScreenPosition

• fixedScreenPosition(point): Label

• 设置 Marker 覆盖物的屏幕位置,用于固定marker不随地图移动

  Parameters

  • point: Nullable<Point>

    如果设置坐标，则代表启用固定屏幕像素坐标显示marker

  Returns Label

  Since

  1.0.1

setFixedScreenPosition

• setFixedScreenPosition(point): void

• 设置 Marker 覆盖物的屏幕位置,用于固定marker不随地图移动

  Parameters

  • point: Nullable<Point>

    如果设置坐标，则代表启用固定屏幕像素坐标显示marker

  Returns void

  Since

  1.0.0

perspective

• perspective(perspective): Label

• 设置是否开启 marker 覆盖物近大远小效果，默认开启

  Parameters

  • perspective: boolean

  Returns Label

  Since

  1.0.0

getPerspective

• getPerspective(): boolean

• 获取是否开启 marker 覆盖物近大远小效果

  Returns boolean

  Since

  1.0.0

setPerspective

• setPerspective(perspective): void

• 设置是否开启 marker 覆盖物近大远小效果，默认开启

  Parameters

  • perspective: boolean

  Returns void

  Since

  1.0.0

priority

• priority(priority): Label

• 设置碰撞时显示的优先级,取值范围 [0, 65535]

  Parameters

  • priority: number

  Returns Label

  Since

  1.0.0

getPriority

• getPriority(): number

• 获取碰撞时显示的优先级

  Returns number

  Since

  1.0.0

setPriority

• setPriority(priority): void

• 设置碰撞时显示的优先级,取值范围 [0, 65535]

  Parameters

  • priority: number

  Returns void

  Since

  1.0.0

getText

• getText(): string

• 获取文字内容

  Returns string

  Since

  1.0.0

text

• text(text): Label

• 设置文字内容

  Parameters

  • text: string

  Returns Label

  Since

  1.0.0

setText

• setText(text): void

• 设置文字内容

  Parameters

  • text: string

  Returns void

  Since

  1.0.0

getFontColor

• getFontColor(): {
      r: number;
      g: number;
      b: number;
      a: number;
      rgb: string;
      rgba: string;
  }

• 获取文字颜色

  Returns {
      r: number;
      g: number;
      b: number;
      a: number;
      rgb: string;
      rgba: string;
  }

  • r: number

  • g: number

  • b: number

  • a: number

  • rgb: string

  • rgba: string

  Since

  1.0.0

fontcolor

• fontcolor(color): Label

• 设置文字颜色

  Parameters

  • color: string

  Returns Label

  Since

  1.0.0

setFontColor

• setFontColor(color): void

• 设置文字颜色

  Parameters

  • color: string

  Returns void

  Since

  1.0.0

getBorderColor

• getBorderColor(): {
      r: number;
      g: number;
      b: number;
      a: number;
      rgb: string;
      rgba: string;
  }

• 获取文字描边颜色

  Returns {
      r: number;
      g: number;
      b: number;
      a: number;
      rgb: string;
      rgba: string;
  }

  • r: number

  • g: number

  • b: number

  • a: number

  • rgb: string

  • rgba: string

  Since

  1.2.0

borderColor

• borderColor(color): Label

• 设置文字描边颜色

  Parameters

  • color: string

  Returns Label

  Since

  1.2.0

setBorderColor

• setBorderColor(color): void

• 设置文字描边颜色

  Parameters

  • color: string

  Returns void

  Since

  1.2.0

borderSize

• borderSize(width): Label

• 设置文字描边宽度

  Parameters

  • width: number

  Returns Label

  Since

  1.2.0

setBorderSize

• setBorderSize(width): void

• 设置文字描边宽度

  Parameters

  • width: number

  Returns void

  Since

  1.2.0

getBorderSize

• getBorderSize(): number

• 获取文字描边宽度

  Returns number

  Since

  1.2.0

getBgColor

• getBgColor(): {
      r: number;
      g: number;
      b: number;
      a: number;
      rgb: string;
      rgba: string;
  }

• 获取文字背景颜色

  Returns {
      r: number;
      g: number;
      b: number;
      a: number;
      rgb: string;
      rgba: string;
  }

  • r: number

  • g: number

  • b: number

  • a: number

  • rgb: string

  • rgba: string

  Deprecated

  Since

  1.2.0

bgcolor

• bgcolor(color): Label

• 设置文字背景颜色

  Parameters

  • color: string

  Returns Label

  Deprecated

  Since

  1.2.0

setBgColor

• setBgColor(color): void

• 设置文字背景颜色

  Parameters

  • color: string

  Returns void

  Deprecated

  Since

  1.2.0

getFontSize

• getFontSize(): number

• 获取字体大小

  Returns number

  Since

  1.0.0

fontSize

• fontSize(size): Label

• 设置字体大小

  Parameters

  • size: number

  Returns Label

  Since

  1.0.0

setFontSize

• setFontSize(size): void

• 设置字体大小

  Parameters

  • size: number

  Returns void

  Since

  1.0.0

getFontType

• getFontType(): FontType

• 获取字体

  Returns FontType

  Since

  1.0.0

fontType

• fontType(type): Label

• 设置字体

  Parameters

  • type: FontType

  Returns Label

  Since

  1.0.0

setFontType

• setFontType(type): void

• 设置字体

  Parameters

  • type: FontType

  Returns void

  Since

  1.0.0

getAlign

• getAlign(): void

• 获取对齐方式

  Returns void

  Deprecated

  请使用located替代

  Since

  1.2.0

align

• align(alignx, aligny): Label

• 设置对齐方式

  Parameters

  • alignx: FontAlign
  • aligny: FontAlign

  Returns Label

  Deprecated

  请使用located替代

  Since

  1.2.0

setAlign

• setAlign(alignx, aligny): void

• 设置对齐方式

  Parameters

  • alignx: FontAlign
  • aligny: FontAlign

  Returns void

  Deprecated

  请使用located替代

  Since

  1.1.1

toString

• toString(): string

• Returns string

  Since

  1.0.1

addEventListener

• addEventListener(model, fun): void

• Parameters

  • model: OverlayEvent
  • fun: Function

  Returns void

  Since

  1.0.1

  History

  包1.0.0 版本中 model:string , 取值范围 'CLICK'、'TOUCH'

removeEventListener

• removeEventListener(model, fun): void

• Parameters

  • model: OverlayEvent
  • fun: Function

  Returns void

  Since

  1.0.1

  History

  包1.0.0 版本中 model:string , 取值范围 'CLICK'、'TOUCH'

getType

• getType(): number

• Returns number

setVisible

• setVisible(val): void

• 设置显示状态

  Parameters

  • val: boolean

  Returns void

  Since

  1.0.0

getVisible

• getVisible(): boolean

• 获取显示状态

  Returns boolean

  Since

  1.0.0

alpha

• alpha(alpha): Label

• 设置透明度

  Parameters

  • alpha: number

    取值范围[0,1]

  Returns Label

  Since

  1.0.0

getAlpha

• getAlpha(): number

• 获取透明度

  Returns number

  Since

  1.0.0

setAlpha

• setAlpha(alpha): void

• 设置透明度

  Parameters

  • alpha: number

    取值范围[0,1]

  Returns void

  Since

  1.0.0

startLevel

• startLevel(startLevel): Label

• 设置marker开始显示的地图缩放层级

  Parameters

  • startLevel: number

  Returns Label

  Since

  1.0.0

getStartLevel

• getStartLevel(): number

• 获取marker开始显示的地图缩放层级

  Returns number

  Since

  1.0.0

setStartLevel

• setStartLevel(startLevel): void

• 设置marker开始显示的地图缩放层级

  Parameters

  • startLevel: number

  Returns void

  Since

  1.0.0

endLevel

• endLevel(endLevel): Label

• 设置marker结束显示的地图缩放层级

  Parameters

  • endLevel: number

  Returns Label

  Since

  1.0.0

getEndLevel

• getEndLevel(): number

• 获取marker结束显示的地图缩放层级

  Returns number

  Since

  1.0.0

setEndLevel

• setEndLevel(endLevel): void

• 设置marker结束显示的地图缩放层级

  Parameters

  • endLevel: number

  Returns void

  Since

  1.0.0

clickable

• clickable(isClickable): Label

• 设置是否可点击

  Parameters

  • isClickable: boolean

  Returns Label

  Since

  1.0.0

getClickable

• getClickable(): boolean

• 获取是否可点击状态

  Returns boolean

  Since

  1.0.0

setClickable

• setClickable(isClickable): void

• 设置是否可点击

  Parameters

  • isClickable: boolean

  Returns void

  Since

  1.0.0

setZIndex

• setZIndex(val): void

• 设置覆盖物显示层级

  Parameters

  • val: number

  Returns void

  Since

  1.0.0

getZIndex

• getZIndex(): number

• 获取覆盖物显示层级

  Returns number

  Since

  1.0.0

setExtraInfo

• setExtraInfo(extraInfo): void

• 设置覆盖物属性数据

  Parameters

  • extraInfo: AnyObject

  Returns void

  Since

  1.0.0

getExtraInfo

• getExtraInfo(): AnyObject

• 获取覆盖物属性数据

  Returns AnyObject

  Since

  1.0.0

update

• update(): void

• Returns void

remove

• remove(noUpdate?): void

• 移除覆盖物

  Parameters

  • Optional noUpdate: boolean

  Returns void

  Since

  1.0.0

isRemoved

• isRemoved(): boolean

• 获取是否移除状态

  Returns boolean

  Since

  1.0.0

destroy

• destroy(): void

• 仅适用用户主动触发的销毁

  Returns void