Module: viewer
description Main interfaces and methods for interacting with
and extending MapillaryJS.
Enumerations#
Classes#
Interfaces#
- ComponentOptions
- FallbackOptions
- ICustomCameraControls
- ICustomRenderer
- IViewer
- NavigationEdge
- NavigationEdgeData
- NavigationEdgeStatus
- PointOfView
- UrlOptions
- ViewerBearingEvent
- ViewerDataLoadingEvent
- ViewerEvent
- ViewerImageEvent
- ViewerMouseEvent
- ViewerNavigableEvent
- ViewerNavigationEdgeEvent
- ViewerOptions
- ViewerReferenceEvent
- ViewerStateEvent
Type aliases#
CombiningFilterExpression#
Ƭ CombiningFilterExpression: [CombiningFilterOperator, ...(ComparisonFilterExpression | SetMembershipFilterExpression)[]]
Defined in#
CombiningFilterOperator#
Ƭ CombiningFilterOperator: "all"
Defined in#
ComparisonFilterExpression#
Ƭ ComparisonFilterExpression: [ComparisonFilterOperator, FilterKey, FilterValue]
Defined in#
ComparisonFilterOperator#
Ƭ ComparisonFilterOperator: "==" | "!=" | ">" | ">=" | "<" | "<="
Defined in#
FilterExpression#
Ƭ FilterExpression: ComparisonFilterExpression | SetMembershipFilterExpression | CombiningFilterExpression
Defined in#
FilterImage#
Ƭ FilterImage: Pick<Image, "cameraType" | "capturedAt" | "clusterId" | "creatorId" | "creatorUsername" | "exifOrientation" | "height" | "id" | "mergeId" | "merged" | "ownerId" | "private" | "qualityScore" | "sequenceId" | "width">
Defined in#
FilterKey#
Ƭ FilterKey: keyof FilterImage
Defined in#
FilterOperator#
Ƭ FilterOperator: CombiningFilterOperator | ComparisonFilterOperator | SetMembershipFilterOperator
Defined in#
FilterValue#
Ƭ FilterValue: boolean | number | string
Defined in#
SetMembershipFilterExpression#
Ƭ SetMembershipFilterExpression: [SetMembershipFilterOperator, FilterKey, ...FilterValue[]]
Defined in#
SetMembershipFilterOperator#
Ƭ SetMembershipFilterOperator: "in" | "!in"
Defined in#
Events#
ViewerEventType#
• ViewerEventType: "bearing" | "click" | "contextmenu" | "dblclick" | "fov" | "dataloading" | "load" | "mousedown" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "moveend" | "movestart" | "navigable" | "image" | "position" | "pov" | "reference" | "remove" | "sequenceedges" | "spatialedges"
Defined in#
viewer/events/ViewerEventType.ts:4
Functions#
isFallbackSupported#
â–¸ isFallbackSupported(): boolean
Test whether the current browser supports the fallback functionality of MapillaryJS.
description The fallback functionality does not include WebGL
rendering, only 2D canvas rendering.
example var fallbackSupported = isFallbackSupported();
Returns#
boolean
Defined in#
isSupported#
â–¸ isSupported(): boolean
Test whether the current browser supports the full functionality of MapillaryJS.
description The full functionality includes WebGL rendering.
example var supported = isSupported();
Returns#
boolean