Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


Note: Dear user the section "New Integration of Geowidget" shows the new way to integrate the Geowidget map, if you are looking for information about the previous possibilities to integrate Geowidget V4, go to the section "OLD version Integration of Geowidget"

New Integration of Geowidget


To use Geowidget v4, add the following lines to your page headers.


Code Block
script async src="https://geowidget.easypack24.net/js/sdk-for-javascript.js"></script>
<link rel="stylesheet" href="https://geowidget.easypack24.net/css/easypack.css"/>


To initialize the map using the defined contexts, specify values for instance, context, and token in the parameters. Point selection is implemented as an event callback to the mapWidget function (example below).



Code Block
<script type="text/javascript">           
    easyPack.init({
        instance: 'pl',
        context: "context name",
        token: "a token generated in the Parcel Locker Manager for API Points"
    });
    var map = easyPack.mapWidget('easypack-map', function(point) {
        console.log(point);
    });               
/script>
  
<div id="easypack-map"></div>



Parameter Description:


name
description
tokenParameter to which the PUBLIC token generated in parcel locker manager application should be provided (https://manager.paczkomaty.pl/  - tab MOJE KONTO > API > GEOWIDGET).
contextParameter specifying which functions/types the points displayed on the map should have (names of contexts and their description below in the table).
instanceInstance name parameter, for PL the value is 'pl'


Configuration options:


#
Description
Option
1Display pickup points for prepaid orderscontext: 'parcelCollect'
2Display collection points for cash on delivery orderscontext: 'parcelCollectPayment'
3Display of collection points for PWW orderscontext: 'parcelCollect247'
4Display of broadcast pointscontext: 'parcelSend'


Example: https://geowidget.easypack24.net/examples/multi-maps-contexts.html

...

OLD Version integration of Geowidget


Basic info

GEOv4 (also known as Geowidget v4) is a point locator and picker designed by Integer sp. z o.o. It's main goal is to show map of points with several types (for example machines), provide informations about this points and give possibility to integrate with clients external systems. GEOv4 is a widget-type software, it means that whole code and processing is held on Integer servers, external clients only attach link to this code and specify configuration that will be used on theirs systems.

...

Parameter nameDescriptionDefaults by instance
instance

Override default config by config prepared for instance.

Default: pl

Available: pl,uk,it


apiEndpoint

URL to API Points which will be connected to Geowidget

pl: https://api-pl-points.easypack24.net/v1
uk: https://api-uk-points.easypack24.net/v1
it: https://api-it-points.easypack24.net/v1
defaultLocale

Geowidget language that will be uses in front-end.

Available: pl,uk

pl: pl
uk: uk
locales

Languages that will be display as list in front layer. They can be dynamically changed.

pl: ['pl']
uk: ['uk'] 
mobileSize
Screen width below which mobile version is triggered.
768
langSelection
Determines if language selection bar should be displayed.
false
filters

Determines if filters (functions) bar should be displayed.

false
addressFormat

Visible format of address

'{street} {building_number} <br> {post_code} {city}'
listItemFormat
Visible format of address on list


Code Block
languagetext
collapsetrue
[
	"<b>{name}</b>",
	"{address_details.street} {address_details.building_number}"
]


display
Enable/disable visible type filters and search bar


Code Block
languagetext
collapsetrue
{
	showTypesFilters: true,
	showSearchBar: true,
}


mapType

Setup map type, available to use Open Street Map or Google Maps.

Available: osm, google

Info

For 'google' option map.googleKey is required.


'osm'
searchType

Setup search type, available to use Open Street Map Nominatim or Google Maps Autocomplete.

Available: osm, google

Info

For 'google' option map.googleKey is required.


'osm'
map
Setup map details.


Code Block
languagetext
collapsetrue
{
	googleKey: '', // required to use Google Maps API
	useGeolocation: true,
	initialZoom: 13,
	detailsMinZoom: 15, // minimum zoom after marker click
	autocompleteZoom: 14,
	visiblePointsMinZoom: 13,
	defaultLocation: [52.229807, 21.011595],
    initialTypes: ['pop', 'parcel_locker'], // which type should be selected by default. Options: parcel_locker_only, parcel_locker, pop
}


points

Setup points details

Available functions:

parcel - points with functions send and collect 
parcel_send - points with functions send only
parcel_collect - points with functions collect only


Code Block
languagetext
collapsetrue
{
	types: ['pop', 'parcel_locker'],  # Options: parcel_locker_only, parcel_locker, pop     
    allowedToolTips: ['pok', 'pop'],
    functions: []
}


customDetailsCallback

Allows to set custom callback for details action

Available: function(point){...}, false

false
customMapAndListInRow
Allow to change layout where list of point is below map. Points on list were paginated, number of point per page can be configured.


Code Block
languagetext
collapsetrue
{
	enabled: false,
	itemsPerPage: 8
}


listItemFormat
Allows to change default layout of point information on points list.


Code Block
languagetext
collapsetrue
[
	"<b>{name}</b>",
	"<strong>{address_details.street}</strong> {address_details.building_number}"
]


mobileFiltersAsCheckbox

Option set to false make filter option as radio in mobile, option true as checkobx.

true
paymentFilter

visible:false,

#zezwala na wyświetlenie filtra płatnosć w paczkomaciew Paczkomat®

defaultEnabled: false,

#włączony filtr dla płatności w paczkomacie w Paczkomat® już przy inicjalizacji

showOnlyWithPayment: false

#wymusza pokazywanie obiektów tylko z płatnością w paczkomaciew Paczkomat®

False

Getting selected point data

...

Example 4 - https://geowidget.easypack24.net/examples/modal.html - Open map as modal

Example 5 - https://geowidget.easypack24.net/examples/dropdown-widget.html - Open as dropdownExample 6 - https://geowidget.easypack24.net/examples/google.html - Enable Google Maps

Example 7 6 - https://geowidget.easypack24.net/examples/search-locker-point.html - Function searchLockerPoint()

Example 8 7 - https://geowidget.easypack24.net/examples/search-place.html - Function searchPlace()

Example 9 8 - https://geowidget.easypack24.net/examples/multi-maps.html - Open multi maps with different initial parameters

Example 10 9 - https://geowidget.easypack24.net/examples/payment-filter.html - Basic integration with payment filter

...