Skip to content

Commit

Permalink
Updates to the readme copy script (#992)
Browse files Browse the repository at this point in the history
* Added sample exclusion to script

* Update metadata

* Added logic for "clicked" and "tapped"
  • Loading branch information
ZackAllen authored Mar 29, 2022
1 parent 9701e52 commit c8181fb
Show file tree
Hide file tree
Showing 27 changed files with 59 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ namespace ArcGISRuntime.Samples.EditAndSyncFeatures
name: "Edit and sync features",
category: "Data",
description: "Synchronize offline edits with a feature service.",
instructions: "Pan and zoom to position the red rectangle around the area you want to take offline. Tap \"Generate geodatabase\" to take the area offline. When complete, the map will update to only show the offline area. To edit features, tap to select a feature, and tap again anywhere else on the map to move the selected feature to the clicked location. To sync the edits with the feature service, tap the \"Sync geodatabase\" button.",
instructions: "Pan and zoom to position the red rectangle around the area you want to take offline. Tap \"Generate geodatabase\" to take the area offline. When complete, the map will update to only show the offline area. To edit features, tap to select a feature, and tap again anywhere else on the map to move the selected feature to the tapped location. To sync the edits with the feature service, tap the \"Sync geodatabase\" button.",
tags: new[] { "feature service", "geodatabase", "offline", "synchronize" })]
[ArcGISRuntime.Samples.Shared.Attributes.OfflineData("e4a398afe9a945f3b0f4dca1e4faccb5")]
public partial class EditAndSyncFeatures : ContentPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A survey worker who works in an area without an internet connection could take a

## How to use the sample

Pan and zoom to position the red rectangle around the area you want to take offline. Tap "Generate geodatabase" to take the area offline. When complete, the map will update to only show the offline area. To edit features, tap to select a feature, and tap again anywhere else on the map to move the selected feature to the clicked location. To sync the edits with the feature service, tap the "Sync geodatabase" button.
Pan and zoom to position the red rectangle around the area you want to take offline. Tap "Generate geodatabase" to take the area offline. When complete, the map will update to only show the offline area. To edit features, tap to select a feature, and tap again anywhere else on the map to move the selected feature to the tapped location. To sync the edits with the feature service, tap the "Sync geodatabase" button.

## How it works

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ namespace ArcGISRuntime.Samples.FormatCoordinates
name: "Format coordinates",
category: "Geometry",
description: "Format coordinates in a variety of common notations.",
instructions: "Tap on the map to see a callout with the clicked location's coordinate formatted in 4 different ways. You can also put a coordinate string in any of these formats in the text field. Hit Enter and the coordinate string will be parsed to a map location which the callout will move to.",
instructions: "Tap on the map to see a callout with the tapped location's coordinate formatted in 4 different ways. You can also put a coordinate string in any of these formats in the text field. Hit Enter and the coordinate string will be parsed to a map location which the callout will move to.",
tags: new[] { "USNG", "UTM", "convert", "coordinate", "decimal degrees", "degree minutes seconds", "format", "latitude", "longitude" })]
public partial class FormatCoordinates : ContentPage
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The coordinate formatter can format a map location in WGS84 in a number of commo

## How to use the sample

Tap on the map to see a callout with the clicked location's coordinate formatted in 4 different ways. You can also put a coordinate string in any of these formats in the text field. Hit Enter and the coordinate string will be parsed to a map location which the callout will move to.
Tap on the map to see a callout with the tapped location's coordinate formatted in 4 different ways. You can also put a coordinate string in any of these formats in the text field. Hit Enter and the coordinate string will be parsed to a map location which the callout will move to.

