Interface MapView

Hierarchy

RenderView
- MapView

Implemented by

Index

Properties

Accessors

Methods

Properties

anchor

anchor: PointR2

bounds

bounds: BoxR2

canvasView

canvasView: CanvasView | null

culled

culled: boolean

dirty

dirty: boolean

hidden

hidden: boolean

hitBounds

hitBounds: BoxR2 | null

pixelRatio

pixelRatio: number

projection

projection: MapProjection

viewController

viewController: MapViewController | null

zoom

zoom: number

Accessors

appView

get appView(): AppView | null

Inherited from View.appView
- Defined in swim-ui-js/@swim/view/main/View.ts:131
Returns AppView | null

childViews

get childViews(): ReadonlyArray<View>

Inherited from View.childViews
- Defined in swim-ui-js/@swim/view/main/View.ts:166
Returns ReadonlyArray<View>

clientBounds

get clientBounds(): BoxR2

Inherited from View.clientBounds
- Defined in swim-ui-js/@swim/view/main/View.ts:441
Returns BoxR2

clientTransform

get clientTransform(): Transform

Inherited from View.clientTransform
- Defined in swim-ui-js/@swim/view/main/View.ts:428
Returns the transformation from viewport coordinates to view coordinates.

Returns Transform

pageBounds

get pageBounds(): BoxR2

Inherited from View.pageBounds
- Defined in swim-ui-js/@swim/view/main/View.ts:411
Returns BoxR2

pageTransform

get pageTransform(): Transform

Inherited from View.pageTransform
- Defined in swim-ui-js/@swim/view/main/View.ts:402
Returns the transformation from page coordinates to view coordinates.

Returns Transform

parentTransform

get parentTransform(): Transform

Inherited from View.parentTransform
- Defined in swim-ui-js/@swim/view/main/View.ts:397
Returns the transformation from the parent view coordinates to view coordinates.

Returns Transform

parentView

get parentView(): View | null

Inherited from View.parentView
- Defined in swim-ui-js/@swim/view/main/View.ts:136
Returns View | null

popoverBounds

get popoverBounds(): BoxR2

Inherited from View.popoverBounds
- Defined in swim-ui-js/@swim/view/main/View.ts:421
Returns the bounding box, in page coordinates, to the edges of which attached popovers should point.

Returns BoxR2

viewObservers

get viewObservers(): ReadonlyArray<ViewObserver>

Inherited from View.viewObservers
- Defined in swim-ui-js/@swim/view/main/View.ts:79
Returns ReadonlyArray<ViewObserver>

Methods

Abstract addViewObserver

addViewObserver(viewObserver: ViewObserver): void

Inherited from View.addViewObserver
- Defined in swim-ui-js/@swim/view/main/View.ts:81
Parameters
- viewObserver: ViewObserver
Returns void

animate

animate(): void

Inherited from Animated.animate
- Defined in swim-ui-js/@swim/animate/main/Animated.ts:20
Returns void

Abstract appendChildView

appendChildView(childView: View): void

Inherited from View.appendChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:181
Parameters
- childView: View
Returns void

cascadeAnimate

cascadeAnimate(frame: number): void

Inherited from AnimatedView.cascadeAnimate
- Defined in swim-ui-js/@swim/view/main/AnimatedView.ts:22
Parameters
- frame: number
Returns void

cascadeCull

cascadeCull(): void

Inherited from RenderView.cascadeCull
- Defined in swim-ui-js/@swim/view/main/RenderView.ts:34
Returns void

cascadeLayout

cascadeLayout(): void

Inherited from View.cascadeLayout
- Defined in swim-ui-js/@swim/view/main/View.ts:331
Returns void

cascadeMount

cascadeMount(): void

Inherited from View.cascadeMount
- Defined in swim-ui-js/@swim/view/main/View.ts:238
Returns void

cascadeRender

cascadeRender(context: RenderingContext): void

