Class SVGOverlay<S>

Type Parameters

S = {}

Hierarchy

SVGOverlay<this> & ReactiveLayer<any, this>
WithLayerState<S>
- SVGOverlay
  - ReactSVGOverlay

Index

Constructors

constructor

Accessors

size

Constructors

constructor

new SVGOverlay<S>(el: string | SVGElement, position: LatLngExpression, sizeX: number, sizeY: number, options?: ImageOverlayOptions): SVGOverlay<S>
Type Parameters
- S = {}
Parameters
- el: string | SVGElement
- position: LatLngExpression
- sizeX: number
- sizeY: number
- Optional options: ImageOverlayOptions
Returns SVGOverlay<S>
Overrides mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).constructor
- Defined in src/2d/basic/SVGOverlay.class.ts:39

Properties

`Readonly` $$isReactive

$$isReactive: true

$$parent

$$parent: IList<ReactiveLayer<any>>

container object

$$ref

$$ref: any

data which will be mount on layer to render.

when you are too lazy to design a model (from Base), ref is the best alternative.

all reactive layer is with ref.

$$subSystems

$$subSystems: ReactiveLayer<any>[]

systems which are all in this.

$$system

$$system: ReactiveLayer<any>

reactive layer in which this layer is.

__preSize

__preSize: Point = null

the size before changed.

_bounds

_bounds: LatLngBounds

world bounds.

_fromBoundsMark

_fromBoundsMark: Rectangle<any>

_headStateHasChanged

_headStateHasChanged: boolean

a signal indicating whether the head state has changed.

_image

_image: HTMLElement

_immediatelyRenderOnce

_immediatelyRenderOnce: boolean

render the state syncronize

_isRenderScheduled

_isRenderScheduled: boolean

_lastRenderedEffect

_lastRenderedEffect: ReactiveLayerRenderEffect

_map

_map: WikMap

_mapToAdd

_mapToAdd: WikMap

`Private` _size

_size: Point = null

_uiStateChangeLogs

_uiStateChangeLogs: any[]

logs to record the state before calling onXX. It's data onXX returns.

angle

angle: number

控制图形的旋转角度

anglePhase

anglePhase: number

the start angle.

`Readonly` disableMatrix

disableMatrix: boolean

If you want to disable matrix transformation.

which means it is an object exsiting in the root system without any sub-system.

dragging

dragging: WikDraggable

ifRender

ifRender: boolean

IF you want trigger render after this set call, set IfRender TRUE.

!Warn: ifRender will be reset to FALSE after rendered;

isClickEventFireCancelled

isClickEventFireCancelled: boolean

isMatrixNeedsUpdate

isMatrixNeedsUpdate: boolean

latlngs

latlngs: PolylineLatLngs

图形的顶点坐标

layerId

layerId: string

layerState

layerState: S

position

position: LatLng

控制图形的位置

`Readonly` renderingMode

renderingMode: ReactiveLayerRenderingMode = 'overlay'

scale

scale: LatLngLiteral

控制图形的缩放

worldMatrix

worldMatrix: mat3

Accessors

size

get size(): Point
Returns Point
- Defined in src/2d/basic/SVGOverlay.class.ts:27
set size(val: PointExpression): void
no reactive, if you mean react, use setSize instead.
Parameters
- val: PointExpression
Returns void
- Defined in src/2d/basic/SVGOverlay.class.ts:34

Methods

addChild

addChild(...children: ReactiveLayer<any>[]): void
Parameters
- Rest ...children: ReactiveLayer<any>[]
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).addChild
- Defined in src/mixins/ReactiveLayer.ts:76

`Optional` afterRender

afterRender(effect: ReactiveLayerRenderEffect): void
called after leaflet rendered.
Parameters
- effect: ReactiveLayerRenderEffect
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).afterRender
- Defined in src/mixins/ReactiveLayer.ts:138

cancelClickEventFire

cancelClickEventFire(): void
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).cancelClickEventFire
- Defined in src/model/basic/ClickCancel.ts:22

`Protected` computesSvgBoxRadius

computesSvgBoxRadius(): number
Returns number
- Defined in src/2d/basic/SVGOverlay.class.ts:66

computesVisibleObjectOffset

computesVisibleObjectOffset(boxRadius: number): number[]
svg 内可见物体（角度为 0 的时候）的位置
Parameters
- boxRadius: number
Returns number[]
- Defined in src/2d/basic/SVGOverlay.class.ts:96

getCientSize

getCientSize(): {
x: number;
y: number;
}
Returns {
x: number;
y: number;
}
- x: number
- y: number
- Defined in src/2d/basic/SVGOverlay.class.ts:59

getSVGLayout

getSVGLayout(): {
    r: number;
    size: number;
    transform: string;
    viewbox: string;
}
includes：viewbox/style/root G transform

Returns

Returns {
    r: number;
    size: number;
    transform: string;
    viewbox: string;
}
- r: number
- size: number
- transform: string
- viewbox: string
- Defined in src/2d/basic/SVGOverlay.class.ts:78

