Version:

Namespace: cercaliax

cercaliax


Type Definitions

cercaliax.AjaxParams{Object}

Properties:
Name Type Argument Description
url string

URL. If not defined, default value is value of cercalia.servers.servlet constant. Required.
method string | undefined <optional>

HTTP method. Default GET.
headers Object | undefined <optional>

HTTP Headers for Ajax request.
postContent Object | string | undefined <optional>

Post data
timeout number | undefined <optional>

Ajax timeout request.
callbackFn function | undefined <optional>

Callback function. First param is JSON data.
callbackFnError function | undefined <optional>

Callback error function

cercaliax.AuthResult{Object}

Properties:
Name Type Description
cercalia cercaliax.AuthResultData

Required.

cercaliax.AuthResultData{Object}

Properties:
Name Type Description
cmd string

Required.
auth cercaliax.ObjectJSON | undefined
error cercaliax.ObjectJSON | undefined

cercaliax.BaseLayerOptions{Object}

Properties:
Name Type Argument Description
name string

Required.
label string

Required.
layer ol.layer.Layer

Required.
projectionCode string

Required.
logo string | undefined <optional>

HTML Content logo

cercaliax.ContextMenuOptions{Object}

Properties:
Name Type Argument Description
id string | undefined <optional>

Contex menu identifier. If it isn't defined, will be defined in class.
map cercalia.Map | undefined <optional>

Map where appears the contex menu. If it isn't defined, will be defined with 'setMap' method.
fixedPosition cercalia.LonLat | undefined <optional>

If this argument is defined, context menu always will be shown in this position.

cercaliax.Coord{Object}

Properties:
Name Type Description
x string

X Coordinate Required.
y string

X Coordinate Required.

cercaliax.FeatureOptions{Object}

Properties:
Name Type Argument Description
draggable boolean | undefined <optional>

Boolean indicating if dragging is being enabled or not.
editable boolean | undefined <optional>

Boolean indicating if editing is being enabled or not.
fillColor string | undefined <optional>

Feature fill color. Default value #009BFF.
fillOpacity number | undefined <optional>

Feature fill opacity. Default value 0.9.
geometry ol.geom.Geometry | undefined <optional>

OpenLayers3 geometry ol.Geometry that indicates the feature to be painted.
id string | undefined <optional>

Marker ID. If not specified, it's automatically generated.
iconArrow string | undefined <optional>

Icon URL. If not specified, API uses the default cercalia icon. If uses a custom icon, the arrow should be pointing upwards
lineDash Array.<number> | undefined <optional>

Line dash. Array of two values, continuous-discontinuous. For example [40, 20], [10, 10], [10, 20, 40, 60].
onClick function | undefined <optional>

Function to execute on feature click.
onDoubleClick function | undefined <optional>

Function to execute on feature double click.
onDragEnd function | undefined <optional>

Function to execute when ends feature dragging.
onDragMove function | undefined <optional>

Function to execute during feature dragging.
onDragStart function | undefined <optional>

Function to execute on feature dragging start.
onDrop function | undefined <optional>

Function to execute on feature drop. Returns the position of dragged features list
onMouseOut function | undefined <optional>

Function to execute on Mouse Out.
onMouseOver function | undefined <optional>

Function to execute on Mouse Over.
onModifyStart function | undefined <optional>

Function to execute on modify start. When feature is editable. Parameters are: 1-> cercalia.Feature, 2-> ol.interaction.Modify.Event
onModifyEnd function | undefined <optional>

Function to execute on modify end. When feature is editable. Parameters are: 1-> cercalia.Feature, 2-> ol.interaction.Modify.Event
onRightClick function | undefined <optional>

Function to execute on feature right click.
outline boolean | undefined <optional>

Enable outline feature property. If no outline required, specify null. Default value true.
outlineColor string | undefined <optional>

Feature outline color. Default value #00ff00
outlineOpacity number | undefined <optional>

Feature outline opacity. Default value 1.
outlineWidth number | undefined <optional>

Feature outline width. Default value 7.
radius number | undefined <optional>

Point radius.
simpleLabel cercalia.SimpleLabel | null

SimpleLabel feature. Required.
showDirection string | undefined <optional>