Inherited from RenderView.cascadeRender
- Defined in swim-ui-js/@swim/view/main/RenderView.ts:28
Parameters
- context: RenderingContext
Returns void

cascadeResize

cascadeResize(): void

Inherited from View.cascadeResize
- Defined in swim-ui-js/@swim/view/main/View.ts:300
Returns void

cascadeScroll

cascadeScroll(): void

Inherited from View.cascadeScroll
- Defined in swim-ui-js/@swim/view/main/View.ts:362
Returns void

cascadeUnmount

cascadeUnmount(): void

Inherited from View.cascadeUnmount
- Defined in swim-ui-js/@swim/view/main/View.ts:269
Returns void

Protected didAddViewObserver

didAddViewObserver(viewObserver: ViewObserver): void

Inherited from View.didAddViewObserver
- Defined in swim-ui-js/@swim/view/main/View.ts:91
Parameters
- viewObserver: ViewObserver
Returns void

Protected didInsertChildView

didInsertChildView(childView: View, targetView: View | null | undefined): void

Inherited from View.didInsertChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:199
Parameters
- childView: View
- targetView: View | null | undefined
Returns void

Protected didLayout

didLayout(): void

Inherited from View.didLayout
- Defined in swim-ui-js/@swim/view/main/View.ts:354
Returns void

Protected didMount

didMount(): void

Inherited from View.didMount
- Defined in swim-ui-js/@swim/view/main/View.ts:261
Returns void

Protected didObserve

didObserve(callback: function): void

Inherited from View.didObserve
- Defined in swim-ui-js/@swim/view/main/View.ts:120
Parameters
- callback: function
  - - (this: this, viewObserver: ViewObserver): void
    - Parameters
      - this: this
      - viewObserver: ViewObserver
      Returns void
Returns void

Protected didRemoveChildView

didRemoveChildView(childView: View): void

Inherited from View.didRemoveChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:225
Parameters
- childView: View
Returns void

Protected didRemoveViewObserver

didRemoveViewObserver(viewObserver: ViewObserver): void

Inherited from View.didRemoveViewObserver
- Defined in swim-ui-js/@swim/view/main/View.ts:105
Parameters
- viewObserver: ViewObserver
Returns void

Protected didResize

didResize(): void

Inherited from View.didResize
- Defined in swim-ui-js/@swim/view/main/View.ts:323
Returns void

Protected didScroll

didScroll(): void

Inherited from View.didScroll
- Defined in swim-ui-js/@swim/view/main/View.ts:385
Returns void

Protected didSetKey

didSetKey(key: string | null): void

Inherited from View.didSetKey
- Defined in swim-ui-js/@swim/view/main/View.ts:55
Parameters
- key: string | null
Returns void

Protected didSetParentView

didSetParentView(parentView: View | null): void

Inherited from View.didSetParentView
- Defined in swim-ui-js/@swim/view/main/View.ts:158
Parameters
- parentView: View | null
Returns void

Protected didSetViewController

didSetViewController(viewController: ViewController | null): void

Inherited from View.didSetViewController
- Defined in swim-ui-js/@swim/view/main/View.ts:75
Parameters
- viewController: ViewController | null
Returns void

Protected didUnmount

didUnmount(): void

Inherited from View.didUnmount
- Defined in swim-ui-js/@swim/view/main/View.ts:292
Returns void

Abstract dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from View.dispatchEvent
- Defined in swim-ui-js/@swim/view/main/View.ts:451
Parameters
- event: Event
Returns boolean

getChildView

getChildView(key: string): View | null

Inherited from View.getChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:168
Parameters
- key: string
Returns View | null

hitTest

hitTest(x: number, y: number, context: RenderingContext): RenderView | null

Inherited from RenderView.hitTest
- Defined in swim-ui-js/@swim/view/main/RenderView.ts:52
Parameters
- x: number
- y: number
- context: RenderingContext
Returns RenderView | null

