Skip to content

Commit ecbf71e

Browse files
JonLavitschie
authored andcommitted
reformat all readmes from html to md (#376)
reformat all readmes from html to md
1 parent 9a4e393 commit ecbf71e

File tree

172 files changed

+3932
-5043
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

172 files changed

+3932
-5043
lines changed

analysis/analyze-hotspots/README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ Select a start and end date using the datepickers between 1/1/1998 and 5/31/1998
1414

1515
To analyze hotspots using a geoprocessing service:
1616

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

2424
## Relevant API
2525

26-
* ArcGISMapImageLayer
27-
* GeoprocessingJob
28-
* GeoprocessingParameters
29-
* GeoprocessingResult
30-
* GeoprocessingString
31-
* GeoprocessingTask
26+
* ArcGISMapImageLayer
27+
* GeoprocessingJob
28+
* GeoprocessingParameters
29+
* GeoprocessingResult
30+
* GeoprocessingString
31+
* GeoprocessingTask

analysis/distance-measurement-analysis/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ Choose a unit system for the measurement in the UI dropdown. Click any location
1414

1515
To measure distances with the `LocationDistanceMeasurement` analysis:
1616

17-
1. Create an `AnalysisOverlay` and add it to your scene view's analysis overlay collection: `sceneView.getAnalysisOverlays().add(analysisOverlay)`.
18-
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.
19-
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.
17+
1. Create an `AnalysisOverlay` and add it to your scene view's analysis overlay collection: `sceneView.getAnalysisOverlays().add(analysisOverlay)`.
18+
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.
19+
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.
2020

2121
## Relevant API
2222

23-
* AnalysisOverlay
24-
* LocationDistanceMeasurement
25-
* UnitSystem
23+
* AnalysisOverlay
24+
* LocationDistanceMeasurement
25+
* UnitSystem
2626

2727
## Additional information
2828

2929
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.
3030

3131
## Tags
3232

33-
Analysis, 3D
33+
Analysis, 3D

analysis/line-of-sight-geoelement/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ A line of sight will display between a point on the Empire State Building (obser
1414

1515
To show a line of sight between two graphics:
1616

17-
1. Create an `AnalysisOverlay` and add it to the `SceneView`'s analysis overlays collection.
18-
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.
19-
3. To get the target visibility when it changes, add a `TargetVisibilityChangedListener` to the line of sight. The changed event will give the `TargetVisibility`.
17+
1. Create an `AnalysisOverlay` and add it to the `SceneView`'s analysis overlays collection.
18+
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.
19+
3. To get the target visibility when it changes, add a `TargetVisibilityChangedListener` to the line of sight. The changed event will give the `TargetVisibility`.
2020

2121
## Relevant API
2222

23-
* AnalysisOverlay
24-
* GeoElementLineOfSight
25-
* LineOfSight.TargetVisibility
23+
* AnalysisOverlay
24+
* GeoElementLineOfSight
25+
* LineOfSight.TargetVisibility
2626

2727
## Tags
2828

29-
Analysis
29+
Analysis

analysis/line-of-sight-location/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ Click to turn on the mouse move event listener. Then move the mouse where you wa
1212

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

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

2020
## Relevant API
2121

22-
* 3D
23-
* AnalysisOverlay
24-
* ArcGISTiledElevationSource
25-
* ArcGISScene
26-
* Camera
27-
* LocationLineOfSight
28-
* SceneView
22+
* 3D
23+
* AnalysisOverlay
24+
* ArcGISTiledElevationSource
25+
* ArcGISScene
26+
* Camera
27+
* LocationLineOfSight
28+
* SceneView

analysis/viewshed-camera/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ The sample will start with a viewshed created from the initial camera location,
1414

1515
To create and update a viewshed from a camera:
1616

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

2121
## Relevant API
2222

23-
* 3D
24-
* AnalysisOverlay
25-
* ArcGISTiledElevationSource
26-
* ArcGISScene
27-
* ArcGISSceneLayer
28-
* Camera
29-
* LocationViewshed
30-
* SceneView
23+
* 3D
24+
* AnalysisOverlay
25+
* ArcGISTiledElevationSource
26+
* ArcGISScene
27+
* ArcGISSceneLayer
28+
* Camera
29+
* LocationViewshed
30+
* SceneView

analysis/viewshed-geoelement/README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ Once the scene is done loading, click on a location for the tank to drive to. It
1212

1313
To attach a viewshed to a `GeoElement`:
1414

15-
1. Create a `Graphic` and add it to a `GraphicsOverlay`.
16-
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.
17-
3. Create a `GeoElementViewshed` with the graphic, heading/pitch offsets, and min/max distance.
18-
4. To offset the viewshed's observer location from the center of the graphic, use `viewshed.setOffsetX()`, etc.
15+
1. Create a `Graphic` and add it to a `GraphicsOverlay`.
16+
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.
17+
3. Create a `GeoElementViewshed` with the graphic, heading/pitch offsets, and min/max distance.
18+
4. To offset the viewshed's observer location from the center of the graphic, use `viewshed.setOffsetX()`, etc.
1919

2020
## Relevant API
2121

22-
* 3D
23-
* AnalysisOverlay
24-
* ArcGISTiledElevationSource
25-
* ArcGISScene
26-
* ArcGISSceneLayer
27-
* GeoElementViewshed
28-
* Graphic
29-
* SceneView
22+
* 3D
23+
* AnalysisOverlay
24+
* ArcGISTiledElevationSource
25+
* ArcGISScene
26+
* ArcGISSceneLayer
27+
* GeoElementViewshed
28+
* Graphic
29+
* SceneView

analysis/viewshed-geoprocessing/README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ After the geoprocessing task finishes loading (the spinner will stop), click any
1212

1313
To create a viewshed from a geoprocessing service:
1414

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

2323
## Relevant API
2424

25-
* FeatureCollectionTable
26-
* GeoprocessingFeatures
27-
* GeoprocessingJob
28-
* GeoprocessingParameters
29-
* GeoprocessingResult
30-
* GeoprocessingTask
25+
* FeatureCollectionTable
26+
* GeoprocessingFeatures
27+
* GeoprocessingJob
28+
* GeoprocessingParameters
29+
* GeoprocessingResult
30+
* GeoprocessingTask

analysis/viewshed-location/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ Use the corner UI controls to change the properties of the viewshed and see them
1212

1313
To create a viewshed from a location and directional parameters:
1414

15-
1. Create a `LocationViewshed` passing in the observer location, heading, pitch, horizontal/vertical angles, and min/max distances.
16-
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`.
15+
1. Create a `LocationViewshed` passing in the observer location, heading, pitch, horizontal/vertical angles, and min/max distances.
16+
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`.
1717

1818
## Relevant API
1919

20-
* 3D
21-
* AnalysisOverlay
22-
* ArcGISTiledElevationSource
23-
* ArcGISScene
24-
* ArcGISSceneLayer
25-
* LocationViewshed
26-
* SceneView
20+
* 3D
21+
* AnalysisOverlay
22+
* ArcGISTiledElevationSource
23+
* ArcGISScene
24+
* ArcGISSceneLayer
25+
* LocationViewshed
26+
* SceneView
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,29 @@
1-
<h1>Add Graphics with Renderer</h1>
1+
# Add Graphics with Renderer
22

3-
<p>Specify a graphic's symbol with a renderer.</p>
3+
Specify a graphic's symbol with a renderer.
44

5-
<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
6-
graphics that do not specify their own symbol.</p>
5+
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.
76

8-
<p><img src="AddGraphicsWithRenderer.png"/></p>
7+
![](AddGraphicsWithRenderer.png)
98

10-
<h2>How it works</h2>
9+
## How it works
1110

12-
<p>To show a <code>Graphic</code> in a <code>GraphicsOverlay</code> using a renderer:</p>
11+
To show a `Graphic` in a `GraphicsOverlay` using a renderer:
1312

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

22-
<h2>Relevant API</h2>
19+
## Relevant API
2320

24-
<ul>
25-
<li>ArcGISMap</li>
26-
<li>Graphic</li>
27-
<li>GraphicsOverlay</li>
28-
<li>MapView</li>
29-
<li>Point</li>
30-
<li>SimpleFillSymbol</li>
31-
<li>SimpleLineSymbol</li>
32-
<li>SimpleMarkerSymbol</li>
33-
<li>SimpleRenderer</li>
34-
</ul>
21+
* ArcGISMap
22+
* Graphic
23+
* GraphicsOverlay
24+
* MapView
25+
* Point
26+
* SimpleFillSymbol
27+
* SimpleLineSymbol
28+
* SimpleMarkerSymbol
29+
* SimpleRenderer
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,45 @@
1-
<h1>Add Graphics with Symbols</h1>
2-
3-
<p>Draw simple graphics with marker, line, polygon, and text symbols.</p>
4-
5-
<p><img src="AddGraphicsWithSymbols.png"/></p>
6-
7-
<h2>How it works</h2>
8-
9-
<p>To display a <code>Graphic</code> using a symbol:</p>
10-
11-
<ol>
12-
<li>Create a <code>GraphicsOverlay</code> and add it to the <code>MapView</code>, <code>MapView.getGraphicsOverlay.add()</code>.</li>
13-
<li>To create a graphic using a <code>SimpleMarkerSymbol</code>.
14-
<ul><li>create a <code>Point</code> where the graphic will be located</li>
15-
<li>create a simple marker symbol that will display at that point</li>
16-
<li>assign point and symbol to graphic, <code>Graphic(point, symbol)</code></li></ul></li>
17-
<li>To create a graphic using a <code>SimpleLineSymbol</code>.
18-
<ul><li>create a <code>PointCollection</code> that will hold all the points that make up the line</li>
19-
<li>create a <code>Polyline</code> using the point collection, <code>Polyline(PointCollection)</code></li>
20-
<li>create a simple line symbol that will display over those collected points</li>
21-
<li>assign polyline and symbol to graphic, <code>Graphic(polyline, symbol)</code></li></ul></li>
22-
<li>To create a graphic using a <code>SimepleFillSymbol</code>.
23-
<ul><li>create a point collection that will hold all the points that make up the line</li>
24-
<li>create a <code>Polygon</code> using the point collection, <code>Polygon(PointCollection)</code></li>
25-
<li>create a simple line symbol that will display as an outline for points collected</li>
26-
<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>
27-
<li>assign polygon and symbol to graphic, <code>Graphic(polygon, symbol)</code></li></ul></li>
28-
<li>To create a graphic using a <code>TextSymbol</code>.
29-
<ul><li>create a point where the graphic will be located</li>
30-
<li>create a text symbol, that will display at that point</li>
31-
<li>assign point and symbol to graphic, <code>Graphic(point, symbol)</code></li></ul></li>
32-
<li>Add graphic to graphics overlay to display it to the map view.</li>
33-
</ol>
34-
35-
<h2>Relevant API</h2>
36-
37-
<ul>
38-
<li>Graphic</li>
39-
<li>GraphicsOverlay</li>
40-
<li>MapView</li>
41-
<li>Point</li>
42-
<li>PointCollection</li>
43-
<li>Polygon</li>
44-
<li>Polyline</li>
45-
<li>SimepleFillSymbol</li>
46-
<li>SimpleLineSymbol</li>
47-
<li>SimpleMarkerSymbol</li>
48-
<li>TextSymbol</li>
49-
</ul>
50-
51-
1+
# Add Graphics with Symbols
2+
3+
Draw simple graphics with marker, line, polygon, and text symbols.
4+
5+
![](AddGraphicsWithSymbols.png)
6+
7+
## How it works
8+
9+
To display a `Graphic` using a symbol:
10+
11+
1. Create a `GraphicsOverlay` and add it to the `MapView`, `MapView.getGraphicsOverlay.add()`.
12+
2. To create a graphic using a `SimpleMarkerSymbol`.
13+
* create a `Point` where the graphic will be located
14+
* create a simple marker symbol that will display at that point
15+
* assign point and symbol to graphic, `Graphic(point, symbol)`
16+
3. To create a graphic using a `SimpleLineSymbol`.
17+
* create a `PointCollection` that will hold all the points that make up the line
18+
* create a `Polyline` using the point collection, `Polyline(PointCollection)`
19+
* create a simple line symbol that will display over those collected points
20+
* assign polyline and symbol to graphic, `Graphic(polyline, symbol)`
21+
4. To create a graphic using a `SimepleFillSymbol`.
22+
* create a point collection that will hold all the points that make up the line
23+
* create a `Polygon` using the point collection, `Polygon(PointCollection)`
24+
* create a simple line symbol that will display as an outline for points collected
25+
* create a simeple fill symbol, using line symbol from above, that will fill the region in between the points collected with a single color
26+
* assign polygon and symbol to graphic, `Graphic(polygon, symbol)`
27+
5. To create a graphic using a `TextSymbol`.
28+
* create a point where the graphic will be located
29+
* create a text symbol, that will display at that point
30+
* assign point and symbol to graphic, `Graphic(point, symbol)`
31+
6. Add graphic to graphics overlay to display it to the map view.
32+
33+
## Relevant API
34+
35+
* Graphic
36+
* GraphicsOverlay
37+
* MapView
38+
* Point
39+
* PointCollection
40+
* Polygon
41+
* Polyline
42+
* SimepleFillSymbol
43+
* SimpleLineSymbol
44+
* SimpleMarkerSymbol
45+
* TextSymbol

0 commit comments

Comments
 (0)