Interface PickResult

A general pick result. You can access the details of a picked geometry from the property intersection, which is available if a geometry was hit. If a road was hit, a [[RoadPickResult]] is returned, which has additional information, but no intersection.

Hierarchy

Properties

dataSourceName: undefined | string

Uniquely identifies the data source which provided the picked object.

dataSourceOrder: undefined | number

Data source order, useful for sorting a collection of picking results. A number for objects/features coming from tiles (as those have data sources attached), an undefined when objects are added via "mapView.mapAnchors.add(object)" - those are treated as base layer objects during picking (same as "dataSourceOrder: 0").

distance: number

Distance from the camera to the picking point; used to determine the closest object.

featureId?: string | number

An optional feature ID of the picked object.

Remarks

The ID may be assigned by the object's DataSource, for example in case of Optimized Map Vector (OMV) and GeoJSON data sources.

intersection?: Intersection

Defined for geometry only.

point: Vector3 | Vector2

A 2D point in screen coordinates, or a 3D point in world coordinates.

renderOrder?: number

Render order of the intersected object.

technique?: Technique

Defined for roads or if enableTechniqueInfo option is enabled.

tileKey?: TileKey

The tile key containing the picked object.

General type of object.

userData?: any

Optional user data that has been defined in the picked object.

Remarks

This object points directly to information contained in the original TileFeatureData stored in MapView, and should not be modified.

Generated using TypeDoc