Topics

All topics

Setup and maintenance

Geo location service

This article contains
NEW TO SITEFINITY?

Using the IGeoLocationService service, you can filter dynamic content items by their geographic location. The service shows where the items are located on a map.
Using this service, one could get all the locations within a circle, which is represented by point (latitude, longitude) and radius.

NOTE: The radius property is measured in kilometers.

The IGeoLocationService provides the following methods:

GetLocationsInCircle

Definition: GetLocationsInCircle(double latitude, double longitude, double radius, DistanceSorting sorting = DistanceSorting.Asc, ItemFilter itemFilter = null)
Gets the locations of dynamic items within a specified circle. The method returns an IGeoLocation interface, which has all the information that is needed to interact with the geo location.

Use the following code sample:

using System.Collections.Generic;
using System.Linq;
using Telerik.Sitefinity.GeoLocations;
using Telerik.Sitefinity.GeoLocations.Model;
using Telerik.Sitefinity.Services;
namespace Telerik.Sitefinity.Documentation.CodeSnippets.DevGuide.HowTo
{
public partial class GeoLocationsSnippets
{
public IEnumerable<IGeoLocation> GetPointsWithingRadius()
{
//Sofia coordinates
double latitude = 42.698081;
double longitude = 23.322601;
int radius = 100;
IGeoLocationService service = SystemManager.GetGeoLocationService();
return service.GetLocationsInCircle(latitude, longitude, radius, DistanceSorting.Asc,
new ItemFilter()
{
ProviderName = "OpenAccessProvider",
ContentType = "Telerik.Sitefinity.DynamicModule.Module1.Type1",
CustomKey = "Address"
}).ToList();
}
}
}
view raw GetLocationsInCircle.cs hosted with ❤ by GitHub

Definition: GetLocation (Guid itemId, string contentType, string customKey, string providerName)
Gets the geo location of the dynamic type if it has any, otherwise returns null. This method can be used when there is reference to the dynamic item. It returns an IGeoLocation item or null if there is no geo location for item with that id, contentType, customKey, and providerName. The custom key is a parameter, which is used to specify something unique for each item.

Use the following code sample:

using Telerik.Sitefinity.DynamicModules.Model;
using Telerik.Sitefinity.GeoLocations.Model;
using Telerik.Sitefinity.Services;
namespace Telerik.Sitefinity.Documentation.CodeSnippets.DevGuide.HowTo
{
public partial class GeoLocationsSnippets
{
public static IGeoLocation GetGeoLocation(DynamicContent newlyAddedItem)
{
IGeoLocation geoLocation = null;
var customKey = "AddressHybrid";
// assert no item with specified id, content type, key and provider exists
var geoLocationService = SystemManager.GetGeoLocationService();
geoLocation = geoLocationService.GetLocation(newlyAddedItem.Id, newlyAddedItem.GetType().FullName, customKey, newlyAddedItem.ProviderName);
return geoLocation;
}
}
}
view raw GetGeoLocation.cs hosted with ❤ by GitHub

GetItemLocations

Definition: UpdateLocation (Guid id, string contentType, string providerName, string customKey, Guid contentItemId, double latitude, double longitude)
Creates or updates an existing item depending on the parameter id. If you pass an empty GUID to this method, that means, that a new item will be created, but if you pass a non-empty GUID, the geo location that corresponds to that id will be updated in the database.

Use the following code sample:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Telerik.Sitefinity.Services;
namespace Telerik.Sitefinity.Documentation.CodeSnippets.DevGuide.HowTo
{
public partial class GeoLocationsSnippets
{
public static void UpdateLocation()
{
var id = "ED34F4B6-A553-4892-8931-95CFDE1C35DE";
var provider = "OpenAccessProvider";
var contentType = "SitefinityWebApp.CustomType";
var contentItemId = "98BFA605-8A30-47FB-8C05-235F4EB11427";
//Sofia coordinates
var latitude = 42.698081;
var longitude = 23.322601;
var customKey = "City";
var geoLocationService = SystemManager.GetGeoLocationService();
geoLocationService.UpdateLocation(Guid.Parse(id), contentType, provider, customKey, Guid.Parse(contentItemId), latitude, longitude);
}
}
}
view raw UpdateLocationSnippet.cs hosted with ❤ by GitHub

Filter dynamic content items

There are two ways to filter dynamic content items using the new Geo Location Service. The first one is to filter your dynamic module items, which have an Address field with enabled map and the second one is to filter by geo location points for your custom build types.

In the example below, we have a module with two dynamic content types. The first one represents restaurant objects and the second one – cinemas. First you need to publish the items in the system. This can be done either from the back-end interface or programmatically using the code reference for these types. Then you can use the IGeoLocationManager class to filter the items by distance from a specific point (using the FilterByGeoLocation method) and to sort them by distance (using the SortByDistance method).

Use the following code sample:

