Interface: IViewer
viewer.IViewer
Implemented by#
Properties#
dataProvider#
• Readonly dataProvider: IDataProvider
Defined in#
viewer/interfaces/IViewer.ts:20
isNavigable#
• Readonly isNavigable: boolean
Defined in#
viewer/interfaces/IViewer.ts:21
Methods#
activateCombinedPanning#
â–¸ activateCombinedPanning(): void
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:22
activateComponent#
â–¸ activateComponent(name): void
Parameters#
| Name | Type |
|---|---|
name | string |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:23
activateCover#
â–¸ activateCover(): void
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:24
addCustomRenderer#
â–¸ addCustomRenderer(renderer): void
Parameters#
| Name | Type |
|---|---|
renderer | ICustomRenderer |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:25
attachCustomCameraControls#
â–¸ attachCustomCameraControls(controls): void
Parameters#
| Name | Type |
|---|---|
controls | ICustomCameraControls |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:26
deactivateCombinedPanning#
â–¸ deactivateCombinedPanning(): void
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:27
deactivateComponent#
â–¸ deactivateComponent(name): void
Parameters#
| Name | Type |
|---|---|
name | string |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:28
deactivateCover#
â–¸ deactivateCover(): void
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:29
detachCustomCameraControls#
â–¸ detachCustomCameraControls(): Promise<ICustomCameraControls>
Returns#
Promise<ICustomCameraControls>
Defined in#
viewer/interfaces/IViewer.ts:30
fire#
â–¸ fire<T>(type, event): void
Type parameters#
| Name |
|---|
T |
Parameters#
| Name | Type |
|---|---|
type | ViewerEventType |
event | T |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:31
getBearing#
â–¸ getBearing(): Promise<number>
Returns#
Promise<number>
Defined in#
viewer/interfaces/IViewer.ts:34
getCameraControls#
â–¸ getCameraControls(): Promise<CameraControls>
Returns#
Promise<CameraControls>
Defined in#
viewer/interfaces/IViewer.ts:35
getCanvas#
â–¸ getCanvas(): HTMLCanvasElement
Returns#
HTMLCanvasElement
Defined in#
viewer/interfaces/IViewer.ts:36
getCanvasContainer#
â–¸ getCanvasContainer(): HTMLDivElement
Returns#
HTMLDivElement
Defined in#
viewer/interfaces/IViewer.ts:37
getCenter#
â–¸ getCenter(): Promise<number[]>
Returns#
Promise<number[]>
Defined in#
viewer/interfaces/IViewer.ts:38
getComponent#
â–¸ getComponent<TComponent>(name): TComponent
Type parameters#
| Name | Type |
|---|---|
TComponent | extends Component<ComponentConfiguration, TComponent> |
Parameters#
| Name | Type |
|---|---|
name | string |
Returns#
TComponent
Defined in#
viewer/interfaces/IViewer.ts:39
getContainer#
â–¸ getContainer(): HTMLElement
Returns#
HTMLElement
Defined in#
viewer/interfaces/IViewer.ts:41
getFieldOfView#
â–¸ getFieldOfView(): Promise<number>
Returns#
Promise<number>
Defined in#
viewer/interfaces/IViewer.ts:42
getImage#
â–¸ getImage(): Promise<Image>
Returns#
Promise<Image>
Defined in#
viewer/interfaces/IViewer.ts:43
getPointOfView#
â–¸ getPointOfView(): Promise<PointOfView>
Returns#
Promise<PointOfView>
Defined in#
viewer/interfaces/IViewer.ts:44
getPosition#
â–¸ getPosition(): Promise<LngLat>
Returns#
Promise<LngLat>
Defined in#
viewer/interfaces/IViewer.ts:45
getReference#
â–¸ getReference(): Promise<LngLatAlt>
Returns#
Promise<LngLatAlt>
Defined in#
viewer/interfaces/IViewer.ts:46
getZoom#
â–¸ getZoom(): Promise<number>
Returns#
Promise<number>
Defined in#
viewer/interfaces/IViewer.ts:47
hasCustomCameraControls#
â–¸ hasCustomCameraControls(controls): boolean
Parameters#
| Name | Type |
|---|---|
controls | ICustomCameraControls |
Returns#
boolean
Defined in#
viewer/interfaces/IViewer.ts:48
hasCustomRenderer#
â–¸ hasCustomRenderer(rendererId): boolean
Parameters#
| Name | Type |
|---|---|
rendererId | string |
Returns#
boolean
Defined in#
viewer/interfaces/IViewer.ts:49
moveDir#
â–¸ moveDir(direction): Promise<Image>
Parameters#
| Name | Type |
|---|---|
direction | NavigationDirection |
Returns#
Promise<Image>
Defined in#
viewer/interfaces/IViewer.ts:50
moveTo#
â–¸ moveTo(imageId): Promise<Image>
Parameters#
| Name | Type |
|---|---|
imageId | string |
Returns#
Promise<Image>
Defined in#
viewer/interfaces/IViewer.ts:51
off#
â–¸ off<T>(type, handler): void
Type parameters#
| Name |
|---|
T |
Parameters#
| Name | Type |
|---|---|
type | ViewerEventType |
handler | (event: T) => void |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:52
on#
â–¸ on<T>(type, handler): void
Type parameters#
| Name |
|---|
T |
Parameters#
| Name | Type |
|---|---|
type | ViewerEventType |
handler | (event: T) => void |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:55
project#
â–¸ project(lngLat): Promise<number[]>
Parameters#
| Name | Type |
|---|---|
lngLat | LngLat |
Returns#
Promise<number[]>
Defined in#
viewer/interfaces/IViewer.ts:58
projectFromBasic#
â–¸ projectFromBasic(basicPoint): Promise<number[]>
Parameters#
| Name | Type |
|---|---|
basicPoint | number[] |
Returns#
Promise<number[]>
Defined in#
viewer/interfaces/IViewer.ts:59
remove#
â–¸ remove(): void
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:60
removeCustomRenderer#
â–¸ removeCustomRenderer(rendererId): void
Parameters#
| Name | Type |
|---|---|
rendererId | string |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:61
resize#
â–¸ resize(): void
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:62
setAccessToken#
â–¸ setAccessToken(accessToken?): Promise<void>
Parameters#
| Name | Type |
|---|---|
accessToken? | string |
Returns#
Promise<void>
Defined in#
viewer/interfaces/IViewer.ts:69
setCameraControls#
â–¸ setCameraControls(controls): void
Parameters#
| Name | Type |
|---|---|
controls | CameraControls |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:63
setCenter#
â–¸ setCenter(center): void
Parameters#
| Name | Type |
|---|---|
center | number[] |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:64
setFieldOfView#
â–¸ setFieldOfView(fov): void
Parameters#
| Name | Type |
|---|---|
fov | number |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:65
setFilter#
â–¸ setFilter(filter?): Promise<void>
Parameters#
| Name | Type |
|---|---|
filter? | FilterExpression |
Returns#
Promise<void>
Defined in#
viewer/interfaces/IViewer.ts:66
setRenderMode#
â–¸ setRenderMode(renderMode): void
Parameters#
| Name | Type |
|---|---|
renderMode | RenderMode |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:67
setTransitionMode#
â–¸ setTransitionMode(transitionMode): void
Parameters#
| Name | Type |
|---|---|
transitionMode | TransitionMode |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:68
setZoom#
â–¸ setZoom(zoom): void
Parameters#
| Name | Type |
|---|---|
zoom | number |
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:70
triggerRerender#
â–¸ triggerRerender(): void
Returns#
void
Defined in#
viewer/interfaces/IViewer.ts:71
unproject#
â–¸ unproject(pixelPoint): Promise<LngLat>
Parameters#
| Name | Type |
|---|---|
pixelPoint | number[] |
Returns#
Promise<LngLat>
Defined in#
viewer/interfaces/IViewer.ts:72
unprojectToBasic#
â–¸ unprojectToBasic(pixelPoint): Promise<number[]>
Parameters#
| Name | Type |
|---|---|
pixelPoint | number[] |
Returns#
Promise<number[]>