You are here

Home » API reference » IP Geolocation Views & Maps 8

ip_geoloc.schema.yml in IP Geolocation Views & Maps 8

config/schema/ip_geoloc.schema.yml

File

config/schema/ip_geoloc.schema.yml
View source 
  1. # Schema for the configuration files of IP Geolocation Views & Maps module.

  2. 

  3. ip_geoloc.settings:

  4.   type: mapping

  5.   label: 'IP Geolocation Views & Maps settings'

  6.   mapping:

  7.     ip_geoloc_marker_directory:

  8.       type: string

  9.       label: 'Path to set of marker images'

  10.     ip_geoloc_marker_dimensions:

  11.       type: string

  12.       label: 'Marker image width and height'

  13.     ip_geoloc_marker_anchor_pos:

  14.       type: string

  15.       label: 'Marker image anchor position'

  16.     ip_geoloc_num_location_marker_layers:

  17.       type: integer

  18.       label: 'Maximum number of marker layers you may need'

  19.     ip_geoloc_sync_batch_size:

  20.       type: integer

  21.       label: 'Default batch size'

  22.     ip_geoloc_google_to_reverse_geocode:

  23.       type: boolean

  24.       label: 'Employ the Google Maps API to reverse-geocode HTML5 visitor locations'

  25.     ip_geoloc_include_pages:

  26.       type: text

  27.       label: 'Pages on which the visitor HTML5 location may be sampled and reverse-geocoded'

  28.     ip_geoloc_exclude_pages:

  29.       type: text

  30.       label: 'Pages excluded from the set of pages specified above'

  31.     ip_geoloc_roles_to_reverse_geocode:

  32.       label: 'User roles for which the HTML5 location may be sampled and reverse-geocoded'

  33.       type: sequence

  34.       sequence:

  35.           - type: string

  36.             label: 'Role'

  37.     ip_geoloc_smart_ip_as_backup:

  38.       type: boolean

  39.       label: 'Employ Smart IP as a backup to the Google Maps'

  40.     ip_geoloc_location_check_interval:

  41.       type: integer

  42.       label: 'Minimum elapsed time before geolocation data for the same user'

  43.     ip_geoloc_page_refresh:

  44.       type: boolean

  45.       label: 'Auto-refresh the page as soon as an HTML5 location update has come in'

  46.     ip_geoloc_debug:

  47.       type: string

  48.       label: 'Detail execution progress with status messages'