Show direction (arrows)
srs string | undefined <optional>

Projection. Default value: ESPG:4326.
strokeOpacity number | undefined <optional>

Feature stroke opacity. Default value 0.7.
strokeColor string | undefined <optional>

Feature stroke color. Default value #ffffff.
strokeWidth number | undefined <optional>

Feature stroke width. Default value 5.
wkt string | undefined <optional>

WKT String with shape geometry to be painted.
kml string | undefined <optional>

KML string to be painted.
zIndex number | undefined <optional>

zIndex.

cercaliax.GeEntity{Object}

Properties:
Name Type Argument Description
article string | null | undefined <optional>
city cercaliax.ObjectJSON | null | undefined <optional>
coord cercaliax.Coord | null | undefined <optional>
country cercaliax.ObjectJSON | null | undefined <optional>
dist string | null | undefined <optional>
frc string | null | undefined <optional>
housenumber cercaliax.ObjectJSON | null | undefined <optional>
id string | null | undefined <optional>
intersection cercaliax.ObjectJSON | null | undefined <optional>
kmh string | null | undefined <optional>
label string | null | undefined <optional>
municipality cercaliax.ObjectJSON | null | undefined <optional>
name cercaliax.ObjectJSON | null | undefined <optional>
pos string | null | undefined <optional>
postalcode cercaliax.ObjectJSON | null | undefined <optional>
prefix string | null | undefined <optional>
region cercaliax.ObjectJSON | null | undefined <optional>
sname string | null | undefined <optional>
subcategory_id cercaliax.ObjectJSON | null | undefined <optional>
subregion cercaliax.ObjectJSON | null | undefined <optional>
zonename string | null | undefined <optional>
zonetype string | null | undefined <optional>

cercaliax.GeListEntity{Object}

Properties:
Name Type Description
ge Array.<cercaliax.GeEntity> | null

Required.

cercaliax.GeocodingResult{Object}

Properties:
Name Type Description
cercalia cercaliax.GeocodingResultData

Required.

cercaliax.GeocodingResultData{Object}

Properties:
Name Type Description
candidates cercaliax.GeocodingResultData.candidates | undefined
cmd string

Required.
server cercaliax.ObjectJSON | undefined
error cercaliax.ObjectJSON | undefined

cercaliax.GeometryEntityResult{Object}

Properties:
Name Type Description
cercalia cercaliax.GeometryEntityResultData

Required.

cercaliax.GeometryEntityResultData{Object}

Properties:
Name Type Description
cmd string

Required.
ge cercaliax.GeometryEntityResult.GeEntity | undefined
server cercaliax.ObjectJSON | undefined
error cercaliax.ObjectJSON | undefined
version string | undefined

cercaliax.HeatmapOptions{Object}

Properties:
Name Type Description
format string | undefined

File format. Accepts 'kml' or 'geojson'. Default: 'kml'.
map cercalia.Map

Map where markers will be painted. Required.
name string | undefined

Layer name.
url string

The url of the file. Required.
projection string

Projection code. Default: 'EPSG:900913' Required.
radius number | undefined

Radius of an entity. Default: 5.
gradient Array.<string> | undefined

The color gradient of the heatmap, specified as an array of CSS color strings. Default is ['#00f', '#0ff', '#0f0', '#ff0', '#f00'].
opacity number | undefined

Opacity. 0-1. Default is 1.
blur number | undefined

Blur size in pixels. Default is 15.
saturation number | undefined

Saturation

cercaliax.IconOptions{Object}

Properties:
Name Type Argument Description
src string | undefined <optional>

Image path URL. Default cercalia icon: marker.png
size Array.<number> | undefined <optional>

Icon dimensions. Default value: [23, 33].
scale number | undefined <optional>

Icon image resizing factor. Default value 1.
opacity number | undefined <optional>

Icon opacity. Default value 1.
rotation number | undefined <optional>

Icon rotation. Default value 0.
rotateWithView boolean | undefined <optional>

Whether to rotate the icon with the view. Default false.
anchor Array.<number> | undefined <optional>

Anchor. Default value [0.5, 0.5]. (fraction)
anchorUnits ol.style.IconAnchorUnits | undefined <optional>