Abstract insertChildView

insertChildView(childView: View, targetView: View | null): void

Inherited from View.insertChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:185
Parameters
- childView: View
- targetView: View | null
Returns void

isMounted

isMounted(): boolean

Inherited from View.isMounted
- Defined in swim-ui-js/@swim/view/main/View.ts:233
Returns boolean

isVisible

isVisible(): boolean

Inherited from View.isVisible
- Defined in swim-ui-js/@swim/view/main/View.ts:443
Returns boolean

Abstract key

key(): string | null
key(key: string | null): this

Inherited from View.key
- Defined in swim-ui-js/@swim/view/main/View.ts:40
Returns string | null
Inherited from View.key
- Defined in swim-ui-js/@swim/view/main/View.ts:41
Parameters
- key: string | null
Returns this

Abstract off

off(type: string, listener: EventListenerOrEventListenerObject, options?: EventListenerOptions | boolean): this

Inherited from View.off
- Defined in swim-ui-js/@swim/view/main/View.ts:455
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: EventListenerOptions | boolean
Returns this

Abstract on

on(type: string, listener: EventListenerOrEventListenerObject, options?: AddEventListenerOptions | boolean): this

Inherited from View.on
- Defined in swim-ui-js/@swim/view/main/View.ts:453
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: AddEventListenerOptions | boolean
Returns this

Protected onAddViewObserver

onAddViewObserver(viewObserver: ViewObserver): void

Inherited from View.onAddViewObserver
- Defined in swim-ui-js/@swim/view/main/View.ts:87
Parameters
- viewObserver: ViewObserver
Returns void

Protected onInsertChildView

onInsertChildView(childView: View, targetView: View | null | undefined): void

Inherited from View.onInsertChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:195
Parameters
- childView: View
- targetView: View | null | undefined
Returns void

Protected onLayout

onLayout(): void

Inherited from View.onLayout
- Defined in swim-ui-js/@swim/view/main/View.ts:350
Returns void

Protected onMount

onMount(): void

Inherited from View.onMount
- Defined in swim-ui-js/@swim/view/main/View.ts:257
Returns void

Protected onRemoveChildView

onRemoveChildView(childView: View): void

Inherited from View.onRemoveChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:221
Parameters
- childView: View
Returns void

Protected onRemoveViewObserver

onRemoveViewObserver(viewObserver: ViewObserver): void

Inherited from View.onRemoveViewObserver
- Defined in swim-ui-js/@swim/view/main/View.ts:101
Parameters
- viewObserver: ViewObserver
Returns void

Protected onResize

onResize(): void

Inherited from View.onResize
- Defined in swim-ui-js/@swim/view/main/View.ts:319
Returns void

Protected onScroll

onScroll(): void

Inherited from View.onScroll
- Defined in swim-ui-js/@swim/view/main/View.ts:381
Returns void

Protected onSetKey

onSetKey(key: string | null): void

Inherited from View.onSetKey
- Defined in swim-ui-js/@swim/view/main/View.ts:51
Parameters
- key: string | null
Returns void

Protected onSetParentView

onSetParentView(parentView: View | null): void

Inherited from View.onSetParentView
- Defined in swim-ui-js/@swim/view/main/View.ts:148
Parameters
- parentView: View | null
Returns void

Protected onSetViewController

onSetViewController(viewController: ViewController | null): void

Inherited from View.onSetViewController
- Defined in swim-ui-js/@swim/view/main/View.ts:71
Parameters
- viewController: ViewController | null
Returns void

Protected onUnmount

onUnmount(): void

Inherited from View.onUnmount
- Defined in swim-ui-js/@swim/view/main/View.ts:288
Returns void

Abstract prependChildView

prependChildView(childView: View): void

Inherited from View.prependChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:183
Parameters
- childView: View
Returns void

Abstract remove

remove(): void

