Skip to content

Circle.md

Latest commit

 

History

History
283 lines (160 loc) · 3.67 KB

Circle.md

File metadata and controls

283 lines (160 loc) · 3.67 KB

Circle

Examples

  • Basic Usage

    import {
  RCMap,
  Theme,
  TileLayer,
  Circle,
  Popup,
  Tooltip
} from 'rc-leaflet'

(
  <RCMap crs center>
    <TileLayer />
    <Circle center radius />
  </RCMap>
)

  • 统一设置Path样式

    const theme = {
  path: {
    color: '#ff0000',
    opacity: 0.5
  }
}

(
  <Theme value={theme}>
    <RCMap crs center>
      <TileLayer />
      <Circle />
      <Circle color /> {/* 覆盖统一样式 */}
    </RCMap>
  </Theme>
)

  • 设置DivOverlay

    (
  <Circle center radius>
    <Popup />
    <Tooltip />
  </Circle>
)

Props

  • center

    • type: L.LatLngExpression

    • required: true

    • 圆的中心坐标

  • radius

    • type: number

    • required: true

    • 圆的中心半径, 单位米

Props inherited from Path

  • stroke

    • type: boolean

    • required: false

    • Circle是否描边

  • color

    • type: string

    • required: false

    • Circle边的颜色

  • opacity

    • type: number

    • required: false

    • Circle的透明度

  • lineCap

    • type: 'butt' | 'round' | 'square' | 'inherit'

    • required: false

    • 在Circle有描边的情况下设置描边两端的形状

  • lineJoin

    • type: 'miter' | 'round' | 'bevel' | 'inherit'

    • required: false

    • 在Circle有描边的情况下设置描边拐角处的形状

  • dashArray

    • type: string | number[]

    • required: false

    • 在Circle有描边的情况下设置描边段落样式

  • dashOffset

    • type: string

    • required: false

    • 在Circle有描边的情况下设置描边段落偏移量

  • fill

    • type: boolean

    • required: false

    • Circle是否填充颜色

  • fillColor

    • type: string

    • required: false

    • 设置Circle填充颜色

  • fillOpacity

    • type: number

    • required: false

    • 设置Circle填充透明度

  • fillRule

    • type: 'nonzero' | 'evenodd' | 'inherit'

    • required: false

    • 设置Circle填充规则

  • renderer

    • type: L.Renderer

    • required: false

    • 设置Circle的渲染底层, 分SVG或Canvas

  • className

    • tpye: string

    • required: false

    • 设置Circle的类名

Props inherited from InteractiveLayer

  • interactive

    • type: boolean

    • required: false

    • Circle是否具有交互效果

  • bubblingMouseEvents

    • type: boolean

    • required: false

    • Circle的鼠标事件是否冒泡

Props inherited from Layer

  • pane

    • type: string

    • required: false

    • default: overlayPane

    • 放置Circle的地图图层名称

  • attribution

    • type: string

    • required: false

    • 版权描述

  • onCreate

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

    • required: false

    • Circle创建之后的回调

  • onAdd

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

    • required: false

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

  • onUpdate

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

    • required: false

    • Circle发生更新之后的回调

  • onBeforeRemove

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

    • required: false

    • Circle在删除之前的回调

  • onRemove

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

    • required: false

    • Circle删除时的回调

Props inherited from Evented

  • onClick

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

    • required: false

    • Circle鼠标点击时的回调

  • onMouseOver

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

    • required: false

    • Circle鼠标进入时的回调

  • onMouseOut

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

    • required: false

    • Circle鼠标离开时的回调