Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Added doc for GeoViewController #535

Merged
merged 4 commits into from
Dec 6, 2023
Merged

Added doc for GeoViewController #535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f92894a
Added doc for GeoViewController
pMaske Dec 6, 2023
077f6f2
Addressed PR Feedback
pMaske Dec 6, 2023
92f7915
Fixed a typo
pMaske Dec 6, 2023
36927d5
Fixed grammatical errors
pMaske Dec 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ The ArcGIS Maps SDK for .NET Toolkit contains controls and components to acceler
| [Compass](docs/compass.md) | ![compass](https://user-images.githubusercontent.com/1378165/73389839-d9c8f500-4289-11ea-923c-18232489b3e0.png) | Show a compass direction when the map or scene is rotated. | WinUI, MAUI, UWP, WPF |
| [FeatureDataField](docs/feature-data-field.md) | ![FeatureDataField](https://user-images.githubusercontent.com/1378165/73389879-ebaa9800-4289-11ea-8e4e-de153a6a371a.png) | Display and optionally allow editing of a single field attribute of a feature. | UWP, WPF |
|[FloorFilter](docs/floor-filter.md) | ![image](https://user-images.githubusercontent.com/29742178/158746908-71a39e28-596f-44b6-9230-e2a04bdaeb9e.png) | Browse floor-aware maps and scenes and filter the view to show levels in a facility. | WinUI, MAUI, UWP, WPF |
|[GeoViewController](docs/geoviewcontroller.md) | | A helpfer class to enable easy adoption of MVVM patterns in an ArcGIS Maps SDK for .NET application. | WinUI, MAUI, UWP, WPF |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|[GeoViewController](docs/geoviewcontroller.md) | | A helpfer class to enable easy adoption of MVVM patterns in an ArcGIS Maps SDK for .NET application. | WinUI, MAUI, UWP, WPF |
|[GeoViewController](docs/geoviewcontroller.md) | | A helper class to enable easy adoption of MVVM patterns in an ArcGIS Maps SDK for .NET application. | WinUI, MAUI, UWP, WPF |

| [Legend](docs/legend.md) | <img src="https://user-images.githubusercontent.com/1378165/73389924-011fc200-428a-11ea-91bf-4ea1c2bf6683.png" width="105" title="Legend" />| Display a legend for a map or scene view. | WinUI, MAUI, UWP, WPF |
| [MeasureToolbar](docs/measure-toolbar.md) | ![MeasureToolbar](https://user-images.githubusercontent.com/1378165/73389958-0f6dde00-428a-11ea-8c78-7192d49ea605.png) | Measure distances, areas, and features in a map view. | UWP, WPF |
|[OverviewMap](docs/overview-map.md) | <img src="https://user-images.githubusercontent.com/29742178/121975740-34f07000-cd37-11eb-9162-462925cb3fe7.png" width="150" title="Overview Map" /> | Display an interactive inset map for a map or scene. | WinUI, MAUI, UWP, WPF |
Expand Down
5 changes: 5 additions & 0 deletions docs/controls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ Browse floor-aware maps and scenes and filter the view to show levels in a facil

![FloorFilter](https://user-images.githubusercontent.com/29742178/158746908-71a39e28-596f-44b6-9230-e2a04bdaeb9e.png)

### GeoViewController

A helper class for enabling easy adoption of MVVM patterns in ArcGIS Maps SDK for .NET applications.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think most people will know what MVVM means, but just to be safe (?).

Suggested change
A helper class for enabling easy adoption of MVVM patterns in ArcGIS Maps SDK for .NET applications.
A helper class for enabling easy adoption of [Model-View-ViewModel (MVVM)](https://learn.microsoft.com/en-us/dotnet/architecture/maui/mvvm) patterns in ArcGIS Maps SDK for .NET applications.


### Legend

Displays a legend for a map or scene view.
Expand Down Expand Up @@ -100,6 +104,7 @@ Use named trace configurations defined in a web map to perform connected trace o
|[Compass](compass.md) | ✔ | ✔ | ✔ |
|[FeatureDataField](feature-data-field.md) | ✔ | ✔ | ❌ |
|[FloorFilter](floor-filter.md) | ✔ | ✔ | ✔ |
|[GeoViewController](geoviewcontroller.md | ✔ | ✔ | ✔ |
|[Legend](legend.md) | ✔ | ✔ | ✔ |
|[MeasureToolbar](measure-toolbar.md) | ✔ | ✔ | ❌ |
|[OverviewMap](overview-map.md) | ✔ | ✔ | ✔ |
Expand Down
25 changes: 25 additions & 0 deletions docs/geoviewcontroller.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# GeoViewController

GeoViewController is a helper class for enabling easy adoption of MVVM patterns in ArcGIS Maps SDK for .NET applications.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
GeoViewController is a helper class for enabling easy adoption of MVVM patterns in ArcGIS Maps SDK for .NET applications.
GeoViewController is a helper class for enabling easy adoption of [Model-View-ViewModel (MVVM)](https://learn.microsoft.com/en-us/dotnet/architecture/maui/mvvm) patterns in ArcGIS Maps SDK for .NET applications.

The helper class allows you to perform view operations on the MapView from your ViewModel, through an attached proxy-object that ensures you keep ViewModel and View separated.

![geoviewcontroller](https://user-images.githubusercontent.com/1378165/73389839-d9c8f500-4289-11ea-923c-18232489b3e0.png)

## Features

- GeoViewController class can manage most common `GeoView` operations like setting viewpoint, performing identify and showing callouts. Any specific `MapView` or `SceneView` operations are not accessible via this helper class.
- The helper class is extensible. You can add your own custom map and scene operations, or interface for enabling testing (see WPF sample).
Comment on lines +10 to +11
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- GeoViewController class can manage most common `GeoView` operations like setting viewpoint, performing identify and showing callouts. Any specific `MapView` or `SceneView` operations are not accessible via this helper class.
- The helper class is extensible. You can add your own custom map and scene operations, or interface for enabling testing (see WPF sample).
- GeoViewController class can manage most common `GeoView` operations like setting a viewpoint, performing identify, and showing callouts. Any specific `MapView` or `SceneView` operations are not accessible via this helper class.
- The helper class is extensible. You can add your own custom map and scene operations or an interface to enable testing (see WPF sample).


## Usage

```xml
<esri:MapView x:Name="MyMapView"
Map="{Binding Map, Source={StaticResource VM}}"
esri:GeoViewController.GeoViewController="{Binding Controller, Source={StaticResource VM}}">
<Behaviors:Interaction.Triggers>
<Behaviors:EventTrigger EventName="GeoViewTapped" >
<Behaviors:InvokeCommandAction Command="{Binding GeoViewTappedCommand, Source={StaticResource VM}}" PassEventArgsToCommand="True" />
</Behaviors:EventTrigger>
</Behaviors:Interaction.Triggers>
</esri:MapView>
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the VM code be included?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking about it but then I thought it would be like pasting the entire sample code. I think users can refer to WPF sample, if needed.

Loading