Merge pull request #1050 from Esri/willrawlings/1.9_api_ref

Adding api documentation for 1.9.
Esri · Jul 1, 2021 · 0d77589 · 0d77589
2 parents d7cec0f + 83e31c9
commit 0d77589
Show file tree

Hide file tree

Showing 421 changed files with 222,558 additions and 0 deletions.
diff --git a/apidoc/.buildinfo b/apidoc/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 070b7b5e7e43fd3d1b13643ed03f0948
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/apidoc/_images/ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY.png b/apidoc/_images/ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY.png
diff --git a/apidoc/_images/ALLOW_DEAD_ENDS_ONLY.png b/apidoc/_images/ALLOW_DEAD_ENDS_ONLY.png
diff --git a/apidoc/_images/ALLOW_UTURNS.png b/apidoc/_images/ALLOW_UTURNS.png
diff --git a/apidoc/_images/D8.gif b/apidoc/_images/D8.gif
diff --git a/apidoc/_images/Disks.png b/apidoc/_images/Disks.png
diff --git a/apidoc/_images/Dissolve.png b/apidoc/_images/Dissolve.png
diff --git a/apidoc/_images/Dissolve1.png b/apidoc/_images/Dissolve1.png
diff --git a/apidoc/_images/Erase.png b/apidoc/_images/Erase.png
diff --git a/apidoc/_images/Flat.png b/apidoc/_images/Flat.png
diff --git a/apidoc/_images/Full.png b/apidoc/_images/Full.png
diff --git a/apidoc/_images/Grid.png b/apidoc/_images/Grid.png
diff --git a/apidoc/_images/Left.png b/apidoc/_images/Left.png
diff --git a/apidoc/_images/None.png b/apidoc/_images/None.png
diff --git a/apidoc/_images/Outside.png b/apidoc/_images/Outside.png
diff --git a/apidoc/_images/Overlap.png b/apidoc/_images/Overlap.png
diff --git a/apidoc/_images/Right.png b/apidoc/_images/Right.png
diff --git a/apidoc/_images/Rings.png b/apidoc/_images/Rings.png
diff --git a/apidoc/_images/Round.png b/apidoc/_images/Round.png
diff --git a/apidoc/_images/Split.png b/apidoc/_images/Split.png
diff --git a/apidoc/_images/Symmetric_Difference.png b/apidoc/_images/Symmetric_Difference.png
diff --git a/apidoc/_images/Union.png b/apidoc/_images/Union.png
diff --git a/apidoc/_images/Unspecified.png b/apidoc/_images/Unspecified.png
diff --git a/apidoc/_images/add_image.png b/apidoc/_images/add_image.png
diff --git a/apidoc/_images/aggregate_points.png b/apidoc/_images/aggregate_points.png
diff --git a/apidoc/_images/aggregate_points1.png b/apidoc/_images/aggregate_points1.png
diff --git a/apidoc/_images/balanced.png b/apidoc/_images/balanced.png
diff --git a/apidoc/_images/calculate_density.png b/apidoc/_images/calculate_density.png
diff --git a/apidoc/_images/calculate_density1.png b/apidoc/_images/calculate_density1.png
diff --git a/apidoc/_images/calculate_field.png b/apidoc/_images/calculate_field.png
diff --git a/apidoc/_images/choose_best_facilities.png b/apidoc/_images/choose_best_facilities.png
diff --git a/apidoc/_images/clip_layer.png b/apidoc/_images/clip_layer.png
diff --git a/apidoc/_images/connect_origins_to_destinations.png b/apidoc/_images/connect_origins_to_destinations.png
diff --git a/apidoc/_images/contains.png b/apidoc/_images/contains.png
diff --git a/apidoc/_images/copy_to_data_store.png b/apidoc/_images/copy_to_data_store.png
diff --git a/apidoc/_images/create_buffers.png b/apidoc/_images/create_buffers.png
diff --git a/apidoc/_images/create_buffers_geo.png b/apidoc/_images/create_buffers_geo.png
diff --git a/apidoc/_images/create_drive_time_areas.png b/apidoc/_images/create_drive_time_areas.png
diff --git a/apidoc/_images/create_image_collection.png b/apidoc/_images/create_image_collection.png
diff --git a/apidoc/_images/create_space_time_cube.png b/apidoc/_images/create_space_time_cube.png
diff --git a/apidoc/_images/create_viewshed.png b/apidoc/_images/create_viewshed.png
diff --git a/apidoc/_images/create_watersheds.png b/apidoc/_images/create_watersheds.png
diff --git a/apidoc/_images/delete_image.png b/apidoc/_images/delete_image.png
diff --git a/apidoc/_images/delete_image_collection.png b/apidoc/_images/delete_image_collection.png
diff --git a/apidoc/_images/derive_new_locations.png b/apidoc/_images/derive_new_locations.png
diff --git a/apidoc/_images/describe_dataset.png b/apidoc/_images/describe_dataset.png
diff --git a/apidoc/_images/detect_incidents.png b/apidoc/_images/detect_incidents.png
diff --git a/apidoc/_images/dissolve_boundaries.png b/apidoc/_images/dissolve_boundaries.png
diff --git a/apidoc/_images/distance.png b/apidoc/_images/distance.png
diff --git a/apidoc/_images/either_side.png b/apidoc/_images/either_side.png
diff --git a/apidoc/_images/elevation_profile.png b/apidoc/_images/elevation_profile.png
diff --git a/apidoc/_images/elevation_viewshed.png b/apidoc/_images/elevation_viewshed.png
diff --git a/apidoc/_images/enrich_from_grid.png b/apidoc/_images/enrich_from_grid.png
diff --git a/apidoc/_images/enrich_layer.png b/apidoc/_images/enrich_layer.png
diff --git a/apidoc/_images/extract_data.png b/apidoc/_images/extract_data.png
diff --git a/apidoc/_images/find_centroids.png b/apidoc/_images/find_centroids.png
diff --git a/apidoc/_images/find_existing_locations.png b/apidoc/_images/find_existing_locations.png
diff --git a/apidoc/_images/find_hot_spots.png b/apidoc/_images/find_hot_spots.png
diff --git a/apidoc/_images/find_nearest.png b/apidoc/_images/find_nearest.png
diff --git a/apidoc/_images/find_outliers.png b/apidoc/_images/find_outliers.png
diff --git a/apidoc/_images/find_point_clusters.png b/apidoc/_images/find_point_clusters.png
diff --git a/apidoc/_images/find_similar_locations.png b/apidoc/_images/find_similar_locations.png
diff --git a/apidoc/_images/flow_direction.png b/apidoc/_images/flow_direction.png
diff --git a/apidoc/_images/forest.png b/apidoc/_images/forest.png
diff --git a/apidoc/_images/generate_service_areas.png b/apidoc/_images/generate_service_areas.png
diff --git a/apidoc/_images/geo_find_hot_spots.png b/apidoc/_images/geo_find_hot_spots.png
diff --git a/apidoc/_images/geocode_locations.png b/apidoc/_images/geocode_locations.png
diff --git a/apidoc/_images/glr.png b/apidoc/_images/glr.png
diff --git a/apidoc/_images/identity.png b/apidoc/_images/identity.png
diff --git a/apidoc/_images/interpolate_points.png b/apidoc/_images/interpolate_points.png
diff --git a/apidoc/_images/intersect.png b/apidoc/_images/intersect.png
diff --git a/apidoc/_images/join_features.png b/apidoc/_images/join_features.png
diff --git a/apidoc/_images/join_features_geo.png b/apidoc/_images/join_features_geo.png
diff --git a/apidoc/_images/left_side.png b/apidoc/_images/left_side.png
diff --git a/apidoc/_images/merge_layers.png b/apidoc/_images/merge_layers.png
diff --git a/apidoc/_images/nearest.png b/apidoc/_images/nearest.png
diff --git a/apidoc/_images/no_u_turn.png b/apidoc/_images/no_u_turn.png
diff --git a/apidoc/_images/overlay_layers.png b/apidoc/_images/overlay_layers.png
diff --git a/apidoc/_images/partially_balanced.png b/apidoc/_images/partially_balanced.png
diff --git a/apidoc/_images/plan_routes.png b/apidoc/_images/plan_routes.png
diff --git a/apidoc/_images/ra_calculate_density.png b/apidoc/_images/ra_calculate_density.png
diff --git a/apidoc/_images/ra_classify.png b/apidoc/_images/ra_classify.png
diff --git a/apidoc/_images/ra_convert_feature_to_raster.png b/apidoc/_images/ra_convert_feature_to_raster.png
diff --git a/apidoc/_images/ra_convert_raster_to_feature.png b/apidoc/_images/ra_convert_raster_to_feature.png
diff --git a/apidoc/_images/ra_copy_raster.png b/apidoc/_images/ra_copy_raster.png
diff --git a/apidoc/_images/ra_costpath_as_polyline.png b/apidoc/_images/ra_costpath_as_polyline.png
diff --git a/apidoc/_images/ra_create_viewshed.png b/apidoc/_images/ra_create_viewshed.png
diff --git a/apidoc/_images/ra_determine_travel_costpath_as_polyline.png b/apidoc/_images/ra_determine_travel_costpath_as_polyline.png
diff --git a/apidoc/_images/ra_generate_raster.png b/apidoc/_images/ra_generate_raster.png
diff --git a/apidoc/_images/ra_interpolate_points.png b/apidoc/_images/ra_interpolate_points.png
diff --git a/apidoc/_images/ra_optimum_travel_cost_network.png b/apidoc/_images/ra_optimum_travel_cost_network.png
diff --git a/apidoc/_images/ra_segment.png b/apidoc/_images/ra_segment.png
diff --git a/apidoc/_images/ra_summarize_raster_within.png b/apidoc/_images/ra_summarize_raster_within.png
diff --git a/apidoc/_images/ra_train_classifier.png b/apidoc/_images/ra_train_classifier.png
diff --git a/apidoc/_images/reconstruct_tracks.png b/apidoc/_images/reconstruct_tracks.png
diff --git a/apidoc/_images/right_side.png b/apidoc/_images/right_side.png
diff --git a/apidoc/_images/summarize_attributes.png b/apidoc/_images/summarize_attributes.png
diff --git a/apidoc/_images/summarize_center_and_dispersion.png b/apidoc/_images/summarize_center_and_dispersion.png
diff --git a/apidoc/_images/summarize_elevation.png b/apidoc/_images/summarize_elevation.png
diff --git a/apidoc/_images/summarize_nearby.png b/apidoc/_images/summarize_nearby.png
diff --git a/apidoc/_images/summarize_within.png b/apidoc/_images/summarize_within.png
diff --git a/apidoc/_images/summarize_within_geo.png b/apidoc/_images/summarize_within_geo.png
diff --git a/apidoc/_images/trace_downstream.png b/apidoc/_images/trace_downstream.png
diff --git a/apidoc/_images/unbalanced.png b/apidoc/_images/unbalanced.png
diff --git a/apidoc/_images/within.png b/apidoc/_images/within.png
diff --git a/apidoc/_sources/arcgis.apps.dashboard.rst.txt b/apidoc/_sources/arcgis.apps.dashboard.rst.txt
@@ -0,0 +1,109 @@
+arcgis.apps.dashboard module
+=======================
+
+.. automodule:: arcgis.apps.dashboard
+
+The :class:`~arcgis.apps.dashboard.Dashboard` is the main entry point into the Dashboard module.
+
+
+Dashboard
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.Dashboard
+    :members:
+    :undoc-members:
+
+Details
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.Details
+    :members:
+    :undoc-members:
+
+EmbeddedContent
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.EmbeddedContent
+    :members:
+    :undoc-members:
+
+Gauge
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.Gauge
+    :members:
+    :undoc-members:
+
+Header
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.Header
+    :members:
+    :undoc-members:
+
+Indicator
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.Indicator
+    :members:
+    :undoc-members:
+
+List
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.List
+    :members:
+    :undoc-members:
+
+MapLegend
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.MapLegend
+    :members:
+    :undoc-members:
+
+PieChart
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.PieChart
+    :members:
+    :undoc-members:
+
+RichText
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.RichText
+    :members:
+    :undoc-members:
+
+SerialChart
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.SerialChart
+    :members:
+    :undoc-members:
+
+SidePanel
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.SidePanel
+    :members:
+    :undoc-members:
+
+DatePicker
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.DatePicker
+    :members:
+    :undoc-members:
+
+CategorySelector
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.CategorySelector
+    :members:
+    :undoc-members:
+
+NumberSelector
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.NumberSelector
+    :members:
+    :undoc-members:
+
+add_row
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.add_row
+    :members:
+    :undoc-members:
+
+add_column
+--------------------------
+.. autoclass:: arcgis.apps.dashboard.add_column
+    :members:
+    :undoc-members:
diff --git a/apidoc/_sources/arcgis.apps.hub.rst.txt b/apidoc/_sources/arcgis.apps.hub.rst.txt
@@ -0,0 +1,58 @@
+arcgis.apps.hub module
+=======================
+
+.. automodule:: arcgis.apps.hub
+
+The :class:`~arcgis.apps.hub.Hub` is the main entry point into the Hub module.
+It can be used as shown in the following code example.
+
+.. code-block:: python
+
+    from arcgis.gis import GIS
+    gis = GIS("https://arcgis.com", "<username>", "<password>")
+    myHub = gis.hub
+    a_Initiative = myHub.initiatives.get(itemId)
+    a_Indicators = a_Initiative.indicators.search()
+    myEvents = myHub.events.search()
+
+Hub
+--------------------------
+.. autoclass:: arcgis.apps.hub.Hub
+    :members:
+    :undoc-members:
+
+Initiative
+--------------------------
+.. autoclass:: arcgis.apps.hub.Initiative
+    :members:
+    :undoc-members:
+
+Indicator
+--------------------------
+.. autoclass:: arcgis.apps.hub.Indicator
+    :members:
+    :undoc-members:
+
+Event
+--------------------------
+.. autoclass:: arcgis.apps.hub.Event
+    :members:
+    :undoc-members:
+
+InitiativeManager
+--------------------------
+.. autoclass:: arcgis.apps.hub.InitiativeManager
+    :members:
+    :undoc-members:
+
+IndicatorManager
+--------------------------
+.. autoclass:: arcgis.apps.hub.IndicatorManager
+    :members:
+    :undoc-members:
+
+EventManager
+--------------------------
+.. autoclass:: arcgis.apps.hub.EventManager
+    :members:
+    :undoc-members:
diff --git a/apidoc/_sources/arcgis.apps.rst.txt b/apidoc/_sources/arcgis.apps.rst.txt
@@ -0,0 +1,44 @@
+arcgis.apps module
+==================
+
+.. automodule:: arcgis.apps
+
+build_collector_url
+--------------
+.. autofunction:: arcgis.apps.build_collector_url
+
+build_explorer_url
+--------------
+.. autofunction:: arcgis.apps.build_explorer_url
+
+build_field_maps_url
+--------------
+.. autofunction:: arcgis.apps.build_field_maps_url
+
+build_navigator_url
+--------------
+.. autofunction:: arcgis.apps.build_navigator_url
+
+build_survey123_url
+--------------
+.. autofunction:: arcgis.apps.build_survey123_url
+
+build_tracker_url
+--------------
+.. autofunction:: arcgis.apps.build_tracker_url
+
+build_workforce_url
+--------------
+.. autofunction:: arcgis.apps.build_workforce_url
+
+Submodules
+----------
+.. toctree::
+   :maxdepth: 3
+
+   arcgis.apps.hub
+   arcgis.apps.dashboard
+   arcgis.apps.workforce
+   arcgis.apps.storymap
+   arcgis.apps.survey123
+   arcgis.apps.tracker
diff --git a/apidoc/_sources/arcgis.apps.storymap.rst.txt b/apidoc/_sources/arcgis.apps.storymap.rst.txt
@@ -0,0 +1,12 @@
+arcgis\.apps\.storymap module
+==============================
+
+.. automodule:: arcgis.apps.storymap
+
+JournalStoryMap
+----------------
+.. autoclass:: arcgis.apps.storymap.JournalStoryMap
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/apidoc/_sources/arcgis.apps.survey123.rst.txt b/apidoc/_sources/arcgis.apps.survey123.rst.txt
@@ -0,0 +1,19 @@
+arcgis\.apps\.survey123 module
+==============================
+
+.. automodule:: arcgis.apps.survey123
+
+SurveyManager
+----------------
+.. autoclass:: arcgis.apps.survey123.SurveyManager
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Survey
+----------------
+.. autoclass:: arcgis.apps.survey123.Survey
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/apidoc/_sources/arcgis.apps.tracker.rst.txt b/apidoc/_sources/arcgis.apps.tracker.rst.txt
@@ -0,0 +1,44 @@
+arcgis.apps.tracker module
+============================
+
+.. automodule:: arcgis.apps.tracker
+
+
+The :class:`~arcgis.apps.tracker.LocationTrackingManager` is the main entry point into the Tracker module.
+It can be used as shown in the following code example.
+
+
+.. code-block:: python
+
+    # Access the location tracking manager and check the status
+
+    import arcgis
+    gis = arcgis.gis.GIS("https://arcgis.com", "<username>", "<password>")
+    print(gis.admin.location_tracking.status)
+
+LocationTrackingManager
+-----------------------
+.. autoclass:: arcgis.apps.tracker.LocationTrackingManager
+    :members:
+    :undoc-members:
+    :inherited-members:
+
+TrackView
+--------------
+.. autoclass:: arcgis.apps.tracker.TrackView
+    :members:
+    :undoc-members:
+    :inherited-members:
+
+TrackViewerManager
+------------------
+.. autoclass:: arcgis.apps.tracker.TrackViewerManager
+    :members:
+    :undoc-members:
+    :inherited-members:
+
+MobileUserManager
+-----------------
+.. autoclass:: arcgis.apps.tracker.MobileUserManager
+    :members:
+    :inherited-members:
diff --git a/apidoc/_sources/arcgis.apps.workforce.managers.rst.txt b/apidoc/_sources/arcgis.apps.workforce.managers.rst.txt
@@ -0,0 +1,51 @@
+arcgis.apps.workforce.managers module
+=====================================
+
+.. automodule:: arcgis.apps.workforce.managers
+
+AssignmentManager
+-----------------
+.. autoclass:: arcgis.apps.workforce.managers.AssignmentManager
+    :members:
+    :undoc-members:
+
+AssignmentAttachmentManager
+---------------------------
+.. autoclass:: arcgis.apps.workforce.managers.AssignmentAttachmentManager
+    :members:
+    :undoc-members:
+
+AssignmentIntegrationManager
+----------------------------
+.. autoclass:: arcgis.apps.workforce.managers.AssignmentIntegrationManager
+    :members:
+    :undoc-members:
+
+AssignmentTypeManager
+---------------------
+.. autoclass:: arcgis.apps.workforce.managers.AssignmentTypeManager
+    :members:
+    :undoc-members:
+
+DispatcherManager
+-----------------
+.. autoclass:: arcgis.apps.workforce.managers.DispatcherManager
+    :members:
+    :undoc-members:
+
+TrackManager
+------------
+.. autoclass:: arcgis.apps.workforce.managers.TrackManager
+    :members:
+    :undoc-members:
+
+WorkerManager
+-------------
+.. autoclass:: arcgis.apps.workforce.managers.WorkerManager
+    :members:
+    :undoc-members:
+
+
+
+
+