getSvgViewboxProp

getSvgViewboxProp(): string
Returns string
- Defined in src/2d/basic/SVGOverlay.class.ts:128

getTheWorld

getTheWorld<W>(): W
find the root system of this element by $$system
Type Parameters
- W extends ReactiveLayer<any, W>
Returns W
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).getTheWorld
- Defined in src/mixins/ReactiveLayer.ts:101

`Private` getVisibleObjectTransformStyle

getVisibleObjectTransformStyle(_r?: number, scale?: number, scaleY?: number): string
Returns
Parameters
- _r: number = 0
  
  We use this to compute the translation offset and rotation origin. If _r not provided, we call computesSvgBoxRadius.
- scale: number = 1
  
  We use this to scale
- scaleY: number = 1
Returns string
- Defined in src/2d/basic/SVGOverlay.class.ts:115

isChild

isChild(): boolean
Returns boolean
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).isChild
- Defined in src/mixins/ReactiveLayer.ts:78

leafletRender

leafletRender(): void
Returns void
Overrides mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).leafletRender
- Defined in src/2d/basic/SVGOverlay.class.ts:101

localToWorld

localToWorld(latlng: LatLngExpression): LatLng
Parameters
- latlng: LatLngExpression
Returns LatLng
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).localToWorld
- Defined in src/mixins/ReactiveLayer.ts:145

`Optional` onInit

onInit(): void
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).onInit
- Defined in src/mixins/ReactiveLayer.ts:106

`Optional` onLayerStateUpdate

onLayerStateUpdate(previousState: unknown): void
state
Parameters
- previousState: unknown
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).onLayerStateUpdate
- Defined in src/mixins/ReactiveLayer.ts:130

`Optional` onRender

onRender(effect: ReactiveLayerRenderEffect): void
All render cases, transform & state.
Parameters
- effect: ReactiveLayerRenderEffect
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).onRender
- Defined in src/mixins/ReactiveLayer.ts:134

`Optional` onRotate

onRotate(previousAngle: number): void
angle changes
Parameters
- previousAngle: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).onRotate
- Defined in src/mixins/ReactiveLayer.ts:118

`Optional` onScale

onScale(previousScale: LatLngLiteral): void
scale changes
Parameters
- previousScale: LatLngLiteral
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).onScale
- Defined in src/mixins/ReactiveLayer.ts:126

`Optional` onShapeUpdate

onShapeUpdate(previousLatlngs: PolylineLatLngs): void
latlngs changes
Parameters
- previousLatlngs: PolylineLatLngs
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).onShapeUpdate
- Defined in src/mixins/ReactiveLayer.ts:114

`Optional` onTransform

onTransform(snapshot: any): void
any of position/angle/scale/shape/size changes
Parameters
- snapshot: any
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).onTransform
- Defined in src/mixins/ReactiveLayer.ts:110

`Optional` onTranslate

onTranslate(previousPosition: LatLng): void
position changes
Parameters
- previousPosition: LatLng
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).onTranslate
- Defined in src/mixins/ReactiveLayer.ts:122

reRender

reRender(): void
run the render function again, it's a sync call, no post render call.

Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).reRender
- Defined in src/interfaces/Interactive.ts:99

redraw

redraw(): void
Returns void
- Defined in src/2d/basic/SVGOverlay.class.ts:144

removeChild

removeChild(...children: ReactiveLayer<any>[]): void
Parameters
- Rest ...children: ReactiveLayer<any>[]
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).removeChild
- Defined in src/mixins/ReactiveLayer.ts:77

requestRenderCall

requestRenderCall(effect: ReactiveLayerRenderEffect): void
Parameters
- effect: ReactiveLayerRenderEffect
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).requestRenderCall
- Defined in src/mixins/ReactiveLayer.ts:154

rotate

rotate(dDeg: number): void
Parameters
- dDeg: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).rotate
- Defined in src/mixins/ReactiveLayer.ts:94

scales

scales(dLat: number): void
Parameters
- dLat: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).scales
- Defined in src/mixins/ReactiveLayer.ts:95
scales(dLat: number, dLng: number): void
Parameters
- dLat: number
- dLng: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).scales
- Defined in src/mixins/ReactiveLayer.ts:96

setAngle

setAngle(deg: number): void
Parameters
- deg: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).setAngle
- Defined in src/mixins/ReactiveLayer.ts:85

setLat

setLat(lat: number): void
Parameters
- lat: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).setLat
- Defined in src/mixins/ReactiveLayer.ts:83

setLayerState

setLayerState(partial: Partial<S>): void
Parameters
- partial: Partial<S>
Returns void
Inherited from WithLayerState.setLayerState
- Defined in src/2d/interfaces.ts:16

setLng

setLng(lng: number): void
Parameters
- lng: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).setLng
- Defined in src/mixins/ReactiveLayer.ts:84

setLocalBounds

setLocalBounds(latlngBounds: LatLngBoundsExpression): void
Parameters
- latlngBounds: LatLngBoundsExpression
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).setLocalBounds
- Defined in src/mixins/ReactiveLayer.ts:89

