Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 2.95 KB

API.md

File metadata and controls

20 lines (14 loc) · 2.95 KB

API

1. Viewer

2. Specific props

Every react-cesium-fiber component accepts all the editable properties of the CesiumJs object as props. For example, you can specify wether or not an entity should be displayed like this: <entity show={show} /> where show is a boolean you provide.

In addition to this, react-cesium-fiber has a few specific props:

Prop Type Description
args any[] An array of properties to instantiate the CesiumJs object with. The array will be spread in the constructor. For example, for a Cartesian3, according to the doc, you need to do new Cesium.Cartesian3(x, y, z). So, here, we will pass the props args={[x, y, z]}.
attach string or function description
constructFrom string Description of constructFrom
onUpdate function Description of onUpdate
ref ref object Description of ref

3. Hooks