Events

viewer2d.click

Invoked when the user clicks inside the viewer.
Example
﻿
Usage
JS
jQuery
const onClick = function (event, location, objectId) {
  console.log("viewer2d.click", "location:", location, "objectId:", objectId);
};

$("#viewer-2d").on("viewer2d.click", onClick);
const onClick = function (event, location, objectId) {
  console.log("viewer2d.click", "location:", location, "objectId:", objectId);
};

$("#viewer-2d").on("viewer2d.click", onClick);
﻿
Parameters
onClick
JS
jQuery
Function called when the user clicks inside the viewer.
Type
(event: Object) => Void
event
Name
Type
Description
intersects
Object
Object below the cursor, undefined if none
preventDefault
Function
Disable space selection for click event
srcEvent
Object
Original DOM event
intersects
Name
Type
Description
objectId
String
Id of the object
point
﻿Vector3﻿﻿
Intersection point of the object
normal
﻿Vector3﻿﻿
Normal vector at the intersection point
Function called when the user clicks inside the viewer.
Returning false from the onClick function will disable object selection for click event
Type
(event: Object, location: Object, objectId: String) => Boolean/Void
event
﻿jQuery.Event﻿
location
Coordinates of the position clicked.
Name
Type
Description
x
Number
X coordinate of position clicked in pixels
y
Number
Y coordinate of position clicked in pixels
z
Number
Height of the last storey shown in meters
objectId
Id of the object clicked, undefined if no object under cursor
﻿

Type
(event: Object) => Void

Name	Type	Description
intersects	Object	Object below the cursor, undefined if none
preventDefault	Function	Disable space selection for click event
srcEvent	Object	Original DOM event

Name	Type	Description
objectId	String	Id of the object
point	Vector3	Intersection point of the object
normal	Vector3	Normal vector at the intersection point

Type
(event: Object, location: Object, objectId: String) => Boolean/Void

Name	Type	Description
x	Number	X coordinate of position clicked in pixels
y	Number	Y coordinate of position clicked in pixels
z	Number	Height of the last storey shown in meters

Updated 12 Sep 2024

Did this page help you?

showViewpoint

viewer2d.contextmenu