## How it works

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace ArcGISRuntime.Samples.NearestVertex
name: "Nearest vertex",
category: "Geometry",
description: "Find the closest vertex and coordinate of a geometry to a point.",
instructions: "Tap anywhere on the map. An orange cross will show at that location. A blue circle will show the polygon's nearest vertex to the point that was clicked. A red diamond will appear at the coordinate on the geometry that is nearest to the point that was clicked. If clicked inside the geometry, the red and orange markers will overlap. The information box showing distance between the clicked point and the nearest vertex/coordinate will be updated with every new location clicked.",
instructions: "Tap anywhere on the map. An orange cross will show at that location. A blue circle will show the polygon's nearest vertex to the point that was clicked. A red diamond will appear at the coordinate on the geometry that is nearest to the point that was clicked. If tapped inside the geometry, the red and orange markers will overlap. The information box showing distance between the tapped point and the nearest vertex/coordinate will be updated with every new location clicked.",
tags: new[] { "analysis", "coordinate", "geometry", "nearest", "proximity", "vertex" })]
public partial class NearestVertex
{
Expand Down
2 changes: 1 addition & 1 deletion src/Forms/Shared/Samples/Geometry/NearestVertex/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Determine the shortest distance between a location and the boundary of an area.

## How to use the sample

Tap anywhere on the map. An orange cross will show at that location. A blue circle will show the polygon's nearest vertex to the point that was tapped. A red diamond will appear at the coordinate on the geometry that is nearest to the point that was tapped. If tapped inside the geometry, the red and orange markers will overlap. The information box showing distance between the tapped point and the nearest vertex/coordinate will be updated with every new location tapped.
Tap anywhere on the map. An orange cross will show at that location. A blue circle will show the polygon's nearest vertex to the point that was clicked. A red diamond will appear at the coordinate on the geometry that is nearest to the point that was clicked. If tapped inside the geometry, the red and orange markers will overlap. The information box showing distance between the tapped point and the nearest vertex/coordinate will be updated with every new location clicked.

## How it works

Expand Down
2 changes: 1 addition & 1 deletion src/Forms/Shared/Samples/Geometry/Project/Project.xaml.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace ArcGISRuntimeXamarin.Samples.Project
name: "Project",
category: "Geometry",
description: "Project a point from one spatial reference to another.",
instructions: "Tap anywhere on the map. A callout will display the clicked location's coordinate in the original (basemap's) spatial reference and in the projected spatial reference.",
instructions: "Tap anywhere on the map. A callout will display the tapped location's coordinate in the original (basemap's) spatial reference and in the projected spatial reference.",
tags: new[] { "WGS 84", "Web Mercator", "coordinate system", "coordinates", "latitude", "longitude", "projected", "projection", "spatial reference" })]
public partial class Project : ContentPage
{
Expand Down
2 changes: 1 addition & 1 deletion src/Forms/Shared/Samples/Geometry/Project/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Being able to project between spatial references is fundamental to a GIS. An exa

## How to use the sample

Tap anywhere on the map. A callout will display the clicked location's coordinate in the original (basemap's) spatial reference and in the projected spatial reference.
Tap anywhere on the map. A callout will display the tapped location's coordinate in the original (basemap's) spatial reference and in the projected spatial reference.

## How it works

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Select a graphic to identify it. You will see an alert message displayed.

1. Create a `GraphicsOverlay` and add it to the `MapView`.
2. Add a `Graphic` along with a `SimpleFillSymbol` to the graphics overlay.
3. Create a `Point` from the location clicked on the map view by the user.
3. Create a `Point` from the location tapped on the map view by the user.
4. Identify the graphic on the map view with `IdentifyGraphicsOverlayAsync(graphicsOverlay, pointClicked, tolerance, max results)`.

## Relevant API
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Tap on a feature in the map. All features within a given tolerance (in pixels) o

1. Create a `ServiceFeatureTable` from a feature service URL.
2. Create a `FeatureLayer` from the service feature table.
3. Identify nearby features at the clicked location using `IdentifyLayerAsync(featureLayer, clickLocation, tolerance, returnPopupsOnly, maxResults)` on the map view.
3. Identify nearby features at the tapped location using `IdentifyLayerAsync(featureLayer, clickLocation, tolerance, returnPopupsOnly, maxResults)` on the map view.
4. Select all identified features in the feature layer with `SelectFeatures(features)`.

## Relevant API
Expand Down
2 changes: 1 addition & 1 deletion src/Forms/Shared/Samples/Map/ChangeBasemap/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Basemaps should be selected contextually. For example, in maritime applications,

## How to use the sample

When the basemap gallery appears, select a basemap to be displayed. Tap the 'Hide Gallery' button to hide the gallery. If you want to see the gallery again, tap the 'Show Gallery' button.
When the basemap gallery appears, select a basemap to be displayed.

## How it works

