Skip to content

reformat all readmes from html to md #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Jul 2, 2019
24 changes: 12 additions & 12 deletions analysis/analyze-hotspots/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ Select a start and end date using the datepickers between 1/1/1998 and 5/31/1998

To analyze hotspots using a geoprocessing service:

1. Create a `GeoprocessingTask` with the URL set to the endpoint of the geoprocessing service.
2. Create a query string with the date range as an input of `GeoprocessingParameters`.
3. Use the `GeoprocessingTask` to create a `GeoprocessingJob` with the parameters.
4. Start the job and wait for it to complete and return a `GeoprocessingResult`.
5. Get the resulting `ArcGISMapImageLayer` using `geoprocessingResult.getMapImageLayer()`.
6. Add the layer to the map's operational layers.
1. Create a `GeoprocessingTask` with the URL set to the endpoint of the geoprocessing service.
2. Create a query string with the date range as an input of `GeoprocessingParameters`.
3. Use the `GeoprocessingTask` to create a `GeoprocessingJob` with the parameters.
4. Start the job and wait for it to complete and return a `GeoprocessingResult`.
5. Get the resulting `ArcGISMapImageLayer` using `geoprocessingResult.getMapImageLayer()`.
6. Add the layer to the map's operational layers.

## Relevant API

* ArcGISMapImageLayer
* GeoprocessingJob
* GeoprocessingParameters
* GeoprocessingResult
* GeoprocessingString
* GeoprocessingTask
* ArcGISMapImageLayer
* GeoprocessingJob
* GeoprocessingParameters
* GeoprocessingResult
* GeoprocessingString
* GeoprocessingTask
14 changes: 7 additions & 7 deletions analysis/distance-measurement-analysis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@ Choose a unit system for the measurement in the UI dropdown. Click any location

To measure distances with the `LocationDistanceMeasurement` analysis:

1. Create an `AnalysisOverlay` and add it to your scene view's analysis overlay collection: `sceneView.getAnalysisOverlays().add(analysisOverlay)`.
2. Create a `LocationDistanceMeasurement`, specifying the `startLocation` and `endLocation`. These can be the same point to start with. Add the analysis to the analysis overlay: `analysisOverlay.getAnalyses().add(LocationDistanceMeasurement)`. The measuring line will be drawn for you between the two points.
3. The `measurementChanged` callback will fire if the distances change. You can get the new values for the `directDistance`, `horizontalDistance`, and `verticalDistance` from the `MeasurementChangedEvent` returned by the callback. The distance objects contain both a scalar value and a unit of measurement.
1. Create an `AnalysisOverlay` and add it to your scene view's analysis overlay collection: `sceneView.getAnalysisOverlays().add(analysisOverlay)`.
2. Create a `LocationDistanceMeasurement`, specifying the `startLocation` and `endLocation`. These can be the same point to start with. Add the analysis to the analysis overlay: `analysisOverlay.getAnalyses().add(LocationDistanceMeasurement)`. The measuring line will be drawn for you between the two points.
3. The `measurementChanged` callback will fire if the distances change. You can get the new values for the `directDistance`, `horizontalDistance`, and `verticalDistance` from the `MeasurementChangedEvent` returned by the callback. The distance objects contain both a scalar value and a unit of measurement.

## Relevant API

* AnalysisOverlay
* LocationDistanceMeasurement
* UnitSystem
* AnalysisOverlay
* LocationDistanceMeasurement
* UnitSystem

## Additional information

The `LocationDistanceMeasurement` analysis only performs planar distance calculations. This may not be appropriate for large distances where the Earth's curvature needs to be taken into account.

## Tags

