# Class: HeightProfile

## vcs.vcm.widgets.heightProfile.HeightProfile

This widget enables to compute a height profile between two selected points

#### new vcs.vcm.widgets.heightProfile.HeightProfile(options)

  Name | Type | Description
  --- | --- | ---
  `options` | vcs.vcm.widgets.heightProfile.HeightProfile.Options |

### Extends

- vcs.vcm.widgets.Widget

### Members

#### active{boolean}

#### className{string}

  class Name of the Object

#### initialized{boolean}

#### name{string}

  unique Name

#### values{vcs.vcm.widgets.heightProfile.HeightProfile.Values}

### Methods

#### cancel()

  cancels a currently running profile

#### getClassName(){string} inherited

  returns the class name of this object.

  Deprecated
    - Yes

  ##### Returns:

  className

#### getConfigObject(){Object} inherited

#### getId(){string} inherited

  returns the id of this object

  Deprecated
    - Yes

#### getName(){string} inherited

  returns the name of the Object, the name is either given by the config Object or a uuid is generated

  Deprecated
    - Yes

#### getSupportedMaps(){Array.<string>} inherited

  Returns the widgets supported maps

#### isActive(){boolean} inherited

  returns the active state of the widget

  Deprecated
    - v3.6 use the property active directly

  ##### Returns:

  state of the widget

#### isInitialized(){boolean} inherited

  checks if the Widget is already initialized

  Deprecated
    - Yes

  ##### Returns:

  true if all requirements are there

#### isSupported(map){boolean} inherited

  returns true if this widget supports the given map. Should be overriden by the widget

  Name | Type | Description
  --- | --- | ---
  `map` | string | vcs.vcm.maps.Map | the map or className to check for support

#### newProfile()

  Creates a new profile by activating the editor.

### Type Definitions

#### vcs.vcm.widgets.heightProfile.HeightProfile.Values{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `progress` | number | when running, the progress number from 0 to 1
  `running` | boolean | whether a profile is being created at the moment
  `profilePoints` | Array.<Cesium.Cartesian2> | the profile points, when created.
  `includeObjects` | boolean | whether to sample all objects or just the terrain
  `resolution` | number | the lerp interval