Expand Down
2 changes: 1 addition & 1 deletion src/Forms/Shared/Samples/Map/DisplayOverviewMap/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The data used in this sample is the [OpenStreetMap Tourist Attractions for North

## Additional information

This sample uses the overview map toolkit component which can be accessed using the Esri.ArcGISRuntime.Toolkit.Xamarin.Forms nuget package. The [toolkit](https://github.com/Esri/arcgis-toolkit-dotnet) can also be cloned and set up locally. For information about setting up the toolkit, visit the [repository](https://github.com/Esri/arcgis-toolkit-dotnet/blob/main/README.md).
This sample uses the overview map toolkit component which can be accessed using the Esri.ArcGISRuntime.Toolkit nuget package. The [toolkit](https://github.com/Esri/arcgis-toolkit-dotnet) can also be cloned and set up locally. For information about setting up the toolkit, visit the [repository](https://github.com/Esri/arcgis-toolkit-dotnet/blob/main/README.md).

## Tags

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
],
"nuget_packages": {
"Esri.ArcGISRuntime": "100.13.0",
"Esri.ArcGISRuntime.Toolkit.Xamarin.Forms": "100.13.0",
"Esri.ArcGISRuntime.UWP": "100.13.0",
"Esri.ArcGISRuntime.Xamarin.Android": "100.13.0",
"Esri.ArcGISRuntime.Xamarin.Forms": "100.13.0",
"Esri.ArcGISRuntime.Xamarin.iOS": "100.13.0",
"Esri.ArcGISRuntime.Toolkit.Xamarin.Forms": "100.13.0"
"Esri.ArcGISRuntime.Xamarin.iOS": "100.13.0"
},
"offline_data": [],
"redirect_from": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace ArcGISRuntime.Samples.ClosestFacility
name: "Find closest facility to an incident (interactive)",
category: "Network analysis",
description: "Find a route to the closest facility from a location.",
instructions: "Tap near any of the hospitals and a route will be displayed from that clicked location to the nearest hospital.",
instructions: "Tap near any of the hospitals and a route will be displayed from that tapped location to the nearest hospital.",
tags: new[] { "incident", "network analysis", "route", "search" })]
public partial class ClosestFacility
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Quickly and accurately determining the most efficient route between a location a

## How to use the sample

Tap near any of the hospitals and a route will be displayed from that clicked location to the nearest hospital.
Tap near any of the hospitals and a route will be displayed from that tapped location to the nearest hospital.