Units in which the anchor value is specified. A value of 'fraction' indicates the x value is a fraction of the icon. A value of 'pixels' indicates the x value in pixels. Default is 'fraction'.
svg string | undefined <optional>

SVG string to create a icon. Example:
<svg width="120" height="120" version="1.1" xmlns="http://www.w3.org/2000/svg">
<circle cx="20" cy="20" r="20"/>
</svg>

cercaliax.InfoMapOptions{Object}

Properties:
Name Type Description
title string

Title. Required.
content string

Content. Required.
position cercalia.LonLat

Position. Required.

cercaliax.IsochronesResult{Object}

Properties:
Name Type Description
cercalia cercaliax.IsochronesResultData

Required.

cercaliax.IsochronesResultData{Object}

Properties:
Name Type Description
cmd string

Required.
isochrones cercaliax.IsochronesResultData.Isochrones | undefined
server cercaliax.ObjectJSON

Required.
version string | undefined
error cercaliax.ObjectJSON | undefined

cercaliax.KMLOptions{Object}

Properties:
Name Type Argument Description
name string | undefined <optional>

Name
map cercalia.Map

Cercalia Map Required.
minResolution number | undefined <optional>

The minimum resolution (inclusive) at which this layer will be visible.
maxResolution number | undefined <optional>

MaxResolution The maximum resolution (exclusive) below which this layer will be visible.
opacity number | undefined <optional>

Opacity. 0-1. Default is 1
projection string | undefined <optional>

Projection. Default is EPSG:3857
draggable string | undefined <optional>

Draggable. Default is false
url string | undefined <optional>

Url of resource
onLoadUrl function | undefined <optional>

Callback function when URL and features are loaded.
visible string | undefined <optional>

Visible. Default is false

cercaliax.LabelOptions{Object}

Properties:
Name Type Argument Description
color string | undefined <optional>

Label color. Default value '#000000'
background string | undefined <optional>

Label backgroud. The string format is the same than css tag. Default value 'none repeat scroll 0% 0% #ffffff'
fontWeight boolean | undefined <optional>

Bold text. Default: false
lightLabel boolean | undefined <optional>

In case of paint a high number of labels, you can create Labels with a simpler DOM. Default value: false.
offset number | undefined <optional>

Label offset, in pixels, from the bottom position of icon. Default value for default label is [-3, -18].
show boolean | undefined <optional>

Show text. Default value 1
text string

Simple Label text (with no background). Required.
iconWidth number | undefined <optional>

Width of image. Default value 15.
iconHeight number | undefined <optional>

Height of image. Default value 15.
icon string

Image src. Required.

cercaliax.LayerAndServers{Object}

cercaliax.LinestringOptions{Object}

Properties:
Name Type Description
draggable boolean | undefined

Boolean indicating if dragging is being enabled.
path

LineString coordinates. Required.
strokeColor string

Line color. Default '#00ff00'. Required.
strokeOpacity number

Line opacity. Value between 0 and 1. Default value 0.75. Required.
strokeWidth number | undefined

Line width. Default value 5.
zIndex number | undefined

Z-Index. Default value 100.

cercaliax.LogisticsParams{Object}

Properties:
Name Type Argument Description
vaxleweight number | undefined <optional>

Maximum axle weight.
vheight number | undefined <optional>

Maximum height.
vlength number | undefined <optional>

Maximum length.
vwidth number | undefined <optional>

Maximum width.
vmaxvel number | undefined <optional>

Maximum speed.
rimp boolean | undefined <optional>

Dangerous goods.
trinfodate string | undefined <optional>

YYYYMMDD
trinfodays number | undefined <optional>

Number days to consecutives to show restrictions.
trstart number | undefined <optional>

Avoid route restrictions. In timestamp format.

cercaliax.LongTouchInteractionOptions{Object}

Properties:
Name Type Description
handleLongTouchEvent function

Delay. Default 1000 ms. Required.
delay number | undefined

Delay. Default 1000 ms.

cercaliax.MapOptions{Object}

Properties:
Name Type Argument Description
altRotation boolean | undefined <optional>

Enable or disable the ALT (keyboard) rotation map.
bounds cercalia.Bounds | undefined <optional>

