Loading...

Maps

Properties API Related

Widget Type:
Page Widgets
TPC Version:
  • 4.1 +
VideoLogos

The new TPC Map widget allow you to display your CRM data on a map based on the coordinates or the address. This widget straight forward to configure. Before you start configuring the widget you will need entities containing an address and numeric values. Typically, a CRM Entitles containing Linked-Entities. 


Configuration

Basic Settings

Drag and drop the Map widget to your page, and click on the edit button and the widget designer will open.

From the Appearance tab, you can set the center point of the map by address or the coordinates. Based on your selections provide the details for the latitude and longitude or for the address.  You can hide or display the navigation control and zoom control by selecting the options in the dropdown boxes and set your map height and the set the map zooming scale. 

maps-1

Pins 

You can select a map marker icon from the Sitefinity image library or you can select the Entity default image and set a fall-back image for the entity.

maps-2

Data & Fields Mapping

The data tab is use for defining the FetchXML, which will define what sort of records you want to show on your map. You have the option of working with the primary entity or any other entity that the one has a relationship with, and you have two options; build your fetch XML or to load the default Fetch related to the entity. In this instance, based on the fields that you need on “fields mapping” tab, build your fetch XML.

Load Default: Will load the default FetchXML that set to the selected CRM entity.

Build: Will let you build the FetchXML, and you will be able to select what fields that you want to display, filter the data, group the data.  

You can select the options on the field that you want to display on the map. These field options on the fields Mapping tab will be populated based on your FetchXML you build on the data tab.  All the data you setting on the field mapping tab will use towards setting the pin on the map.  

maps-3

Filters

The Filters tab contains a myriad of options to filter the records that the widget fetches. For example, you can filter records by the logged-in contacts' ID or by a query string value.

maps-4

Widget Properties

Basic Properties

Center By Address

Type address by any format you wish, in the background map widget would use google API to select best matching location. So type a full address or just name of the city.

Center Longitude & Latitude

If Center By Address is null, this property is used instead.
Allows to choose to center by direct coordinates.

Height

The Height property determines the height of the widget element in pixels.

Zoom Control

Completely optional tool to adjust zoom by clicking on +/- buttons. If not null, Position Sub Property drop down will be available. Type: Boolean

Zoom

You got 20 map zoom levels.

Entity

Drop Down: Optional, select entity to use the Load Default FetchXML. Required in Advanced Pin Map: Used to dynamically populate image selectors list to differentiate markers by status.

Fetch XML

The FetchXML text area determines what sort of data a widget will be populated with. 

Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen. By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function.

Name Attribute

CRM field to be attached to each marker as a tooltip.

Use Composite Address

Used when you have address fields concatenated in one line in CRM. Using this option activates Geocoder. (that uses external APIS to pull coordinates)

Use Coordinates Option

Used when coordinates are registered in the CRM entity. Sub Properties: Latitude and Longitude Dropdowns: to specify the coordinates fields.

Use Address

Used when detailed address is registered in CRM on each entity. If true, the following sub properties will be available in drop down boxes. Street Line 1, Street Line 2, City Attribute, Province Attribute, Country Attribute, Postal Attribute. Using this option activates Geocoder. (that uses external APIS to pull coordinates).

Marker Type

A string property that hold image url.

 

Hidden

The Hidden checkbox will hide the widget from the page when checked.

EnableBootstrapStyles

The EnableBootstrapStyles property gives the user the ability to enable or disable the Boostrap style  that added in to the current form. By default, this property is set to True. 

EnableKendoRtlSupport

The EnableKendoRtlSupport property gives the user the ability to enable or disable the Right to Left Support on the current form. By default, this property is set to False.

More Information about Kendo right to left support can be found in

 http://docs.telerik.com/kendo-ui/accessibility/supporting-rtl-languages

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Center By Address

Type address by any format you wish, in the background map widget would use google API to select best matching location. So type a full address or just name of the city.

Center Longitude & Latitude

If Center By Address is null, this property is used instead.
Allows to choose to center by direct coordinates.

Height

The Height property determines the height of the widget element in pixels.

Zoom Control

Completely optional tool to adjust zoom by clicking on +/- buttons. If not null, Position Sub Property drop down will be available. Type: Boolean

Zoom

You got 20 map zoom levels.

Entity

Drop Down: Optional, select entity to use the Load Default FetchXML. Required in Advanced Pin Map: Used to dynamically populate image selectors list to differentiate markers by status.

Fetch XML

The FetchXML text area determines what sort of data a widget will be populated with. 

Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen. By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function.

Name Attribute

CRM field to be attached to each marker as a tooltip.

Use Composite Address

Used when you have address fields concatenated in one line in CRM. Using this option activates Geocoder. (that uses external APIS to pull coordinates)

Use Coordinates Option

Used when coordinates are registered in the CRM entity. Sub Properties: Latitude and Longitude Dropdowns: to specify the coordinates fields.

Use Address

Used when detailed address is registered in CRM on each entity. If true, the following sub properties will be available in drop down boxes. Street Line 1, Street Line 2, City Attribute, Province Attribute, Country Attribute, Postal Attribute. Using this option activates Geocoder. (that uses external APIS to pull coordinates).

Marker Type

A string property that hold image url.

 

Hidden

The Hidden checkbox will hide the widget from the page when checked.

EnableBootstrapStyles

The EnableBootstrapStyles property gives the user the ability to enable or disable the Boostrap style  that added in to the current form. By default, this property is set to True. 

EnableKendoRtlSupport

The EnableKendoRtlSupport property gives the user the ability to enable or disable the Right to Left Support on the current form. By default, this property is set to False.

More Information about Kendo right to left support can be found in

 http://docs.telerik.com/kendo-ui/accessibility/supporting-rtl-languages

API

get_mapView()

Returns the map view object associated with the widget.

Returns

jQuery Object

get_type()

Returns the widget type.

Returns

String

get_container()

Returns the container element of the widget.     

Returns

None

get_element()

Returns the element of the widget.

Returns

jQuery Object

hide()

Hides the widget from the page.

Returns

None

show()

Shows the widget on the page.

Returns

None

toggle()

Toggles the visibility of the widget.

Returns

None

get_model()

Returns the model object of the widget, which contains several useful properties related to the widget.

Returns

None

Full API With Examples

Examples of Maps Configuration