## How it works

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ namespace ArcGISRuntimeXamarin.Samples.CustomDictionaryStyle
[ArcGISRuntime.Samples.Shared.Attributes.Sample(
name: "Custom dictionary style",
category: "Symbology",
description: "Use a custom dictionary style (.stylx) to symbolize features using a variety of attribute values.",
instructions: "Pan and zoom the map to see the symbology from the custom dictionary style.",
tags: new[] { "ArcGIS Online", "dictionary", "military", "renderer", "style", "stylx", "unique value", "visualization", "web styles" })]
description: "Use a custom dictionary created from a web style or style file (.stylx) to symbolize features using a variety of attribute values.",
instructions: "Use the radio buttons to toggle between the dictionary symbols from the web style and style file. Pan and zoom around the map to see the symbology from the chosen dictionary symbol style. The web style and style file are slightly different to each other to give a visual indication of the switch between the two.",
tags: new[] { "ArcGIS Online", "dictionary", "military", "renderer", "style", "stylx", "unique value", "visualization", "web style" })]
[ArcGISRuntime.Samples.Shared.Attributes.OfflineData("751138a2e0844e06853522d54103222a")]
public partial class CustomDictionaryStyle : ContentPage
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
{
"category": "Symbology",
"description": "Use a custom dictionary style (.stylx) to symbolize features using a variety of attribute values.",
"description": "Use a custom dictionary created from a web style or style file (.stylx) to symbolize features using a variety of attribute values.",
"formal_name": "CustomDictionaryStyle",
"ignore": false,
"images": [
"CustomDictionaryStyle.jpg"
],
"keywords": [
"ArcGIS Online",
"dictionary",
"military",
"renderer",
"style",
"stylx",
"unique value",
"visualization"
"visualization",
"web style"
],
"nuget_packages": {
"Esri.ArcGISRuntime": "100.13.0",
Expand All @@ -31,7 +33,8 @@
"relevant_apis": [
"DictionaryRenderer",
"DictionarySymbolStyle",
"DictionarySymbolStyleConfiguration"
"DictionarySymbolStyleConfiguration",
"PortalItem"
],
"snippets": [
"CustomDictionaryStyle.xaml",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ Tap on one or more features to use as filter barriers or create and set the conf
10. Create a `UtilityElement` for the identified feature and add this `UtilityElement` to a collection of filter barriers.
* If the element is a junction with more than one terminal, display a terminal picker. Then set the junction's `Terminal` property with the selected terminal.
* If an edge, set its `FractionAlongLine` property using `GeometryEngine.FractionAlong`.
11. If 'Trace' is clicked without filter barriers:
11. If 'Trace' is tapped without filter barriers:
* Create a new `UtilityCategoryComparison` with the selected category and `UtilityCategoryComparisonOperator.Exists`.
* Create a new `UtilityTraceFilter` with this condition as `Barriers` to set `Filter` and update `IncludeIsolatedFeatures` properties of the default configuration from step 5.
* Run a `UtilityNetwork.TraceAsync`.

If 'Trace' is clicked with filter barriers:
If 'Trace' is tapped with filter barriers:
* Update `IncludeIsolatedFeatures` property of the default configuration from step 5.
* Run a `UtilityNetwork.TraceAsync`.
12. For every `FeatureLayer` in the map, select the features returned with `GetFeaturesForElementsAsync` from the elements matching their `NetworkSource.FeatureTable` with the layer's `FeatureTable`.
Expand Down
2 changes: 1 addition & 1 deletion src/Forms/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@

## Symbology

* [Custom dictionary style](Shared/Samples/Symbology/CustomDictionaryStyle/readme.md) - Use a custom dictionary style (.stylx) to symbolize features using a variety of attribute values.
* [Custom dictionary style](Shared/Samples/Symbology/CustomDictionaryStyle/readme.md) - Use a custom dictionary created from a web style or style file (.stylx) to symbolize features using a variety of attribute values.
* [Feature layer extrusion](Shared/Samples/Symbology/FeatureLayerExtrusion/readme.md) - Extrude features based on their attributes.
* [Picture marker symbol](Shared/Samples/Symbology/RenderPictureMarkers/readme.md) - Use pictures for markers.
* [Simple marker symbol](Shared/Samples/Symbology/RenderSimpleMarkers/readme.md) - Show a simple marker symbol on a map.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
],
"nuget_packages": {
"Esri.ArcGISRuntime": "100.13.0",
"Esri.ArcGISRuntime.WPF": "100.13.0",
"Esri.ArcGISRuntime.Toolkit": "100.13.0"
"Esri.ArcGISRuntime.Toolkit": "100.13.0",
"Esri.ArcGISRuntime.WPF": "100.13.0"
},
"offline_data": [],
"redirect_from": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ namespace ArcGISRuntime.WPF.Samples.CustomDictionaryStyle
[ArcGISRuntime.Samples.Shared.Attributes.Sample(
name: "Custom dictionary style",
category: "Symbology",
description: "Use a custom dictionary style (.stylx) to symbolize features using a variety of attribute values.",
instructions: "Pan and zoom the map to see the symbology from the custom dictionary style.",
description: "Use a custom dictionary created from a web style or style file (.stylx) to symbolize features using a variety of attribute values.",
instructions: "Use the radio buttons to toggle between the dictionary symbols from the web style and style file. Pan and zoom around the map to see the symbology from the chosen dictionary symbol style. The web style and style file are slightly different to each other to give a visual indication of the switch between the two.",
tags: new[] { "ArcGIS Online", "dictionary", "military", "renderer", "style", "stylx", "unique value", "visualization", "web style" })]
[ArcGISRuntime.Samples.Shared.Attributes.OfflineData("751138a2e0844e06853522d54103222a")]
public partial class CustomDictionaryStyle
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
{
"category": "Symbology",
"description": "Use a custom dictionary style (.stylx) to symbolize features using a variety of attribute values.",
"description": "Use a custom dictionary created from a web style or style file (.stylx) to symbolize features using a variety of attribute values.",
"formal_name": "CustomDictionaryStyle",
"ignore": false,
"images": [
"CustomDictionaryStyle.jpg"
],
"keywords": [
"ArcGIS Online",
"dictionary",
"military",
"renderer",
"style",
"stylx",
"unique value",
"visualization"
"visualization",
"web style"
],
"nuget_packages": {
"Esri.ArcGISRuntime": "100.13.0",
Expand All @@ -28,7 +30,8 @@
"relevant_apis": [
"DictionaryRenderer",
"DictionarySymbolStyle",
"DictionarySymbolStyleConfiguration"
"DictionarySymbolStyleConfiguration",
"PortalItem"
],
"snippets": [
"CustomDictionaryStyle.xaml",
Expand Down
2 changes: 1 addition & 1 deletion src/WPF/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@

## Symbology

* [Custom dictionary style](ArcGISRuntime.WPF.Viewer/Samples/Symbology/CustomDictionaryStyle/readme.md) - Use a custom dictionary style (.stylx) to symbolize features using a variety of attribute values.
* [Custom dictionary style](ArcGISRuntime.WPF.Viewer/Samples/Symbology/CustomDictionaryStyle/readme.md) - Use a custom dictionary created from a web style or style file (.stylx) to symbolize features using a variety of attribute values.
* [Feature layer extrusion](ArcGISRuntime.WPF.Viewer/Samples/Symbology/FeatureLayerExtrusion/readme.md) - Extrude features based on their attributes.
* [Picture marker symbol](ArcGISRuntime.WPF.Viewer/Samples/Symbology/RenderPictureMarkers/readme.md) - Use pictures for markers.
* [Simple marker symbol](ArcGISRuntime.WPF.Viewer/Samples/Symbology/RenderSimpleMarkers/readme.md) - Show a simple marker symbol on a map.
Expand Down
Loading

0 comments on commit c8181fb

Please sign in to comment.