useMeasure

Experimental Feature

It is an experimental feature. It is not guaranteed to reach stable status and the API may change before it does.

A collection of measure tools, for various measurements in GIS.

Usage

area

const { state, clearAll } = useMeasure('area', {
  format: area => `Area: ${area.toFixed(2)} m²`
})

Start measuring when state is true , Left_CLICK to create new point, LEFT_DOUBLE_CLICK to end the measure. It use editEntity to merge constructor options of all entities.

Change label from format option.

distance

const { state, clearAll } = useMeasure('distance', {
  lineEntityProps: {
    polyline: {
      width: 2,
      material: Cesium.Color.ORANGE,
    },
  },
})

Start measuring when state is true , Left_CLICK to create new point, LEFT_DOUBLE_CLICK to end the measure. It use editEntity to merge constructor options of all entities.

The measured distance is the straight-line distance between two points.

height

const { state, clearAll } = useMeasure('height')

Start measuring when state is true. Left click to pick the start point, double left click to pick the end point. It use editEntity to merge constructor options of all entities.

Obtain the height by calculating the projected coordinates.

Returns

• state: Ref<boolean> - Controls whether measurement is in progress.
• current: ShallowRef<T> - Stores the current instance of the measurement tool, determined by the measurement method.
• set: Set<T> - Contains all instances drawn by the measurement tool.
• clearAll: A function that clears all instances when called.
• stop: A function that terminates the current measurement instance, leaving the measurement result at its last state.

demo

Type Declarations

Details

export declare function useMeasure(
  type: "area",
  options?: AreaOptions,
): AreaReturn
export declare function useMeasure(
  type: "distance",
  options?: DistanceOptions,
): DistanceReturn
export declare function useMeasure(
  type: "height",
  options?: HeightOptions,
): HeightReturn

Source

source • demo