ElevationProfileViewModel | ArcGIS API for JavaScript 4.24

Collection of elevation profile lines which are to be generated and displayed in the widget's chart. See the different profile line types for details on usage ... ArcGISAPIforJavaScriptAPIReferenceOverviewSampleCodeAPIReferenceShowcaseBlogMenuesriesri/analysisesri/coreesri/formesri/geometryesri/identityesri/layersesri/networksesri/popupesri/portalesri/renderersesri/restesri/smartMappingesri/supportesri/symbolsesri/viewsesri/webdocesri/webmapesri/websceneesri/widgetsReferenceNavigationMenuElevationProfileViewModel ProvidesthelogicfortheElevationProfilewidget. Seealso: ElevationProfile Guidetopic:WidgetviewModelpattern ElevationProfileLineGround ElevationProfileLineInput ElevationProfileLineQuery ElevationProfileLineView Constructors newElevationProfileViewModel(properties) Parameter: properties Object optional Seethepropertiesforalistofalltheproperties thatmaybepassedintotheconstructor. PropertyOverview Anypropertiescanbeset,retrievedorlistenedto.SeetheWorkingwithPropertiestopic. Showinheritedproperties Hideinheritedproperties Name Type Summary Class declaredClassStringmoredetailsThenameoftheclass.moredetailsAccessor effectiveUnitsEffectiveUnitsmoredetailsUnitswhichhavebeenselectedaccordingtothemagnitudeoftheelevationsanddistancesthataretobedisplayedinthewidget,accordingtotheselectedunitorunitsystem.moredetailsElevationProfileViewModel geodesicDistanceThresholdNumbermoredetailsWhenthespatialreferenceisprojected(otherthanwebmercator)andthepathisshorterthanthisthreshold,distanceswillbecomputedplanimetrically.moredetailsElevationProfileViewModel highlightEnabledBooleanmoredetailsWhetherthegraphicusedasinputishighlighted.moredetailsElevationProfileViewModel hoveredChartPositionNumbermoredetailsTheposition,intherange[0,1],beinghoveredinthegraph.moredetailsElevationProfileViewModel inputGraphicmoredetailsTheinputpathalongwhichelevationwillbequeriedinordertogenerateanelevationprofile.moredetailsElevationProfileViewModel profilesCollectionmoredetailsCollectionofelevationprofilelineswhicharetobegeneratedanddisplayedinthewidget'schart.moredetailsElevationProfileViewModel progressNumbermoredetailsTheprogress,between0and1ofgeneratingalltheconfiguredelevationprofiles.moredetailsElevationProfileViewModel stateStringmoredetailsThecurrentstateoftheviewmodelthatcanbeusedforrenderingtheUIofthewidget.moredetailsElevationProfileViewModel uniformChartScalingBooleanmoredetailsWhetherthechartshoulduseauniformscalefortheXandYaxes.moredetailsElevationProfileViewModel unitSystemOrLengthUnitmoredetailsUnitsystem(imperial,metric)orspecificunitusedfordisplayingtheelevationanddistancevalues.moredetailsElevationProfileViewModel unitOptionsSystemOrLengthUnit[]moredetailsListofavailableunitsandunitsystems(imperial,metric)fordisplayingtheelevationanddistancevalues.moredetailsElevationProfileViewModel viewSceneView|MapViewmoredetailsAreferencetotheView.moredetailsElevationProfileViewModel PropertyDetails declaredClassStringreadonly inherited Thenameoftheclass.Thedeclaredclassnameisformattedasesri.folder.className. effectiveUnitsEffectiveUnitsreadonly Unitswhichhavebeenselectedaccordingtothemagnitudeoftheelevationsanddistances thataretobedisplayedinthewidget,accordingtotheselectedunitorunitsystem. geodesicDistanceThresholdNumber Whenthespatialreferenceisprojected(otherthanwebmercator)andthe pathisshorterthanthisthreshold,distanceswillbecomputedplanimetrically. Otherwisedistanceswillbecomputedgeodetically. DefaultValue:100000 highlightEnabledBoolean Since:ArcGISAPIforJavaScript4.20 Whetherthegraphicusedasinput ishighlighted.Thehighlightcolorandopacitycanbechangedin highlightOptions. hoveredChartPositionNumber Theposition,intherange[0,1],beinghoveredinthegraph.We'lluse thistodeterminewhichsamplesarebeinghoveredandmarktheirposition intheview. inputGraphicautocast Theinputpathalongwhichelevationwillbequeriedinordertogenerateanelevationprofile. Typicallynotsetwhencreatingthewidget.Inthiscasethewidgetstartsempty, andwaitsfortheusertoeitherdrawanewprofileorgenerateaprofilefromselectingalinefeature. Theresultofthisactionpopulatesinput. inputcanbesetwhenconstructingthewidget,orsetorchangedatruntime. TheinputgraphicmustcontainageometryoftypePolyline. Symbolandattributesoftheinputgraphicareignored. profilesCollectionautocast Collectionofelevationprofilelineswhicharetobegeneratedanddisplayedinthewidget's chart.Seethedifferentprofilelinetypesfordetailsonusageandbehavior. Onceanelevationprofileisgenerated,eachlinewillcontaintherawdatausedto generatethechartandstatistics. Theorderoftheprofileswithinthecollectiondeterminesthedrawingorderonthechart. InaMapViewElevationProfileLineView isnotsupported. progressNumberreadonly Theprogress,between0and1ofgeneratingalltheconfiguredelevation profiles. stateStringreadonly ThecurrentstateoftheviewmodelthatcanbeusedforrenderingtheUI ofthewidget. Value Description disabled widgetisbeingcreated ready widgetisready.Nopathconfiguredandnointeractiveoperationongoing. creating useriscreatinganewinputpath. created inputpathisconfiguredbutnointeractiveoperationisongoing. selecting userisselectinganexistinginputpath. selected userselectedanexistinginputpath. PossibleValues:"disabled"|"ready"|"creating"|"created"|"selecting"|"selected" DefaultValue:disabled uniformChartScalingBoolean Since:ArcGISAPIforJavaScript4.20 WhetherthechartshoulduseauniformscalefortheXandYaxes.Whena uniformscaleisapplied,theXaxiswilldisplaythesamedistanceunits perpixelastheelevationunitsperpixeldisplayedintheYaxis. unitSystemOrLengthUnit Unitsystem(imperial,metric)orspecificunitusedfordisplayingtheelevationanddistancevalues. unitOptionsSystemOrLengthUnit[] Listofavailableunitsandunitsystems(imperial,metric)fordisplayingtheelevationanddistancevalues. viewSceneView|MapView AreferencetotheView. MethodOverview Name ReturnType Summary Class cancel() moredetailsStopsacreation/selectionoperationandrestoresthepreviouslyconfiguredinputpath.moredetailsElevationProfileViewModel clear() moredetailsClearstheexistingprofileandstopsanyinteraction.moredetailsElevationProfileViewModel start() moredetailsIfmodeis"sketch"(thedefault),switchestothe"creating"stateinwhichtheusercandrawanewline.moredetailsElevationProfileViewModel stop() moredetailsStopsacreation/selectionoperation.moredetailsElevationProfileViewModel MethodDetails cancel() Stopsacreation/selectionoperationandrestoresthepreviouslyconfigured inputpath. clear() Clearstheexistingprofileandstopsanyinteraction. start(options) Ifmodeis"sketch"(thedefault),switchestothe"creating"statein whichtheusercandrawanewline.Ifthemodeis"select",switchesto the"selecting"stateandletstheuserclickontheviewtoselectan existingline. Ifanylineispresent,whenthefirstpointisdrawnoranexistingline isselected,thepreviousinputisdiscarded. Parameters: options Object optional Startoptions. Specification: mode String optional DefaultValue: "sketch" Themodethatthewidgetwillstartwith. In"sketch"modetheusercandrawanewlineandin"select"modetheusercanclick ontheviewtoselectanexistingline. PossibleValues:"sketch"|"select" stop() Stopsacreation/selectionoperation. Ifthecurrentoperationisa"sketch"andtheinputhasatleasttwo committedpoints(notbeingdragged),theinputiskept.Otherwise theinputissettonull. TypeDefinitions EffectiveUnits Theunitswhichhavebeenselectedaccordingtothemagnitudeoftheelevationsanddistances thataretobedisplayedinthewidget,accordingtotheselectedunitorunitsystem. Properties: distance LengthUnit Unitsusedfordisplayingdistanceorlengthvalues. elevation LengthUnit Unitsusedfordisplayingelevationvalues. ConstructorsPropertiesMethodsTypedefinitionsShowtableofcontentsConstructorsPropertiesMethodsTypedefinitionsWasthispagehelpful?YesNoWasthispagehelpful?YesNoYourbrowserisnolongersupported.Pleaseupgradeyourbrowserforthebestexperience.Seeourbrowserdeprecationpostformoredetails.