using System.Collections.Generic;
using System.Linq;
using Telerik.Sitefinity.DynamicModules;
using Telerik.Sitefinity.DynamicModules.Model;
using Telerik.Sitefinity.GeoLocations;
using Telerik.Sitefinity.GeoLocations.Model;
using Telerik.Sitefinity.Utilities.TypeConverters;
namespace Telerik.Sitefinity.Documentation.CodeSnippets.DevGuide.HowTo
{
public partial class GeoLocationsSnippets
{
private static void FiterItemsByGeoLocation()
{
string provider = "OpenAccessProvider";
double latitude = 42.698081;
double longitude = 23.322601;
int radius = 100;
// Items should be created either through the backend either using the code reference of these types
string restaurantsContentType = "Telerik.Sitefinity.DynamicTypes.Model.Locations.Restaurants";
string addressPropertyName = "Address";
// get all restaurants in a circle with radius 100 of a point (42.698081,23.322601)
var restaurants = GetItemsInACircle(provider, restaurantsContentType, addressPropertyName, longitude, latitude, radius);
string cinemasContentType = "Telerik.Sitefinity.DynamicTypes.Model.Locations.Cinemas";
string cinemaAddressPropertyName = "Address";
// get all cinemas in a circle with radius 100 of a point (42.698081,23.322601)
var cinemas = GetItemsInACircle(provider, cinemasContentType, cinemaAddressPropertyName, longitude, latitude, radius);
}
private static IEnumerable<DynamicContent> GetItemsInACircle(string provider, string contentType, string propertyName, double longitude, double latitude, int radius)
{
DynamicModuleManager manager = DynamicModuleManager.GetManager(provider);
var type = TypeResolutionService.ResolveType(contentType);
var items = manager.GetDataItems(type);
// item filter
var itemFilter = new ItemFilter() { ProviderName = provider, ContentType = contentType, CustomKey = propertyName };
IEnumerable<IGeoLocation> geoLocationsList;
// get all geo location points in the specified radius of the point with the specifed longitude and lattitude
var itemsList = ((IGeoLocationManager)manager).FilterByGeoLocation<DynamicContent>(items, latitude, longitude, radius, out geoLocationsList, itemFilter).ToList();
// sort by distance and populate the distance property
return ((IGeoLocationManager)manager).SortByDistance<DynamicContent>(itemsList, geoLocationsList, latitude, longitude, DistanceSorting.Asc).ToList();
}
}
}
view raw FilterItemsByGeoLocation.cs hosted with ❤ by GitHub

If a dynamic content type has more than one Address fields, filtering by a particular Address field can be done by specifying its field name as a propertyName when building the item filter.

NOTE: Filtering dynamic content items does not require registering geo location points (in the Geo Location Service), as this comes out-of-the-box.

If the CustomKey is not specified, then the items will be filtered by either of the fields.

Filter items from custom types

The second option is to use the Geo Location Service directly to register your geo location points for your custom types. After you have registered the points, you can filter and sort your items by different criteria including: the type of the items, their provider and the key (name) of the field containing the geo location data.

Use the following code sample:

using System;
using Telerik.Sitefinity.GeoLocations;
using Telerik.Sitefinity.Services;
namespace Telerik.Sitefinity.Documentation.CodeSnippets.DevGuide.HowTo
{
public partial class GeoLocationsSnippets
{
private void FilterGeoLocationPoints(double latitude, double longitude, int radius)
{
var geoLocationService = SystemManager.GetGeoLocationService();
var item1Id = Guid.NewGuid();
var item1Longitude = 23.115578;
var item1Latitude = 42.261557;
//add item of custom type 1 to geo location service
geoLocationService.UpdateLocation(Guid.Empty, "MyCustomType1", "MyProvider1", "Address1", item1Id, item1Latitude, item1Longitude);
var item2Id = Guid.NewGuid();
var item2Longitude = 23.091202;
var item2Latitude = 42.012060;
//add item of custom type 2 to geo location service
geoLocationService.UpdateLocation(Guid.Empty, "MyCustomType", "MyProvider2", "Address2", item2Id, item2Latitude, item2Longitude);
//get all items in a circle no matter of their type, key and provider
var geoLocationItems = geoLocationService.GetLocationsInCircle(latitude, longitude, radius, DistanceSorting.Asc, null);
}
}
}
view raw FilterGeoLocationPoints.cs hosted with ❤ by GitHub

Want to learn more?

Increase your Sitefinity skills by signing up for our free trainings. Get Sitefinity-certified at Progress Education Community to boost your credentials.

Get started with Integration Hub | Sitefinity Cloud | Sitefinity SaaS

This free lesson teaches administrators, marketers, and other business professionals how to use the Integration hub service to create automated workflows between Sitefinity and other business systems.

Web Security for Sitefinity Administrators

This free lesson teaches administrators the basics about protecting yor Sitefinity instance and its sites from external threats. Configure HTTPS, SSL, allow lists for trusted sites, and cookie security, among others.

Foundations of Sitefinity ASP.NET Core Development

The free on-demand video course teaches developers how to use Sitefinity .NET Core and leverage its decoupled architecture and new way of coding against the platform.

Was this article helpful?