Initial map bounding box. Default: null.
center cercalia.LonLat | undefined <optional>

Center map coordinates. Default values x=-2.530985346701069, y=40.14298996438731
controls Array.<string> | undefined <optional>

Map controls to include. Values:

  • cercalia.control.MapControls.SCALELINE
  • cercalia.control.MapControls.CLEAN
  • cercalia.control.MapControls.GAS_STATIONS
  • cercalia.control.MapControls.LAYER_SWITCHER
  • cercalia.control.MapControls.METEO
  • cercalia.control.MapControls.NAVBAR
  • cercalia.control.MapControls.MOBILEBAR
  • cercalia.control.MapControls.TRAFFIC
  • cercalia.control.MapControls.ZOOM
  • cercalia.control.MapControls.LOGISTICS_RESTRICTIONS
  • cercalia.control.MapControls.ISOCHRONES
  • cercalia.control.MapControls.STREET_VIEW

    If you want a map without controls put value [].
centerOnGeolocation boolean | undefined <optional>

Use the user location to center the map. Default: false.
defaultClick function | undefined <optional>

Assign function to click on map. Function parameters: (1->pixel, 2->cercalia.LonLat).
1) Pixel where clicked with mouse right click.
2) Map coordinate.

disableMouseOverEvents boolean | undefined <optional>

Disables mouse over events. Recommended for better performance when there are a lot of markers drawn in map. And if marker/feature mouseOver/mouseOut events aren't needed.
geolocationEnabled boolean | undefined <optional>

Enable automatically geolocation. Your position will be drawn to map.
greyscale boolean | undefined <optional>

Base layer colors in greyscale. Default false.

cercaliax.MarkerOptions{Object}

Properties:
Name Type Argument Description
draggable boolean | undefined <optional>

Boolean indicating if dragging is enabled or not.
icon cercalia.Icon | undefined <optional>

cercalia.Icon object, if not specified use the default value.
id string | undefined <optional>

Marker Id. If not specified, generates a automatic value.
label cercalia.Label | undefined <optional>

Label content.
onClick function | undefined <optional>

Function to execute on marker click.
onDoubleClick function | undefined <optional>

Function to execute on marker double click.
onDragEnd function | undefined <optional>

Function to execute when ends marker dragging.
onDragMove function | undefined <optional>

Function to execute during marker dragging.
onDragStart function | undefined <optional>

Function to execute on marker dragging start.
onDrop function | undefined <optional>

Function to execute on marker drop. Returns the position of dragged markers list
onMouseOut function | undefined <optional>

Function to execute on Mouse Out.
onMouseOver function | undefined <optional>

Function to execute on Mouse Over.
onRightClick function | undefined <optional>

Function to execute on marker right click.
popup cercalia.Popup | undefined <optional>

Marker popup.
position cercalia.LonLat

Position. Required.
simpleLabel cercalia.SimpleLabel | undefined <optional>

Marker Simple Label object.
zIndex number

Z-Index marker. Default value 200. Required.

cercaliax.MoEntity{Object}

Properties:
Name Type Description
coord cercaliax.Coord

Required.
id string | null

Required.

cercaliax.ObjectJSON{Object}

Properties:
Name Type Description
id string | undefined | null

Id.
value string | undefined | null

Value.

cercaliax.ParamEntity{Object}

Properties:
Name Type Description
name string | undefined
value string | undefined

cercaliax.PoiEntity{Object}

Properties:
Name Type Description
category_id string | null | undefined
dist string | null | undefined

cercaliax.PoiListEntity{Object}

Properties:
Name Type Description
num string | null | undefined
poi Array.<cercaliax.PoiEntity> | null | undefined

cercaliax.PoisResult{Object}

Properties:
Name Type Description
cercalia cercaliax.PoisResultData

Required.

cercaliax.PoisResultData{Object}

Properties:
Name Type Description
cmd string

Required.
map cercaliax.PoisResultData.map

Required.
proximity cercaliax.PoisResultData.proximity

Required.
server cercaliax.ObjectJSON | undefined
version string | undefined
error cercaliax.ObjectJSON | undefined

cercaliax.PopupOptions{Object}

