On this page

Entity

Entity instances aggregate multiple forms of visualization into a single high-level object. They can be created manually and added to entity collection.

Constructor

new Entity(optionsopt)

Parameters:

Name Type Attributes Description

options

Object

<optional>

Entity options:

Properties

Name	Type	Attributes	Description
`name`	string	<optional>	A human-readable name to display to users. It does not have to be unique.
`cartesian`	Vec3 \| Array.<number>	<optional>	Spatial entities like billboard, label etc. cartesian position.
`lonlat`	LonLat	<optional>	Geodetic coordinates for an entities like billboard, label etc.
`aground`	boolean	<optional>	True for entities that have to be placed on the relief.
`visibility`	boolean	<optional>	Entity visibility.
`billboard`	*	<optional>	Billboard options(see Billboard).
`label`	*	<optional>	Label options(see Label).
`polyline`	*	<optional>	Polyline options(see Polyline).
`ray`	*	<optional>	Ray options(see Ray).
`pointCloud`	*	<optional>	Point cloud options(see PointCloud).
`geometry`	*	<optional>	Geometry options (see Geometry), available for vector layer only.
`properties`	*	<optional>	Entity custom properties.

Source: entity/Entity.ts, line 38

Methods

_setCartesian3vSilent(cartesian, skipLonLat)

Sets entity cartesian position without event dispatching.

Parameters:

Name	Type	Default	Description
`cartesian`	Vec3		Cartesian position in 3d space.
`skipLonLat`	boolean	false	skip geodetic calculation.

Source: entity/Entity.ts, line 429

addTo(collection, rightNowopt) → {Entity}

Adds current entity into the specified entity collection.

Parameters:

Name	Type	Attributes	Default	Description
`collection`	EntityCollection \| Vector			Specified entity collection or vector layer.
`rightNow`	Boolean	<optional>	false	Entity insertion option for vector layer.

Source: entity/Entity.ts, line 317

Returns:

This object.

Type:: Entity

appendChild(entity)

Append child entity.

Parameters:

Name	Type	Description
`entity`	Entity	Child entity.

Source: entity/Entity.ts, line 712

getAltitude() → {number}

Sets entity altitude over the planet.

Source: entity/Entity.ts, line 538

Returns:

Altitude.

Type:: number

getCartesian() → {Vec3}

Returns cartesian position.

Source: entity/Entity.ts, line 547

Returns:

Type:: Vec3

getExtent() → {Extent}

Return geodetic extent.

Source: entity/Entity.ts, line 751

Returns:

Type:: Extent

getLonLat() → {LonLat}

Gets entity geodetic coordinates.

Source: entity/Entity.ts, line 468

Returns:

Type:: LonLat

getVisibility() → {boolean}

Returns entity visibility.

Source: entity/Entity.ts, line 369

Returns:

Type:: boolean

remove()

Removes current entity from collection and layer.

Source: entity/Entity.ts, line 329

setAltitude(altitude)

Sets entity altitude over the planet.

Parameters:

Name	Type	Description
`altitude`	number	Altitude.

Source: entity/Entity.ts, line 529

setBillboard(billboard) → {Billboard}

Sets entity billboard.

Parameters:

Name	Type	Description
`billboard`	Billboard	Billboard object.

Source: entity/Entity.ts, line 556

Returns:

Type:: Billboard

setCartesian(x, y, z)

Sets entity cartesian position.

Parameters:

Name	Type	Description
`x`	number	3d space X - position.
`y`	number	3d space Y - position.
`z`	number	3d space Z - position.

Source: entity/Entity.ts, line 387

setCartesian3v(cartesian)

Sets entity cartesian position.

Parameters:

Name	Type	Description
`cartesian`	Vec3	Cartesian position in 3d space.

Source: entity/Entity.ts, line 378

setGeoObject(geoObject) → {GeoObject}

Sets entity geoObject.

Parameters:

Name	Type	Description
`geoObject`	GeoObject	GeoObject.

Source: entity/Entity.ts, line 664

Returns:

Type:: GeoObject

setGeometry(geometry) → {Geometry}

Sets entity geometry.

Parameters:

Name	Type	Description
`geometry`	Geometry	Geometry object.

Source: entity/Entity.ts, line 643

Returns:

Type:: Geometry

setLabel(label) → {Label}

Sets entity label.

Parameters:

Name	Type	Description
`label`	Label	Text label.

Source: entity/Entity.ts, line 574

Returns:

Type:: Label

setLonLat(lonlat)

Sets geodetic coordinates of the entity point object.

Parameters:

Name	Type	Description
`lonlat`	LonLat	WGS84 coordinates.

Source: entity/Entity.ts, line 477

setLonLat2(lon, lat, heightopt)

Sets geodetic coordinates of the entity point object.

Parameters:

Name	Type	Attributes	Description
`lon`	number		Longitude.
`lat`	number		Latitude
`height`	number	<optional>	Height

Source: entity/Entity.ts, line 502

setPickingColor()

Appends entity items(billboard, label etc.) picking color.

Source: entity/Entity.ts, line 727

setPointCloud(pointCloud) → {PointCloud}

Sets entity pointCloud.

Parameters:

Name	Type	Description
`pointCloud`	PointCloud	PointCloud object.

Source: entity/Entity.ts, line 626

Returns:

Type:: PointCloud

setPolyline(polyline) → {Polyline}

Sets entity polyline.

Parameters:

Name	Type	Description
`polyline`	Polyline	Polyline object.

Source: entity/Entity.ts, line 609

Returns:

Type:: Polyline

setRay(ray) → {Ray}

Sets entity ray.

Parameters:

Name	Type	Description
`ray`	Ray	Ray object.

Source: entity/Entity.ts, line 592

Returns:

Type:: Ray

setStrip(strip) → {Strip}

Sets entity strip.

Parameters:

Name	Type	Description
`strip`	Strip	Strip object.

Source: entity/Entity.ts, line 682

Returns:

Type:: Strip

setVisibility(visibility)

Sets the entity visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Entity visibility.

Source: entity/Entity.ts, line 338