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