Inherited from View.remove
- Defined in swim-ui-js/@swim/view/main/View.ts:211
Returns void

Abstract removeAll

removeAll(): void

Inherited from View.removeAll
- Defined in swim-ui-js/@swim/view/main/View.ts:209
Returns void

Abstract removeChildView

removeChildView(childView: View): void

Inherited from View.removeChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:207
Parameters
- childView: View
Returns void

Abstract removeViewObserver

removeViewObserver(viewObserver: ViewObserver): void

Inherited from View.removeViewObserver
- Defined in swim-ui-js/@swim/view/main/View.ts:95
Parameters
- viewObserver: ViewObserver
Returns void

setAnchor

setAnchor(anchor: PointR2): void

Inherited from RenderView.setAnchor
- Defined in swim-ui-js/@swim/view/main/RenderView.ts:46
Parameters
- anchor: PointR2
Returns void

setBounds

setBounds(bounds: BoxR2): void

Inherited from RenderView.setBounds
- Defined in swim-ui-js/@swim/view/main/RenderView.ts:42
Parameters
- bounds: BoxR2
Returns void

Abstract setChildView

setChildView(key: string, newChildView: View | null): View | null

Inherited from View.setChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:179
Parameters
- key: string
- newChildView: View | null
Returns View | null

setCulled

setCulled(culled: boolean): void

Inherited from RenderView.setCulled
- Defined in swim-ui-js/@swim/view/main/RenderView.ts:38
Parameters
- culled: boolean
Returns void

setDirty

setDirty(dirty: boolean): void

Inherited from Animated.setDirty
- Defined in swim-ui-js/@swim/animate/main/Animated.ts:18
Parameters
- dirty: boolean
Returns void

setHidden

setHidden(hidden: boolean): void

Inherited from RenderView.setHidden
- Defined in swim-ui-js/@swim/view/main/RenderView.ts:32
Parameters
- hidden: boolean
Returns void

Abstract setParentView

setParentView(parentView: View | null): void

Inherited from View.setParentView
- Defined in swim-ui-js/@swim/view/main/View.ts:138
Parameters
- parentView: View | null
Returns void

setProjection

setProjection(projection: MapProjection): void

- Defined in swim-ux-js/@swim/map/main/MapView.ts:24
Parameters
- projection: MapProjection
Returns void

Abstract setViewController

setViewController(viewController: ViewController | null): void

Inherited from View.setViewController
- Defined in swim-ui-js/@swim/view/main/View.ts:65
Parameters
- viewController: ViewController | null
Returns void

setZoom

setZoom(zoom: number): void

- Defined in swim-ux-js/@swim/map/main/MapView.ts:28
Parameters
- zoom: number
Returns void

Protected willAddViewObserver

willAddViewObserver(viewObserver: ViewObserver): void

Inherited from View.willAddViewObserver
- Defined in swim-ui-js/@swim/view/main/View.ts:83
Parameters
- viewObserver: ViewObserver
Returns void

Protected willInsertChildView

willInsertChildView(childView: View, targetView: View | null | undefined): void

Inherited from View.willInsertChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:187
Parameters
- childView: View
- targetView: View | null | undefined
Returns void

Protected willLayout

willLayout(): void

Inherited from View.willLayout
- Defined in swim-ui-js/@swim/view/main/View.ts:342
Returns void

Protected willMount

willMount(): void

Inherited from View.willMount
- Defined in swim-ui-js/@swim/view/main/View.ts:249
Returns void

Protected willObserve

willObserve(callback: function): void

Inherited from View.willObserve
- Defined in swim-ui-js/@swim/view/main/View.ts:109
Parameters
- callback: function
  - - (this: this, viewObserver: ViewObserver): void
    - Parameters
      - this: this
      - viewObserver: ViewObserver
      Returns void
Returns void

Protected willRemoveChildView

willRemoveChildView(childView: View): void

