Skip to main content

Class: PointerComponent

component.PointerComponent

classdesc Component handling mouse, pen, and touch events for camera movement.

To retrive and use the mouse component

example

var viewer = new Viewer({ ... });
var pointerComponent = viewer.getComponent("pointer");

Hierarchy#

Properties#

componentName#

â–ª Static componentName: ComponentName = "pointer"

inheritdoc

Overrides#

Component.componentName

Defined in#

component/pointer/PointerComponent.ts:30

Accessors#

activated#

• get activated(): boolean

Get activated.

Returns#

boolean

Value indicating if the component is currently active.

Defined in#

component/Component.ts:78


defaultConfiguration#

• get defaultConfiguration(): TConfiguration

Get default configuration.

Returns#

TConfiguration

Default configuration for component.

Defined in#

component/Component.ts:92


dragPan#

• get dragPan(): DragPanHandler

Get drag pan.

Returns#

DragPanHandler

The drag pan handler.

Defined in#

component/pointer/PointerComponent.ts:93


earthControl#

• get earthControl(): EarthControlHandler

Get earth control.

Returns#

EarthControlHandler

The earth control handler.

Defined in#

component/pointer/PointerComponent.ts:102


name#

• get name(): string

Get name.

description The name of the component. Used when interacting with the component through the Viewer's API.

Returns#

string

Defined in#

component/Component.ts:107


scrollZoom#

• get scrollZoom(): ScrollZoomHandler

Get scroll zoom.

Returns#

ScrollZoomHandler

The scroll zoom handler.

Defined in#

component/pointer/PointerComponent.ts:111


touchZoom#

• get touchZoom(): TouchZoomHandler

Get touch zoom.

Returns#

TouchZoomHandler

The touch zoom handler.

Defined in#

component/pointer/PointerComponent.ts:120

Methods#

configure#

â–¸ configure(configuration): void

Configure the component.

Parameters#

NameTypeDescription
configurationPointerConfigurationComponent configuration.

Returns#

void

Inherited from#

Component.configure

Defined in#

component/Component.ts:131


fire#

â–¸ fire<T>(type, event): void

Type parameters#

Name
T

Parameters#

NameType
typeComponentEventType
eventT

Returns#

void

Inherited from#

Component.fire

Defined in#

component/Component.ts:149


off#

â–¸ off<T>(type, handler): void

Unsubscribe from an event by its name.

Type parameters#

Name
T

Parameters#

NameTypeDescription
typeComponentEventTypeThe name of the event to unsubscribe from.
handler(event: T) => voidThe handler to remove.

Returns#

void

Inherited from#

Component.off

Defined in#

component/Component.ts:156


on#

â–¸ on<T>(type, handler): void

Subscribe to an event by its name.

Type parameters#

Name
T

Parameters#

NameTypeDescription
typeComponentEventTypeThe name of the event to subscribe to.
handler(event: T) => voidThe handler called when the event occurs.

Returns#

void

Inherited from#

Component.on

Defined in#

component/Component.ts:163