Apply Common Design to Show Magnifier Sample (#85)

* Add README

* Add screen capture

* Generate metadata

* Update generated_samples_list.json

* Add comments

* Update README.md

Author: jenmerritt

assets/generated_samples_list.json

@@ -718,11 +718,45 @@
     "category": "Search and Query",
     "description": "Query a table to get aggregated statistics back for a specific field.",
     "ignore": false,
-    "images": [],
-    "keywords": [],
+    "images": [
+      "query_table_statistics.png"
+    ],
+    "keywords": [
+      "analysis",
+      "average",
+      "bounding geometry",
+      "filter",
+      "intersect",
+      "maximum",
+      "mean",
+      "minimum",
+      "query",
+      "spatial query",
+      "standard deviation",
+      "statistics",
+      "sum",
+      "variance",
+      "QueryParameters",
+      "ServiceFeatureTable",
+      "StatisticDefinition",
+      "StatisticRecord",
+      "StatisticType",
+      "StatisticsQueryParameters",
+      "StatisticsQueryResult"
+    ],
     "redirect_from": [],
-    "relevant_apis": [],
-    "snippets": [],
+    "relevant_apis": [
+      "QueryParameters",
+      "ServiceFeatureTable",
+      "StatisticDefinition",
+      "StatisticRecord",
+      "StatisticType",
+      "StatisticsQueryParameters",
+      "StatisticsQueryResult"
+    ],
+    "snippets": [
+      "query_table_statistics_sample.dart"
+    ],
     "title": "Query table statistics",
     "key": "query_table_statistics"
   },
@@ -742,11 +776,28 @@
     "category": "Search and Query",
     "description": "Select features in a feature layer.",
     "ignore": false,
-    "images": [],
-    "keywords": [],
+    "images": [
+      "select_features_in_feature_layer.png"
+    ],
+    "keywords": [
+      "features",
+      "layers",
+      "select",
+      "selection",
+      "tolerance",
+      "Feature",
+      "FeatureLayer",
+      "ServiceFeatureTable"
+    ],
     "redirect_from": [],
-    "relevant_apis": [],
-    "snippets": [],
+    "relevant_apis": [
+      "Feature",
+      "FeatureLayer",
+      "ServiceFeatureTable"
+    ],
+    "snippets": [
+      "select_features_in_feature_layer_sample.dart"
+    ],
     "title": "Select features in feature layer",
     "key": "select_features_in_feature_layer"
   },
@@ -860,11 +911,30 @@
     "category": "Maps",
     "description": "Tap and hold on a map to show a magnifier.",
     "ignore": false,
-    "images": [],
-    "keywords": [],
+    "images": [
+      "show_magnifier.png"
+    ],
+    "keywords": [
+      "magnify",
+      "map",
+      "zoom",
+      "ArcGISMap",
+      "ArcGISMapView",
+      "ArcGISMapViewController",
+      "ArcGISMapViewController.allowMagnifierToPanMap",
+      "ArcGISMapViewController.magnifiedEnabled"
+    ],
     "redirect_from": [],
-    "relevant_apis": [],
-    "snippets": [],
+    "relevant_apis": [
+      "ArcGISMap",
+      "ArcGISMapView",
+      "ArcGISMapViewController",
+      "ArcGISMapViewController.allowMagnifierToPanMap",
+      "ArcGISMapViewController.magnifiedEnabled"
+    ],
+    "snippets": [
+      "show_magnifier_sample.dart"
+    ],
     "title": "Show magnifier",
     "key": "show_magnifier"
   },

lib/samples/show_magnifier/README.md

@@ -0,0 +1,31 @@
+# Show magnifier
+
+Tap and hold on a map to show a magnifier.
+
+![Image of show magnifier](show_magnifier.png)
+
+## Use case
+
+Due to the limited screen size of some mobile devices, it may be difficult to identify individual features on a map where there is a high density of information, or the scale is very small. This can be the case when a mobile device is used for navigation, and the user wishes to magnify a particular area to better identify a road intersection.
+
+## How to use the sample
+
+Tap and hold on the map to show a magnifier, then drag across the map to move the magnifier. You can also pan the map while holding the magnifier, by dragging the magnifier to the edge of the map.
+
+## How it works
+
+1. Create a new `ArcGISMapView` with an `ArcGISMapViewController`, and assign an `ArcGISMap` to the `ArcGISMapViewController.arcGISMap` property.
+2. Enable the magnifier by setting the `ArcGISMapViewController.magnifiedEnabled` property to `true`. This will set the magnifier to be shown on the `ArcGISMap` when the user performs a long press gesture. Note: The default value is `false`.
+3. Optionally, set the `ArcGISMapViewController.allowMagnifierToPanMap` property to `true` to allow the map to be panned automatically when the magnifier gets near the edge of the `ArcGISMap`. Note: The default value is `true`.
+
+## Relevant API
+
+* ArcGISMap
+* ArcGISMapView
+* ArcGISMapViewController
+* ArcGISMapViewController.allowMagnifierToPanMap
+* ArcGISMapViewController.magnifiedEnabled
+
+## Tags
+
+magnify, map, zoom

lib/samples/show_magnifier/README.metadata.json

@@ -2,10 +2,29 @@
     "category": "Maps",
     "description": "Tap and hold on a map to show a magnifier.",
     "ignore": false,
-    "images": [],
-    "keywords": [],
+    "images": [
+        "show_magnifier.png"
+    ],
+    "keywords": [
+        "magnify",
+        "map",
+        "zoom",
+        "ArcGISMap",
+        "ArcGISMapView",
+        "ArcGISMapViewController",
+        "ArcGISMapViewController.allowMagnifierToPanMap",
+        "ArcGISMapViewController.magnifiedEnabled"
+    ],
     "redirect_from": [],
-    "relevant_apis": [],
-    "snippets": [],
+    "relevant_apis": [
+        "ArcGISMap",
+        "ArcGISMapView",
+        "ArcGISMapViewController",
+        "ArcGISMapViewController.allowMagnifierToPanMap",
+        "ArcGISMapViewController.magnifiedEnabled"
+    ],
+    "snippets": [
+        "show_magnifier_sample.dart"
+    ],
     "title": "Show magnifier"
 }

lib/samples/show_magnifier/show_magnifier.png

@@ -23,8 +23,10 @@ class ShowMagnifierSample extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return Scaffold(
+      // Add a map view to the widget tree and set a controller.
       body: ArcGISMapView(
         controllerProvider: () => ArcGISMapView.createController()
+          // Set a map with an initial viewpoint.
           ..arcGISMap =
               ArcGISMap.withBasemapStyle(BasemapStyle.arcGISImageryStandard)
           ..arcGISMap!.initialViewpoint = Viewpoint.fromCenter(
@@ -35,6 +37,7 @@ class ShowMagnifierSample extends StatelessWidget {
             ),
             scale: 2e4,
           )
+          // Set the magnifier enabled property to true to show the magnifier on long press.
           ..magnifierEnabled = true,
       ),
     );