Class ImageLayer<S>

Type Parameters

S = {}

Hierarchy

Polygon<any, this> & ReactiveLayer<any, this>
WithLayerState<S>
- ImageLayer
  - Bot

Index

Constructors

constructor

Constructors

constructor

new ImageLayer<S>(imgSrc: string | ImageLayerDataSource, width: number, height: number): ImageLayer<S>
Type Parameters
- S = {}
Parameters
- imgSrc: string | ImageLayerDataSource
- width: number
- height: number
Returns ImageLayer<S>
Overrides mix(L.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).constructor
- Defined in src/2d/basic/ImageLayer.class.ts:30

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.

`Readonly` __DEFAULT_IMAGE__

__DEFAULT_IMAGE__: ImageLayerDataSource

_headStateHasChanged

_headStateHasChanged: boolean

a signal indicating whether the head state has changed.

_immediatelyRenderOnce

_immediatelyRenderOnce: boolean

render the state syncronize

_isRenderScheduled

_isRenderScheduled: boolean

_lastRenderedEffect

_lastRenderedEffect: ReactiveLayerRenderEffect

_mapToAdd

_mapToAdd: WikMap

_pxBounds

_pxBounds: Bounds

_renderer

_renderer: Canvas

_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.

`Protected` height

height: number = 0

ifRender

ifRender: boolean

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

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

`Protected` image

image: ImageLayerDataSource = null

`Private` imgSrc

imgSrc: string | ImageLayerDataSource

isClickEventFireCancelled

isClickEventFireCancelled: boolean

isMatrixNeedsUpdate

isMatrixNeedsUpdate: boolean

latlngs

latlngs: PolylineLatLngs

图形的顶点坐标

layerId

layerId: string

layerState

layerState: S

`Protected` needDrawBound

needDrawBound: boolean = false

If you need to draw bound.

position

position: LatLng

控制图形的位置

`Readonly` renderingMode

renderingMode: ReactiveLayerRenderingMode

scale

scale: LatLngLiteral

控制图形的缩放

`Protected` width

width: number = 0

worldMatrix

worldMatrix: mat3

Methods

_updatePath

_updatePath(): void
See
https://web.dev/canvas-performance/

I cannot inspect the performance improvement

Returns void
- Defined in src/2d/basic/ImageLayer.class.ts:104

addChild

addChild(...children: ReactiveLayer<any>[]): void
Parameters
- Rest ...children: ReactiveLayer<any>[]
Returns void
Inherited from mix(L.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).afterRender
- Defined in src/mixins/ReactiveLayer.ts:138

cancelClickEventFire

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

getImage

getImage(): ImageLayerDataSource
Returns ImageLayerDataSource
- Defined in src/2d/basic/ImageLayer.class.ts:74

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.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).getTheWorld
- Defined in src/mixins/ReactiveLayer.ts:101

isChild

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

leafletRender

leafletRender(): void
Returns void
Inherited from mix(L.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).leafletRender
- Defined in src/mixins/ReactiveLayer.ts:103

localToWorld

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

`Optional` onInit

onInit(): void
Returns void
Inherited from mix(L.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).onShapeUpdate
- Defined in src/mixins/ReactiveLayer.ts:114

onTransform

onTransform(): void
Returns void
Overrides mix(L.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).onTransform
- Defined in src/2d/basic/ImageLayer.class.ts:87

`Optional` onTranslate

onTranslate(previousPosition: LatLng): void
position changes
Parameters
- previousPosition: LatLng
Returns void
Inherited from mix(L.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).reRender
- Defined in src/interfaces/Interactive.ts:99

removeChild

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

requestRenderCall

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

rotate

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

scales

scales(dLat: number): void
Parameters
- dLat: number
Returns void
Inherited from mix(L.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).scales
- Defined in src/mixins/ReactiveLayer.ts:96

setAngle

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

setImage

setImage(imgSrc: string | ImageLayerDataSource, draw?: boolean): void
Parameters
- imgSrc: string | ImageLayerDataSource
- draw: boolean = false
Returns void
- Defined in src/2d/basic/ImageLayer.class.ts:55

setLat

setLat(lat: number): void
Parameters
- lat: number
Returns void
Inherited from mix(L.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).setLng
- Defined in src/mixins/ReactiveLayer.ts:84

setLocalBounds

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

setLocalLatLngs

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

setPosition

setPosition(latlng: LatLngExpression): void
Parameters
- latlng: LatLngExpression
Returns void
Inherited from mix(L.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).setPosition
- Defined in src/mixins/ReactiveLayer.ts:82

setScale

setScale(s: number): void
Parameters
- s: number
Returns void
Inherited from mix(L.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).setScale
- Defined in src/mixins/ReactiveLayer.ts:87

showBounds

showBounds(show?: boolean): void
Parameters
- show: boolean = true
Returns void
- Defined in src/2d/basic/ImageLayer.class.ts:82

toSnapshot

toSnapshot(): ReactiveLayerSnapshot<any>
Returns ReactiveLayerSnapshot<any>
Inherited from mix(L.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).translate
- Defined in src/mixins/ReactiveLayer.ts:91

translateLat

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

translateLng

translateLng(dLng: number): void
Parameters
- dLng: number
Returns void
Inherited from mix(L.Polygon).with<L.Polygon, 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.Polygon).with<L.Polygon, ReactiveLayer>( ReactiveLayerMixin, ).traverse
- Defined in src/mixins/ReactiveLayer.ts:79

updateMatrix

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

updateWorldMatrix

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

worldToLocal

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

Class ImageLayer<S>

Type Parameters

S = {}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

S = {}

Parameters

imgSrc: string | ImageLayerDataSource

width: number

height: number

Returns ImageLayer<S>

Properties

Readonly $$isReactive

$$parent

$$ref

$$subSystems

$$system

Readonly __DEFAULT_IMAGE__

_headStateHasChanged

_immediatelyRenderOnce

_isRenderScheduled

_lastRenderedEffect

_mapToAdd

_pxBounds

_renderer

_uiStateChangeLogs

angle

anglePhase

Readonly disableMatrix

Protected height

ifRender

Protected image

Private imgSrc

isClickEventFireCancelled

isMatrixNeedsUpdate

latlngs

layerId

layerState

Protected needDrawBound

position

Readonly renderingMode

scale

Protected width

worldMatrix

Methods

_updatePath

See

Returns void

addChild

Parameters

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

Returns void

Optional afterRender

Parameters

effect: ReactiveLayerRenderEffect

Returns void

cancelClickEventFire

Returns void

getImage

Returns ImageLayerDataSource

getTheWorld

Type Parameters

W extends ReactiveLayer<any, W>

Returns W

isChild

Returns boolean

leafletRender

Returns void

localToWorld

Parameters

latlng: LatLngExpression

Returns LatLng

Optional onInit

Returns void

`Readonly` $$isReactive

`Readonly` __DEFAULT_IMAGE__

`Readonly` disableMatrix

`Protected` height

`Protected` image

`Private` imgSrc

`Protected` needDrawBound

`Readonly` renderingMode

`Protected` width

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

`Optional` afterRender

`Optional` onInit

`Optional` onLayerStateUpdate

`Optional` onRender

`Optional` onRotate

`Optional` onScale

`Optional` onShapeUpdate

`Optional` onTranslate

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