Properties:
Name Type Argument Description
closeOnClick boolean | undefined <optional>

Close popup when click on it. Default value false.
customClass boolean | undefined <optional>

Custom CSS class to override popup styles.
content string

HTML Popup content Required.
offset

Offset. Default [0, 0]. Required.
minWidth number | undefined <optional>

Popup minimum width, in pixels. Default value 240px
maxWidth number | undefined <optional>

Popup maximum width, in pixels. Default value 400px
stopEvent boolean | undefined <optional>

If true it disable propagation events. So events inside popup won't be fired. Default true.
title string | undefined <optional>

Popup title. Default value: 'Info'
visible boolean | undefined <optional>

Boolean indicating if Popup is initially visible. Default value: false
zIndex number | undefined <optional>

zIndex popup value (css) . Default 1000
fadeAnimation boolean | undefined <optional>

Indicates whether to apply 'fadeIn' and 'fadeOut' animation effect

cercaliax.Postalcode{Object}

Properties:
Name Type Description
id string | undefined | null

Postal code.
country_id string | undefined | null

Country Id

cercaliax.ProximityResult{Object}

Properties:
Name Type Description
cercalia cercaliax.ProximityResultData

Required.

cercaliax.ProximityResultData{Object}

Properties:
Name Type Description
cmd string

Required.
proximity cercaliax.ProximityResultDataProximity

Required.
server cercaliax.ObjectJSON

Required.
error cercaliax.ObjectJSON | undefined

cercaliax.ProximityResultDataProximity{Object}

Properties:
Name Type Description
center string | null | undefined
num string | null | undefined
gelist cercaliax.GeListEntity | null | undefined
poilist cercaliax.PoiListEntity | undefined
rad string | null | undefined
type string | null | undefined

cercaliax.ProximityResultDataProximityPoiList{Object}

Properties:
Name Type Description
num string | undefined
poi Array.<cercaliax.ProximityResultDataProximityPoiList.poi> | undefined

cercaliax.RoutingResult{Object}

Properties:
Name Type Description
cercalia cercaliax.RoutingResultData | undefined

cercaliax.RoutingResultData{Object}

Properties:
Name Type Description
cmd string

Required.
geometry cercaliax.RoutingResultData.Geometry | undefined
route cercaliax.RoutingResult.Route

Required.
server cercaliax.ObjectJSON

Required.
version string | undefined
error cercaliax.ObjectJSON | undefined

cercaliax.RoutingStep{Object}

Properties:
Name Type Description
stepType string

Step Type Required.
position cercalia.LonLat

Position Required.
formattedAddress string | undefined

Formatted Address
showLabel boolean | undefined

Show Label

cercaliax.SimpleLabelOptions{Object}

Properties:
Name Type Argument Description
color string | undefined <optional>

Text color.
fontBold boolean | undefined <optional>

Bold text. Default: true.
fontFamily string | undefined <optional>

Text font.
fontSize number | undefined <optional>

Text size, in pixels. Default 13.
divided boolean | undefined <optional>

String separating with breaking line. Default true.
offset Array.<number> | undefined <optional>

Simpel Label offset, in pixels. Default value: [0, 0].
overflow boolean | undefined <optional>

For polygon labels allow text to exceed the width of the polygon at the label positoin. Default false.
strokeColor string | undefined <optional>

Stroke color.
strokeWidth number | undefined <optional>

Stroke width.
rotation number | undefined <optional>

Text rotation.
text string

Simple Label text (with no background). Required.
textAlign string | undefined <optional>

Text alignment. Possible values: left, right, center, end or start. Default is left.
visible boolean | undefined <optional>

Text visibility. Default value true.

cercaliax.SolrItem{Object}

cercaliax.StaticMapAJAXParameters{Object}

Properties:
Name Type Description
center string

Center Required.
scale number | undefined

Scale
extent string | undefined

Extent
width number

Width Required.
height number

Height Required.
featurelist Array.<cercaliax.StaticMapFeature> | undefined

List features in StaticMapFeature format.

cercaliax.StaticMapFeature{Object}

Properties:
Name Type Description
wkt string

WKT Required.
style cercaliax.StaticMapFeatureStyle

Feature style for static maps Required.

