ImageOverlay.md

ImageOverlay v1.4.0+

Examples

• Basic Usage

  import {
    RCMap,
    TileLayer,
    ImageOverlay,
    Popup,
    Tooltip
  } from 'rc-leaflet'
  
  (
    <RCMap crs center>
      <TileLayer />
      <ImageOverlay url bounds />
    </RCMap>
  )

• 设置DivOverlay

  // interactive必须设置
  (
    <ImageOverlay url bounds interactive>
      <Popup />
      <Tooltip />
    </ImageOverlay>
  )

Props

• url

  • type: string

  • required: true

  • 图片url

• bounds

  • type: L.LatLngBoundsExpression

  • required: true

  • 图片的视窗

• opacity

  • type: number

  • required: false

  • 图片的透明度

• alt

  • type: string

  • required: false

  • img标签的alt属性

• crossOrigin

  • type: boolean | string

  • required: false

  • img标签的crossorigin属性

• errorOverlayUrl

  • type: string

  • required: false

  • 图片加载失败时显示的url

• zIndex

  • type: number

  • required: false

  • 设置图片的z-index

• className

  • tpye: string

  • required: false

  • 设置图片的类名

• onLoad

  • type: (e: L.LeafletEvent) => void

  • required: false

  • 图片加载成功的回调

• onError

  • type: (e: L.LeafletEvent) => void

  • required: false

  • 图片加载失败的回调

Props inherited from InteractiveLayer

• interactive

  • type: boolean

  • required: false

  • ImageOverlay是否具有交互效果

• bubblingMouseEvents

  • type: boolean

  • required: false

  • ImageOverlay的鼠标事件是否冒泡

Props inherited from Layer

• pane

  • type: string

  • required: false

  • default: overlayPane

  • 放置ImageOverlay的地图图层名称

• attribution

  • type: string

  • required: false

  • 版权描述

• onCreate

  • type: (layer: L.Layer) => void

  • required: false

  • ImageOverlay创建之后的回调

• onAdd

  • type: (e: L.LeafletEvent, layer: L.Layer) => void

  • required: false

  • ImageOverlay添加到图层之后的回调

• onUpdate

  • type: (layer: L.Layer) => void

  • required: false

  • ImageOverlay发生更新之后的回调

• onBeforeRemove

  • type: (layer: L.Layer) => void

  • required: false

  • ImageOverlay在删除之前的回调

• onRemove

  • type: (e: L.LeafletEvent, layer: L.Layer) => void

  • required: false

  • ImageOverlay删除时的回调

Props inherited from Evented

• onClick

  • type: (e: L.LeafletMouseEvent) => void

  • required: false

  • ImageOverlay鼠标点击时的回调

• onMouseOver

  • type: (e: L.LeafletMouseEvent) => void

  • required: false

  • ImageOverlay鼠标进入时的回调

• onMouseOut

  • type: (e: L.LeafletMouseEvent) => void

  • required: false

  • ImageOverlay鼠标离开时的回调