SVGOverlay.md

September 23, 2019 · View on GitHub

SVGOverlay v1.4.0+

Examples

  • Basic Usage

    import {
      RCMap,
      TileLayer,
      SVGOverlay,
      Popup,
      Tooltip
    } from 'rc-leaflet'
    
    (
      <RCMap crs center>
        <TileLayer />
        <SVGOverlay bounds>
          <SVGOverlay.Content>
            <path />
            <line />
            <circle />
          </SVGOverlay.Content>
        </SVGOverlay>
      </RCMap>
    )
    
  • 设置DivOverlay

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

Props inherited from ImageOverlay

  • bounds

    • type: L.LatLngBoundsExpression

    • required: true

    • SVGOverlay的视窗

  • opacity

    • type: number

    • required: false

    • SVGOverlay的透明度

  • alt

    • type: string

    • required: false

    • svg标签的alt属性

  • crossOrigin

    • type: boolean | string

    • required: false

    • svg标签的crossorigin属性

  • errorOverlayUrl

    • type: string

    • required: false

    • SVGOverlay加载失败时显示的url

  • zIndex

    • type: number

    • required: false

    • 设置SVGOverlayz-index

  • className

    • tpye: string

    • required: false

    • 设置SVGOverlay的类名

  • onLoad

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

    • required: false

    • SVGOverlay加载成功的回调

  • onError

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

    • required: false

    • SVGOverlay加载失败的回调

Props inherited from InteractiveLayer

  • interactive

    • type: boolean

    • required: false

    • SVGOverlay是否具有交互效果

  • bubblingMouseEvents

    • type: boolean

    • required: false

    • SVGOverlay的鼠标事件是否冒泡

Props inherited from Layer

  • pane

    • type: string

    • required: false

    • default: overlayPane

    • 放置SVGOverlay的地图图层名称

  • attribution

    • type: string

    • required: false

    • 版权描述

  • onCreate

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

    • required: false

    • SVGOverlay创建之后的回调

  • onAdd

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

    • required: false

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

  • onUpdate

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

    • required: false

    • SVGOverlay发生更新之后的回调

  • onBeforeRemove

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

    • required: false

    • SVGOverlay在删除之前的回调

  • onRemove

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

    • required: false

    • SVGOverlay删除时的回调

Props inherited from Evented

  • onClick

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

    • required: false

    • SVGOverlay鼠标点击时的回调

  • onMouseOver

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

    • required: false

    • SVGOverlay鼠标进入时的回调

  • onMouseOut

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

    • required: false

    • SVGOverlay鼠标离开时的回调