Analysis, 3D
Analysis, 3D
14 changes: 7 additions & 7 deletions analysis/line-of-sight-geoelement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ A line of sight will display between a point on the Empire State Building (obser

To show a line of sight between two graphics:

1. Create an `AnalysisOverlay` and add it to the `SceneView`'s analysis overlays collection.
2. Create a `GeoElementLineOfSight`, passing in observer and target `GeoElement`s (feautures or graphics). Add the line of sight to the analysis overlay's analyses collection.
3. To get the target visibility when it changes, add a `TargetVisibilityChangedListener` to the line of sight. The changed event will give the `TargetVisibility`.
1. Create an `AnalysisOverlay` and add it to the `SceneView`'s analysis overlays collection.
2. Create a `GeoElementLineOfSight`, passing in observer and target `GeoElement`s (feautures or graphics). Add the line of sight to the analysis overlay's analyses collection.
3. To get the target visibility when it changes, add a `TargetVisibilityChangedListener` to the line of sight. The changed event will give the `TargetVisibility`.

## Relevant API

* AnalysisOverlay
* GeoElementLineOfSight
* LineOfSight.TargetVisibility
* AnalysisOverlay
* GeoElementLineOfSight
* LineOfSight.TargetVisibility

## Tags

Analysis
Analysis
22 changes: 11 additions & 11 deletions analysis/line-of-sight-location/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ Click to turn on the mouse move event listener. Then move the mouse where you wa

To create a line of sight and update it with the mouse:

1. Create an `AnalysisOverlay` and add it to the scene view.
2. Create a `LocationLineOfSight` with initial observer and target locations and add it to the analysis overlay.
3. Make an `EventHandler<MouseEvent>` to capture mouse movement. Turn the screen point into a scene point with `sceneView.screenToLocationAsync(screenPoint)`.
4. Update the target location with `lineOfSight.setTargetLocation(scenePoint)`.
1. Create an `AnalysisOverlay` and add it to the scene view.
2. Create a `LocationLineOfSight` with initial observer and target locations and add it to the analysis overlay.
3. Make an `EventHandler<MouseEvent>` to capture mouse movement. Turn the screen point into a scene point with `sceneView.screenToLocationAsync(screenPoint)`.
4. Update the target location with `lineOfSight.setTargetLocation(scenePoint)`.

## Relevant API

* 3D
* AnalysisOverlay
* ArcGISTiledElevationSource
* ArcGISScene
* Camera
* LocationLineOfSight
* SceneView
* 3D
* AnalysisOverlay
* ArcGISTiledElevationSource
* ArcGISScene
* Camera
* LocationLineOfSight
* SceneView
22 changes: 11 additions & 11 deletions analysis/viewshed-camera/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ The sample will start with a viewshed created from the initial camera location,

To create and update a viewshed from a camera:

1. Get a `Camera` either by creating it, or by getting the current camera from the scene with `sceneView.getCurrentViewpointCamera()`.
2. Create a `LocationViewshed` passing in the `Camera` plus a min/max distance.
3. To update the viewshed with a new camera, use `viewshed.updateFromCamera(camera)`
1. Get a `Camera` either by creating it, or by getting the current camera from the scene with `sceneView.getCurrentViewpointCamera()`.
2. Create a `LocationViewshed` passing in the `Camera` plus a min/max distance.
3. To update the viewshed with a new camera, use `viewshed.updateFromCamera(camera)`

## Relevant API

* 3D
* AnalysisOverlay
* ArcGISTiledElevationSource
* ArcGISScene
* ArcGISSceneLayer
* Camera
* LocationViewshed
* SceneView
* 3D
* AnalysisOverlay
* ArcGISTiledElevationSource
* ArcGISScene
* ArcGISSceneLayer
* Camera
* LocationViewshed
* SceneView
24 changes: 12 additions & 12 deletions analysis/viewshed-geoelement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ Once the scene is done loading, click on a location for the tank to drive to. It

To attach a viewshed to a `GeoElement`:

1. Create a `Graphic` and add it to a `GraphicsOverlay`.
2. Use a `SimpleRenderer` in the `GraphicsOverlay` which has a heading expression set. This way you can relate the viewshed's heading to the `GeoElement`'s heading.
3. Create a `GeoElementViewshed` with the graphic, heading/pitch offsets, and min/max distance.
4. To offset the viewshed's observer location from the center of the graphic, use `viewshed.setOffsetX()`, etc.
1. Create a `Graphic` and add it to a `GraphicsOverlay`.
2. Use a `SimpleRenderer` in the `GraphicsOverlay` which has a heading expression set. This way you can relate the viewshed's heading to the `GeoElement`'s heading.
3. Create a `GeoElementViewshed` with the graphic, heading/pitch offsets, and min/max distance.
4. To offset the viewshed's observer location from the center of the graphic, use `viewshed.setOffsetX()`, etc.

## Relevant API

* 3D
* AnalysisOverlay
* ArcGISTiledElevationSource
* ArcGISScene
* ArcGISSceneLayer
* GeoElementViewshed
* Graphic
* SceneView
* 3D
* AnalysisOverlay
* ArcGISTiledElevationSource
* ArcGISScene
* ArcGISSceneLayer
* GeoElementViewshed
* Graphic
* SceneView
26 changes: 13 additions & 13 deletions analysis/viewshed-geoprocessing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ After the geoprocessing task finishes loading (the spinner will stop), click any

To create a viewshed from a geoprocessing service:

1. Create a `GeoprocessingTask` with the URL set to the viewshed endpoint of a geoprocessing service .
2. Create a `FeatureCollectionTable` and add a new `Feature` whose geometry is the `Point` where you want to create the viewshed.
3. Make `GeoprocessingParameters` with an input for the viewshed operation `parameters.getInputs().put("Input_Observation_Point", new GeoprocessingFeatures(featureCollectionTable))`.
4. Use the `GeoprocessingTask` to create a `GeoprocessingJob` with the parameters.
5. Start the job and wait for it to complete and return a `GeoprocessingResult`.
6. Get the resulting `GeoprocessingFeatures` using `geoprocessingResult.getOutputs().get("Viewshed_Result")`.
7. Iterate through the viewshed features in `geoprocessingFeatures.getFeatures()` to use their geometry or display the geometry in a graphic.
1. Create a `GeoprocessingTask` with the URL set to the viewshed endpoint of a geoprocessing service .
2. Create a `FeatureCollectionTable` and add a new `Feature` whose geometry is the `Point` where you want to create the viewshed.
3. Make `GeoprocessingParameters` with an input for the viewshed operation `parameters.getInputs().put("Input_Observation_Point", new GeoprocessingFeatures(featureCollectionTable))`.
4. Use the `GeoprocessingTask` to create a `GeoprocessingJob` with the parameters.
5. Start the job and wait for it to complete and return a `GeoprocessingResult`.
6. Get the resulting `GeoprocessingFeatures` using `geoprocessingResult.getOutputs().get("Viewshed_Result")`.
7. Iterate through the viewshed features in `geoprocessingFeatures.getFeatures()` to use their geometry or display the geometry in a graphic.

## Relevant API

* FeatureCollectionTable
* GeoprocessingFeatures
* GeoprocessingJob
* GeoprocessingParameters
* GeoprocessingResult
* GeoprocessingTask
* FeatureCollectionTable
* GeoprocessingFeatures
* GeoprocessingJob
* GeoprocessingParameters
* GeoprocessingResult
* GeoprocessingTask
18 changes: 9 additions & 9 deletions analysis/viewshed-location/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Use the corner UI controls to change the properties of the viewshed and see them

To create a viewshed from a location and directional parameters:

1. Create a `LocationViewshed` passing in the observer location, heading, pitch, horizontal/vertical angles, and min/max distances.
2. Set the property values directly on the viewshed instance for location, direction, range, and visibility properties. The colors are global, so change them via the static properties on `Viewshed`.
1. Create a `LocationViewshed` passing in the observer location, heading, pitch, horizontal/vertical angles, and min/max distances.
2. Set the property values directly on the viewshed instance for location, direction, range, and visibility properties. The colors are global, so change them via the static properties on `Viewshed`.

## Relevant API

* 3D
* AnalysisOverlay
* ArcGISTiledElevationSource
* ArcGISScene
* ArcGISSceneLayer
* LocationViewshed
* SceneView
* 3D
* AnalysisOverlay
* ArcGISTiledElevationSource
* ArcGISScene
* ArcGISSceneLayer
* LocationViewshed
* SceneView
47 changes: 21 additions & 26 deletions display_information/add-graphics-with-renderer/README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,29 @@
<h1>Add Graphics with Renderer</h1>
# Add Graphics with Renderer

<p>Specify a graphic's symbol with a renderer.</p>
Specify a graphic's symbol with a renderer.

<p>A renderer allows you to change the style of all graphics in an overlay by only changing one copy of the symbol. A renderer will only effect
graphics that do not specify their own symbol.</p>
A renderer allows you to change the style of all graphics in an overlay by only changing one copy of the symbol. A renderer will only effect graphics that do not specify their own symbol.

<p><img src="AddGraphicsWithRenderer.png"/></p>
![](AddGraphicsWithRenderer.png)

<h2>How it works</h2>
## How it works

<p>To show a <code>Graphic</code> in a <code>GraphicsOverlay</code> using a renderer:</p>
To show a `Graphic` in a `GraphicsOverlay` using a renderer:

<ol>
<li>Create a <code>GraphicsOverlay</code> and add it to the <code>MapView</code></li>
<li>Create a <code>Graphic</code>, specifying only its geometry</li>
<li>Create a single <code>Symbol</code> such as a <code>SimpleMarkerSymbol</code></li>
<li>Create a renderer with the symbol such as <code>new SimpleRenderer(symbol)</code></li>
<li>Set the renderer on the graphics overlay with <code>graphicsOverlay.setRenderer(renderer)</code></li>
</ol>
1. Create a `GraphicsOverlay` and add it to the `MapView`
2. Create a `Graphic`, specifying only its geometry
3. Create a single `Symbol` such as a `SimpleMarkerSymbol`
4. Create a renderer with the symbol such as `new SimpleRenderer(symbol)`
5. Set the renderer on the graphics overlay with `graphicsOverlay.setRenderer(renderer)`

<h2>Relevant API</h2>
## Relevant API

<ul>
<li>ArcGISMap</li>
<li>Graphic</li>
<li>GraphicsOverlay</li>
<li>MapView</li>
<li>Point</li>
<li>SimpleFillSymbol</li>
<li>SimpleLineSymbol</li>
<li>SimpleMarkerSymbol</li>
<li>SimpleRenderer</li>
</ul>
* ArcGISMap
* Graphic
* GraphicsOverlay
* MapView
* Point
* SimpleFillSymbol
* SimpleLineSymbol
* SimpleMarkerSymbol
* SimpleRenderer
96 changes: 45 additions & 51 deletions display_information/add-graphics-with-symbols/README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,45 @@
<h1>Add Graphics with Symbols</h1>

<p>Draw simple graphics with marker, line, polygon, and text symbols.</p>

<p><img src="AddGraphicsWithSymbols.png"/></p>

<h2>How it works</h2>

<p>To display a <code>Graphic</code> using a symbol:</p>

<ol>
<li>Create a <code>GraphicsOverlay</code> and add it to the <code>MapView</code>, <code>MapView.getGraphicsOverlay.add()</code>.</li>
<li>To create a graphic using a <code>SimpleMarkerSymbol</code>.
<ul><li>create a <code>Point</code> where the graphic will be located</li>
<li>create a simple marker symbol that will display at that point</li>
<li>assign point and symbol to graphic, <code>Graphic(point, symbol)</code></li></ul></li>
<li>To create a graphic using a <code>SimpleLineSymbol</code>.
<ul><li>create a <code>PointCollection</code> that will hold all the points that make up the line</li>
<li>create a <code>Polyline</code> using the point collection, <code>Polyline(PointCollection)</code></li>
<li>create a simple line symbol that will display over those collected points</li>
<li>assign polyline and symbol to graphic, <code>Graphic(polyline, symbol)</code></li></ul></li>
<li>To create a graphic using a <code>SimepleFillSymbol</code>.
<ul><li>create a point collection that will hold all the points that make up the line</li>
<li>create a <code>Polygon</code> using the point collection, <code>Polygon(PointCollection)</code></li>
<li>create a simple line symbol that will display as an outline for points collected</li>
<li>create a simeple fill symbol, using line symbol from above, that will fill the region in between the points collected with a single color </li>
<li>assign polygon and symbol to graphic, <code>Graphic(polygon, symbol)</code></li></ul></li>
<li>To create a graphic using a <code>TextSymbol</code>.
<ul><li>create a point where the graphic will be located</li>
<li>create a text symbol, that will display at that point</li>
<li>assign point and symbol to graphic, <code>Graphic(point, symbol)</code></li></ul></li>
<li>Add graphic to graphics overlay to display it to the map view.</li>
</ol>

<h2>Relevant API</h2>

<ul>
<li>Graphic</li>
<li>GraphicsOverlay</li>
<li>MapView</li>
<li>Point</li>
<li>PointCollection</li>
<li>Polygon</li>
<li>Polyline</li>
<li>SimepleFillSymbol</li>
<li>SimpleLineSymbol</li>
<li>SimpleMarkerSymbol</li>
<li>TextSymbol</li>
</ul>


# Add Graphics with Symbols

Draw simple graphics with marker, line, polygon, and text symbols.

![](AddGraphicsWithSymbols.png)

## How it works

To display a `Graphic` using a symbol:

1. Create a `GraphicsOverlay` and add it to the `MapView`, `MapView.getGraphicsOverlay.add()`.
2. To create a graphic using a `SimpleMarkerSymbol`.
* create a `Point` where the graphic will be located
* create a simple marker symbol that will display at that point
* assign point and symbol to graphic, `Graphic(point, symbol)`
3. To create a graphic using a `SimpleLineSymbol`.
* create a `PointCollection` that will hold all the points that make up the line
* create a `Polyline` using the point collection, `Polyline(PointCollection)`
* create a simple line symbol that will display over those collected points
* assign polyline and symbol to graphic, `Graphic(polyline, symbol)`
4. To create a graphic using a `SimepleFillSymbol`.
* create a point collection that will hold all the points that make up the line
* create a `Polygon` using the point collection, `Polygon(PointCollection)`
* create a simple line symbol that will display as an outline for points collected
* create a simeple fill symbol, using line symbol from above, that will fill the region in between the points collected with a single color
* assign polygon and symbol to graphic, `Graphic(polygon, symbol)`
5. To create a graphic using a `TextSymbol`.
* create a point where the graphic will be located
* create a text symbol, that will display at that point
* assign point and symbol to graphic, `Graphic(point, symbol)`
6. Add graphic to graphics overlay to display it to the map view.

## Relevant API

* Graphic
* GraphicsOverlay
* MapView
* Point
* PointCollection
* Polygon
* Polyline
* SimepleFillSymbol
* SimpleLineSymbol
* SimpleMarkerSymbol
* TextSymbol
Loading