Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MouseComponent

class

MouseComponent

classdesc

Component handling mouse and touch events for camera movement.

To retrive and use the mouse component

example
var viewer = new Mapillary.Viewer(
    "<element-id>",
    "<client-id>",
    "<my key>");

var mouseComponent = viewer.getComponent("mouse");

Hierarchy

Index

Properties

Static componentName

componentName: string = "mouse"
inheritdoc

Accessors

activated

  • get activated(): boolean

defaultConfiguration

doubleClickZoom

dragPan

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

scrollZoom

touchZoom

Methods

activate

configure

deactivate

  • deactivate(): void

fire

  • fire(eventType: string, data: any): void
  • Parameters

    • eventType: string
    • data: any

    Returns void

off

  • off(eventType: string, fn: any): void
  • Unsubscribe from an event by its name.

    Parameters

    • eventType: string

      The name of the event to subscribe to.

    • fn: any

      The handler to remove.

    Returns void

on

  • on(eventType: string, fn: any): void
  • Subscribe to an event by its name.

    Parameters

    • eventType: string

      The name of the event to subscribe to.

    • fn: any

      The handler called when the event occurs.

    Returns void

Generated using TypeDoc