Interface: InjectViewportResult
@roomful/angular / InjectViewportResult
Interface: InjectViewportResult
Section titled “Interface: InjectViewportResult”Defined in: angular/src/index.ts:171
Describes the return value of injectViewport.
Properties
Section titled “Properties”broadcast()
Section titled “broadcast()”broadcast: () =>
void
Defined in: angular/src/index.ts:195
Starts streaming the local viewport to all peers.
Starts streaming the local viewport to all peers.
Returns
Section titled “Returns”void
Nothing.
follow()
Section titled “follow()”follow: (
peerId) =>void
Defined in: angular/src/index.ts:215
Follows a specific peer’s viewport.
Follows a specific peer’s viewport, applying their scroll position to the mounted element as their viewport changes. Zoom is exposed in state for the app to apply.
Parameters
Section titled “Parameters”peerId
Section titled “peerId”string
The peer whose viewport to follow.
Returns
Section titled “Returns”void
Nothing.
present()
Section titled “present()”present: () =>
void
Defined in: angular/src/index.ts:205
Enters present mode, forcing peers to follow the local viewport.
Enters present mode: broadcasts the local viewport and signals peers to follow it until ViewportEngine.stopPresenting is called.
Returns
Section titled “Returns”void
Nothing.
states
Section titled “states”states:
Signal<ViewportState[]>
Defined in: angular/src/index.ts:175
Exposes remote peer viewport states only.
stopBroadcast()
Section titled “stopBroadcast()”stopBroadcast: () =>
void
Defined in: angular/src/index.ts:200
Stops streaming the local viewport.
Stops streaming the local viewport.
Returns
Section titled “Returns”void
Nothing.
stopPresenting()
Section titled “stopPresenting()”stopPresenting: () =>
void
Defined in: angular/src/index.ts:210
Leaves present mode and releases following peers.
Leaves present mode and releases peers that were following.
Returns
Section titled “Returns”void
Nothing.
unfollow()
Section titled “unfollow()”unfollow: () =>
void
Defined in: angular/src/index.ts:220
Stops following any peer and resumes independent scrolling.
Stops following any peer and resumes independent scrolling.
Returns
Section titled “Returns”void
Nothing.
Methods
Section titled “Methods”mount()
Section titled “mount()”mount(
element):void
Defined in: angular/src/index.ts:183
Mounts viewport tracking on a scrollable container.
Parameters
Section titled “Parameters”element
Section titled “element”HTMLElement
The element to observe.
Returns
Section titled “Returns”void
Nothing.
unmount()
Section titled “unmount()”unmount():
void
Defined in: angular/src/index.ts:190
Unmounts viewport tracking.
Returns
Section titled “Returns”void
Nothing.