Inherited from View.willRemoveChildView
- Defined in swim-ui-js/@swim/view/main/View.ts:213
Parameters
- childView: View
Returns void

Protected willRemoveViewObserver

willRemoveViewObserver(viewObserver: ViewObserver): void

Inherited from View.willRemoveViewObserver
- Defined in swim-ui-js/@swim/view/main/View.ts:97
Parameters
- viewObserver: ViewObserver
Returns void

Protected willResize

willResize(): void

Inherited from View.willResize
- Defined in swim-ui-js/@swim/view/main/View.ts:311
Returns void

Protected willScroll

willScroll(): void

Inherited from View.willScroll
- Defined in swim-ui-js/@swim/view/main/View.ts:373
Returns void

Protected willSetKey

willSetKey(key: string | null): void

Inherited from View.willSetKey
- Defined in swim-ui-js/@swim/view/main/View.ts:43
Parameters
- key: string | null
Returns void

Protected willSetParentView

willSetParentView(parentView: View | null): void

Inherited from View.willSetParentView
- Defined in swim-ui-js/@swim/view/main/View.ts:140
Parameters
- parentView: View | null
Returns void

Protected willSetViewController

willSetViewController(viewController: ViewController | null): void

Inherited from View.willSetViewController
- Defined in swim-ui-js/@swim/view/main/View.ts:67
Parameters
- viewController: ViewController | null
Returns void

Protected willUnmount

willUnmount(): void

Inherited from View.willUnmount
- Defined in swim-ui-js/@swim/view/main/View.ts:280
Returns void

Static create

create(tag: "svg"): SvgView
create(tag: "canvas"): CanvasView
create<K>(tag: K): HtmlView
create(tag: string): ElementView
create<V>(tag: ElementViewClass<Element, V>, key?: undefined | string): V

Inherited from View.create
- Defined in swim-ui-js/@swim/view/main/View.ts:485
Parameters
- tag: "svg"
Returns SvgView
Inherited from View.create
- Defined in swim-ui-js/@swim/view/main/View.ts:486
Parameters
- tag: "canvas"
Returns CanvasView
Inherited from View.create
- Defined in swim-ui-js/@swim/view/main/View.ts:487
Type parameters
- K: keyof HTMLElementTagNameMap
Parameters
- tag: K
Returns HtmlView
Inherited from View.create
- Defined in swim-ui-js/@swim/view/main/View.ts:488
Parameters
- tag: string
Returns ElementView
Inherited from View.create
- Defined in swim-ui-js/@swim/view/main/View.ts:489
Type parameters
- V: ElementView
Parameters
- tag: ElementViewClass<Element, V>
- Optional key: undefined | string
Returns V

Static fromNode

fromNode(node: HTMLCanvasElement): CanvasView
fromNode(node: HTMLElement): HtmlView
fromNode(node: SVGElement): SvgView
fromNode(node: Element): ElementView
fromNode(node: Text): TextView
fromNode(node: Node): NodeView

Inherited from View.fromNode
- Defined in swim-ui-js/@swim/view/main/View.ts:457
Parameters
- node: HTMLCanvasElement
Returns CanvasView
Inherited from View.fromNode
- Defined in swim-ui-js/@swim/view/main/View.ts:458
Parameters
- node: HTMLElement
Returns HtmlView
Inherited from View.fromNode
- Defined in swim-ui-js/@swim/view/main/View.ts:459
Parameters
- node: SVGElement
Returns SvgView
Inherited from View.fromNode
- Defined in swim-ui-js/@swim/view/main/View.ts:460
Parameters
- node: Element
Returns ElementView
Inherited from View.fromNode
- Defined in swim-ui-js/@swim/view/main/View.ts:461
Parameters
- node: Text
Returns TextView
Inherited from View.fromNode
- Defined in swim-ui-js/@swim/view/main/View.ts:462
Parameters
- node: Node
Returns NodeView