setLocalLatLngs

setLocalLatLngs(latlngs: PolylineLatLngs): void
Parameters
- latlngs: PolylineLatLngs
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).setLocalLatLngs
- Defined in src/mixins/ReactiveLayer.ts:88

setPosition

setPosition(latlng: LatLngExpression): void
Parameters
- latlng: LatLngExpression
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).setPosition
- Defined in src/mixins/ReactiveLayer.ts:81
setPosition(lat: number, lng: number): void
Parameters
- lat: number
- lng: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).setPosition
- Defined in src/mixins/ReactiveLayer.ts:82

setScale

setScale(s: number): void
Parameters
- s: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).setScale
- Defined in src/mixins/ReactiveLayer.ts:86
setScale(sOnLat: number, sOnLng: number): void
Parameters
- sOnLat: number
- sOnLng: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).setScale
- Defined in src/mixins/ReactiveLayer.ts:87

setSize

setSize(x: number | Point, y?: number): void
与属性 size 不同的是，它会触发渲染
Parameters
- x: number | Point
- Optional y: number
Returns void
- Defined in src/2d/basic/SVGOverlay.class.ts:54

toSnapshot

toSnapshot(): ReactiveLayerSnapshot<any>
Returns ReactiveLayerSnapshot<any>
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).toSnapshot
- Defined in src/model/basic/Snapshot.ts:31

translate

translate(dLat: number, dLng: number): void
Parameters
- dLat: number
- dLng: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).translate
- Defined in src/mixins/ReactiveLayer.ts:91

translateLat

translateLat(dLat: number): void
Parameters
- dLat: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).translateLat
- Defined in src/mixins/ReactiveLayer.ts:92

translateLng

translateLng(dLng: number): void
Parameters
- dLng: number
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).translateLng
- Defined in src/mixins/ReactiveLayer.ts:93

traverse

traverse<T>(every: ((item: T) => void)): void
Type Parameters
- T extends ReactiveLayer<any, T> = ReactiveLayer<any>
Parameters
- every: ((item: T) => void)
  - - (item: T): void
    - Parameters
      
      item: T
      
      Returns void
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).traverse
- Defined in src/mixins/ReactiveLayer.ts:79

updateMatrix

updateMatrix(): void
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).updateMatrix
- Defined in src/mixins/ReactiveLayer.ts:143

updateWorldMatrix

updateWorldMatrix(): void
Returns void
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).updateWorldMatrix
- Defined in src/mixins/ReactiveLayer.ts:144

worldToLocal

worldToLocal(latlngExpr: LatLngExpression): LatLng
Parameters
- latlngExpr: LatLngExpression
Returns LatLng
Inherited from mix(L.SVGOverlay).with<L.SVGOverlay, ReactiveLayer>( ReactiveLayerMixin, ).worldToLocal
- Defined in src/mixins/ReactiveLayer.ts:146

Class SVGOverlay<S>

Type Parameters

S = {}

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

S = {}

Parameters

el: string | SVGElement

position: LatLngExpression

sizeX: number

sizeY: number

Optional options: ImageOverlayOptions

Returns SVGOverlay<S>

Properties

Readonly $$isReactive

$$parent

$$ref

$$subSystems

$$system

__preSize

_bounds

_fromBoundsMark

_headStateHasChanged

_image

_immediatelyRenderOnce

_isRenderScheduled

_lastRenderedEffect

_map

_mapToAdd

Private _size

_uiStateChangeLogs

angle

anglePhase

Readonly disableMatrix

dragging

ifRender

isClickEventFireCancelled

isMatrixNeedsUpdate

latlngs

layerId

layerState

position

Readonly renderingMode

scale

worldMatrix

Accessors

size

Returns Point

Parameters

val: PointExpression

Returns void

Methods

addChild

Parameters

Rest ...children: ReactiveLayer<any>[]

Returns void

Optional afterRender

Parameters

effect: ReactiveLayerRenderEffect

Returns void

cancelClickEventFire

Returns void

Protected computesSvgBoxRadius

Returns number

computesVisibleObjectOffset

Parameters

boxRadius: number

Returns number[]

getCientSize

Returns { x: number; y: number; }

x: number

y: number

getSVGLayout

`Optional` options: ImageOverlayOptions

`Readonly` $$isReactive

`Private` _size

`Readonly` disableMatrix

`Readonly` renderingMode

`Rest` ...children: ReactiveLayer<any>[]

`Optional` afterRender

`Protected` computesSvgBoxRadius

Returns {
x: number;
y: number;
}

Returns {
r: number;
size: number;
transform: string;
viewbox: string;
}

`Private` getVisibleObjectTransformStyle

`Optional` onInit

`Optional` onLayerStateUpdate

`Optional` onRender

`Optional` onRotate

`Optional` onScale

`Optional` onShapeUpdate

`Optional` onTransform

`Optional` onTranslate

`Rest` ...children: ReactiveLayer<any>[]