API Data Types

This page describes the data types used in the API description, from primitive types to class definitions.

• <string> : A UTF-8 encoded string.
• <int> : A 32-bit signed integer.
• <float> : A 64-bit signed floating point number.
• <boolean> : A boolean value.

A Coordinate (<coordinate>) object models a spatial position.

Properties :

• x : <float>
• y : <float>
• z : <float>

A PanoramaPhoto (<panoramaphoto>) object models a panorama photo.

Properties :

• photoId : <string>
• location : <coordinate>
• locationCRS : <string>
• cameraHeight : <float>
• timestamp : <string> (format depends on who produced the data. Example : YYYY-MM-DD HH:MM:SS)

A PanoramaCoverage (<panoramacoverage>) object models a panorama coverage.

Properties :

• labelName : <string>
• path : [ [ <coordinate>,… ],… ]

The path property defines a list of polylines that make up the coverage path.

A ObliquePhoto (<obliquephoto>) object models an oblique photo.

Properties :

• photoId : <string>
• direction : <string>
• photoIndex : <int>
• location : <coordinate>
• locationCRS : <string>
• imageWidth : <int>
• imageHeight : <int>
• attributes : <object> (contains an anonymous list of photo attributes).

A Fault (<fault>) object describes why something failed.

Properties :

• faultCode : <string>
• faultString : <string>
• faultDetail : <string>

A LegendParameters (<legendparameters>) object defines a list of basic legend parameters supported by the renderer backend of the publication client.

Properties :

• lineVisibility <boolean>
• lineColor <color>
• fillVisibility <boolean>
• fillColor <color>
• lineWidth <float> (pixels)
• symbolVisibility <boolean>
• symbolURL <string>
• symbolOutline <color>
• symbolFill <color>
• symbolSize <float> (pixels)

New since 11.0.3 :

• lineTransparency <float>
• fillTransparency <float>
• symbolTransparency <float>
• textVisibility <boolean>
• textTransparency <float>
• textAttribute <string>
• textStyle <integer> (0=text, 1=box, 2=callout)
• textColor <color>
• textBoxFillColor <color>
• textBoxLineColor <color>
• textFontSize <float> (pixels)
• textHotspot <string>
• textHotspotMargin <float> (pixels)
• textBoxRounded <boolean>

Possible values for the textHotspot parameter :

• “Top-Left”
• “Top-Center”
• “Top-Right”
• “Center-Left”
• “Center-Center”
• “Center-Right”
• “Bottom-Left”
• “Bottom-Center”
• “Bottom-Right”

The textHotspot parameter tells the renderer where the object is, relative to the label. For example if the textHotspot parameter has the value “Bottom-Left” the label will be rendered so that the object is at the bottomleft corner of the label.

When providing color values to the legend, only red, green and blue channels are expected. Each color has a corresponding “transparency” property that can be used to set the level of transparency to use used (0.0 = opaque, 1.0 = invisible).

A Color (<color>) is a string-encoded color.

The default format is AAA.RRR.GGG.BBB with AAA,RRR,GGG and BBB corresponding to decimal values of the alpha, red, green and blue color channels. The alpha-channel is optional and defaults to 255 when absent.

Examples :

• 255.255.0.0 : opaque red.
• 0.255.0 : opaque green.

An Object Holder (<object>) object models a spatial object with associated attributes.

Properties :

• spatial : <string> (defines the object's spatial component using WKT).
• attributes : <object> (defines the object's attribute component as a map of name/value pairs).

An Attribute Definition (<attributedef>) object models the definition of an attribute.

It has these properties :

• name : <string> (defines the name of the attribute)
• type : <int> (defines the optional primitive type of the attribute, defaults to string).

Type can be :

• 8 : <string>
• 4 : <int>
• 6 : <float>
• 1 : <boolean>

An Attribute Row (<attributerow>) models an array of primitive values that make up one row of attribute values that match a list of attribute definitions.