cercaliax.StaticMapFeatureStyle{Object}

Properties:
Name Type Description
fillColor string | undefined

Fill color
fillOpacity number | undefined

Fill opacity
pointRadius string | undefined

Point radius
strokeColor string | undefined

Stroke color
strokeDashstyle string | undefined

Stroke dash style
strokeLinecap string | undefined

Stroke linecap
strokeOpacity string | undefined

Stroke opacity
strokeWidth string | undefined

Stroke width
externalGraphic string | undefined

External graphic

cercaliax.StaticMapParameters{Object}

Properties:
Name Type Argument Description
width number | undefined <optional>

Width image
height number | undefined <optional>

Height image
center number | undefined <optional>

Center. Ignored if bounds is provided
bounds number | undefined <optional>

Map bounds
zoom number | undefined <optional>

Zoom. Ignored if bounds is provided

cercaliax.StopEntity{Object}

Properties:
Name Type Description
id string

Required.
ge cercaliax.GeEntity

Required.
mo cercaliax.MoEntity

Required.
desc cercaliax.ObjectJSON

Required.

cercaliax.StorageLogisticsOptions{Object}

Properties:
Name Type Description
vaxleweight number | undefined

Maximum axle weight.
vheight number | undefined

Maximum height.
vlength number | undefined

Maximum length.
vwidth number | undefined

Maximum width.
vmaxvel number | undefined

Maximum speed.
rimp boolean | undefined

Dangerous goods.
trstart number | string | undefined

Avoid route restrictions. In timestamp format.
addedCosts boolean | undefined

Added costs
vehicleConsumption number | undefined

Vehicle consumption
gasolineSelected string | undefined

Gasoline selected
gasolinePrice number | undefined

Gasoline price
carTypeSelected string

Car type selected Required.
departuretime string | undefined

Departure time
breaktime boolean

Break time Required.
twodrivers boolean

Break time Required.
reorder boolean

Reorder Required.
weight string

Weight Required.

cercaliax.Suggest{Object}

Properties:
Name Type Description
response cercaliax.Suggest.Response

Required.
responseHeader cercaliax.Suggest.ResponseHeader

Required.

cercaliax.TilePoiMapOptions{Object}

Properties:
Name Type Argument Description
tileSize Array.<number> | undefined <optional>

Tile size in pixels. Default: [256, 256].
createMarkersFunction function | undefined <optional>

Custom function to create markers. This function must return an array of markers. Then automatically markers will be drawn.
map cercalia.Map

Map where markers will be painted. Required.
iconBigZoomLevel number | undefined <optional>

Zoom level when the icon size is changed. Only used in the default download version. Default 15.
searchByScale boolean | undefined <optional>

Search POIs by scale. If true server only returns some POIs, if false it return all POIs. Recommended and default value: true.
layer ol.layer.Layer | undefined <optional>

Optional layer. Default it uses internal API and private layer.

cercaliax.UrlCandidatesEntity{Object}

Properties:
Name Type Description
param cercaliax.ParamEntity | Array.<cercaliax.ParamEntity> | null | undefined

Parameter

cercaliax.WMSOptions{Object}

Properties:
Name Type Argument Description
gutter number | undefined <optional>

The size in pixels of the gutter around image tiles to ignore. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter. Defaults to zero. Using a non-zero value allows artifacts of rendering at tile edges to be ignored. If you control the WMS service it is recommended to address "artifacts at tile edges" issues by properly configuring the WMS service. For example, MapServer has a tile_map_edge_buffer configuration parameter for this. See http://mapserver.org/output/tile_mode.html.
tileLoadFunction function | undefined <optional>

Called function after load tiles.
resolutions Array.<number> | undefined <optional>

Only when optìon singleTile is enabled. Specify resolutions in array.
visible boolean | undefined <optional>

Visibility. Default is true (visible).
opacity number | undefined <optional>

Opacity (0, 1). Default is 1.
singleTile number | undefined <optional>

Single tile WMS. Default is false. If false map requests tile sizing is 256x256.

cercaliax.ZBELayerOptions{Object}

Properties:
Name Type Description
a8_name string

Required.
info string

Required.
zbe_name string

Required.