FeatureGroup.md

September 23, 2019 · View on GitHub

FeatureGroup v1.4.0+

Examples

  • Basic Usage

    import {
  RCMap,
  TileLayer,
  LayerGroup,
  FeatureGroup,
  GeoJSON,
  Point,
  CircleMarker,
  Circle,
  Polyline,
  Polygon,
  Rectangle,
  ImageOverlay,
  VideoOverlay,
  SVGOverlay,
  Popup,
  Tooltip
} from 'rc-leaflet'

(
  <RCMap crs center>
    <TileLayer />
    <FeatureGroup>
      <Point />
      <CircleMarker />
      <Circle />
      <Polyline />
      <Polygon />
      <Rectangle />
      <ImageOverlay />
      <VideoOverlay />
      <SVGOverlay />
      <Popup />
      <Tooltip />
    </FeatureGroup>
  </RCMap>
)

  • 统一设置Path样式

    (
  <FeatureGroup color weight>
    <Circle />
    <Circle color /> {/* 覆盖统一样式 */}
  </FeatureGroup>
)

  • 多层嵌套

    (
  <FeatureGroup>
    <Circle />
    <LayerGroup />
    <FeatureGroup />
    <GeoJSON />
  </FeatureGroup>
)

Props

  • zIndex

    • type: number

    • required: false

    • 只对Point和基于ImageOverlay的组件起作用

Props inherited from Path

  • stroke

    • type: boolean

    • required: false

    • FeatureGroup是否描边

  • color

    • type: string

    • required: false

    • FeatureGroup边的颜色

  • opacity

    • type: number

    • required: false

    • FeatureGroup的透明度

  • lineCap

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

    • required: false

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

  • lineJoin

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

    • required: false

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

  • dashArray

    • type: string | number[]

    • required: false

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

  • dashOffset

    • type: string

    • required: false

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

  • fill

    • type: boolean

    • required: false

    • FeatureGroup是否填充颜色

  • fillColor

    • type: string

    • required: false

    • 设置FeatureGroup填充颜色

  • fillOpacity

    • type: number

    • required: false

    • 设置FeatureGroup填充透明度

  • fillRule

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

    • required: false

    • 设置FeatureGroup填充规则

  • renderer

    • type: L.Renderer

    • required: false

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

  • className

    • tpye: string

    • required: false

    • 设置FeatureGroup的类名

Props inherited from InteractiveLayer

  • interactive

    • type: boolean

    • required: false

    • FeatureGroup是否具有交互效果

  • bubblingMouseEvents

    • type: boolean

    • required: false

    • FeatureGroup的鼠标事件是否冒泡

Props inherited from Layer

  • pane

    • type: string

    • required: false

    • default: overlayPane

    • 放置FeatureGroup的地图图层名称

  • attribution

    • type: string

    • required: false

    • 版权描述

  • onCreate

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

    • required: false

    • FeatureGroup创建之后的回调

  • onAdd

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

    • required: false

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

  • onUpdate

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

    • required: false

    • FeatureGroup发生更新之后的回调

  • onBeforeRemove

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

    • required: false

    • FeatureGroup在删除之前的回调

  • onRemove

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

    • required: false

    • FeatureGroup删除时的回调

Props inherited from Evented

  • onClick

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

    • required: false

    • FeatureGroup鼠标点击时的回调

  • onMouseOver

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

    • required: false

    • FeatureGroup鼠标进入时的回调

  • onMouseOut

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

    • required: false

    • FeatureGroup鼠标离开时的回调