smx

This namespace contains all structures which are accessible from library by developers.

There are two types of structures:

  • options with input parameters for published methods
  • result with return values from published methods
Source:
  • spheremap.js, line 19

TypeDefs

Icon

Options for icon definition.

Properties:
Name Type Description
iconUrl string | undefined

URL of icon image.

iconWidth number | undefined

Width of icon image.

iconHeight number | undefined

Height of icon image.

Source:
  • spheremap.js, line 129

LinesDataObjectOptions

Options for additional vector layer with lines.

Properties:
Name Type Description
id string | undefined

ID of layer.

layerId string | undefined

ID of attached layer.

heightUnderSphereCenter number | undefined

Value for correct placement in sphere.

unit3DSize number | undefined

Value for correct placement in sphere.

bboxOffset number | undefined

Offset in meters from actual context location in which are data fetched.

staticData Object | undefined

Optional static data for features in vector layer.

url string | undefined

URL for fetch features dynamically for each context.

attributes Array.<string> | undefined

Attributes fetched from features which are used.

proxyUrl string | undefined

URL to proxy service.

style smx.LineStyle | undefined

Style of vector layer.

useProxy boolean | undefined

Determine if proxy service is used.

onclick smx.OnClick | undefined

OnClick behaviour.

onhover Object | undefined

OnHover behaviour.

Source:
  • spheremap.js, line 249

LineSimpleStyle

Options for line simple style definition.

Properties:
Name Type Description
color number | undefined

color of line.

Source:
  • spheremap.js, line 89

LineStyle

Options for complex style of line vector layer.

Properties:
Name Type Description
defaultStyle smx.Style | undefined

Default style used for displaying line features.

hoverStyle smx.Style | undefined

Style used when user move mouse on line feature.

lineWidth number | undefined

Width of line feature.

Source:
  • spheremap.js, line 195

OnClick

Options for mouse click behaviour. Actually there are two behaviour possibilities:

  • if url property is defined, URL is displayed in new browser tab after user click on line feature. URL can contain any value from feature attributes in format @ATTRIBUTE_NAME@.
  • if callback property is defined, this function is called after user click on line feature.
Properties:
Name Type Description
url string | undefined

URL template.

callback function | undefined

Callback function.

Source:
  • spheremap.js, line 213

PhotoContextLoaderGeoJsonOptions

Options for loading photo contexts from GeoJSON.

Properties:
Name Type Description
calculatePlaneParams boolean | undefined

Calculate plane (ground) parameters after contexts are loaded.

Source:
  • spheremap.js, line 618

PhotoContextLoaderTextOptions

Options for loading photo contexts from text.

Properties:
Name Type Description
calculatePlaneParams boolean | undefined

Calculate plane (ground) parameters after contexts are loaded.

lineLimit number | undefined

The maximum limit of line count read from text.

Source:
  • spheremap.js, line 633

PointsDataObjectOptions

Options for additional vector layer with points.

Properties:
Name Type Description
id string | undefined

ID of layer.

layerId string | undefined

ID of attached layer.

heightUnderSphereCenter number | undefined

Value for correct placement in sphere.

unit3DSize number | undefined

Value for correct placement in sphere.

bboxOffset number | undefined

Offset in meters from actual context location in which are data fetched.

staticData Object | undefined

Optional static data for features in vector layer.

url string | undefined

URL for fetch features dynamically for each context.

attributes Array.<string> | undefined

Attributes fetched from features which are used.

photoUrl string | undefined
photoPreviewUrl string | undefined
proxyUrl string | undefined

URL to proxy service.

style smx.PointStyle | undefined

Style of vector layer.

useProxy boolean | undefined

Determine if proxy service is used.

onclick Object | undefined

OnClick behaviour.

onhover Object | undefined

OnHover behaviour.

Source:
  • spheremap.js, line 323

PointSimpleStyle

Options for point simple style definition.

Properties:
Name Type Description
color number | undefined

color of point.

size number | undefined

size of point.

Source:
  • spheremap.js, line 102

PointStyle

Options for complex style of point vector layer. For displaying point features can be used icon style of text style.

Properties:
Name Type Description
simple smx.PointSimpleStyle | undefined

Definition of simple point style.

icon smx.Icon | undefined

Definition of icon style.

text smx.Text | undefined

Definition of text style.

pointWidth number | undefined

Width of point symbol area used to displaying style.

pointHeight number | undefined

Height of point symbol area used to displaying style.

Source:
  • spheremap.js, line 280

PolygonSimpleStyle

Options for polygon simple style definition.

Properties:
Name Type Description
color number | undefined

color of polygon.

Source:
  • spheremap.js, line 114

Project

Options for defining whole project.

Properties:
Name Type Description
projectKey string

Key of project.

emptyTextureUrl string

URL used for empty image.

proxyUrl string | undefined

URL to proxy service.

scene smx.SceneOptions | undefined

Scene definition.

linesLayers Array.<smx.LinesDataObjectOptions> | undefined

Additional vector layers with lines.

pointsLayers Array.<smx.PointsDataObjectOptions> | undefined

Additional vector layers with points.

wmsLayers Array.<smx.WmsDataObjectOptions> | undefined

Additional WMS layers.

initialContext smx.SpherePhotoContext | undefined

Initial context displayed after viewer is initialized.

Source:
  • spheremap.js, line 487

SceneOptions

Options for defining whole spherical scene.

Properties:
Name Type Description
photoSizes Array.<number> | undefined

Available photo sizes (width).

spherePhoto smx.SpherePhoto | undefined

Location of spherical photos.

sphereRadius number | undefined

Sphere radius.

sphereRadiusData number | undefined

Sphere radius for additional data.

sphereType string | undefined

Type of sphere.

cameraAboveGround number | undefined

Distance between camera and ground in meters.

modifySpherePhotoWhenChanged boolean | undefined

Define if sphere photo will be modified when it is changed.

unitPerMeter number | undefined

Internal units.

minCameraPolarAngle number | undefined

Minimal available angle in look down.

maxCameraPolarAngle number | undefined

Maximal available angle in look up.

onclick smx.OnClick | undefined

OnClick behaviour.

vertexModifier smx.VertexModifierOptions | undefined

Vertex modifier.

Source:
  • spheremap.js, line 451

SpherePhoto

Options for location of spherical photos.

Properties:
Name Type Description
photoUrl string | undefined

URL to spherical photos in full quality.

photoPreviewUrl string | undefined

URL spherical photos in preview quality.

useProxy boolean | undefined

Determine if proxy service is used.

Source:
  • spheremap.js, line 420

SpherePhotoContext

Options for context of spherical photo.

Properties:
Name Type Description
angle smx.Vector

Vector defined rotation of spherical photo.

coord smx.Vector

Vector defined georeferenced coordinates.

plane smx.Vector

Vector defined simplified plane of ground at coordinate of spherical photo.

photoName string

File name of spherical photo.

photoImageData string | undefined

Optional raw data of spherical photo.

Source:
  • spheremap.js, line 74

Style

Options for defining common style of vector layer.

Properties:
Name Type Description
visible boolean | undefined

Visibility of vector feature.

color string | undefined

Color of vector feature.

opacity number | undefined

Opacity of vector feature.

transparent boolean | undefined

Transparency.

Source:
  • spheremap.js, line 177

Text

Options for defining text presentation of vector points.

Properties:
Name Type Description
backgroundColor string | undefined

Background color of text.

font string | undefined

Font definition in 'CSS' string definition format.

fontColor string | undefined

Font color of text.

height number | undefined

Height of text.

scaleDenom number | undefined

Scale denominator for modifying overall text size.

textAttribute string | undefined

Attribute name from vector points, whose value will be used for generating text.

xOffset number | undefined

Left margin before text.

Source:
  • spheremap.js, line 154

Vector

Options for vector definition.

Properties:
Name Type Description
x number

Vector value for x-axis.

y number

Vector value for y-axis.

z number

Vector value for z-axis.

Source:
  • spheremap.js, line 53

Version

Version of sphereMAP library.

Properties:
Name Type Description
major number

Major version number.

minor number

Minor version number.

rev number

Revision number.

name string

Full name of version.

Source:
  • spheremap.js, line 35

VertexModifierOptions

Options for creating vertex modifier.

Properties:
Name Type Description
a number | undefined

Value for correct placement in sphere.

b number | undefined

Value for correct placement in sphere.

c number | undefined

Value for correct placement in sphere.

d number | undefined

Value for correct placement in sphere.

maxOffsetY number | undefined

Value for correct placement in sphere.

staticOffsetY number | undefined

Value for correct placement in sphere.

sphereRadiusData number | undefined

Value for correct placement in sphere.

type string | undefined

Type of vertex modifier.

Source:
  • spheremap.js, line 398

ViewerCallbackOptions

Options for callbacks.

Properties:
Name Type Description
angleChange function | undefined

Callback function.

contextChange function | undefined

Callback function.

click function | undefined

Callback function.

groundClick function | undefined

Callback function.

drawLineGround function | undefined

Callback function.

drawPolygonGround function | undefined

Callback function.

drawingLineGround function | undefined

Callback function.

drawingPolygonGround function | undefined

Callback function.

Source:
  • spheremap.js, line 589

ViewerOptions

Options for viewer.

Properties:
Name Type Description
container Object | undefined

DOM element used to embed viewer.

containerId string | undefined

ID of DOM element used to embed viewer.

defaultActiveTools Array.<string> | undefined

Array of activated tools ID. If this parameter is not defined, CLICK and SELECT tool will be activated by default.

Source:
  • spheremap.js, line 538

WmsDataObjectOptions

Options for additional WMS layer.

Properties:
Name Type Description
id string | undefined

ID of layer.

layerId string | undefined

ID of attached layer.

unit3DSize number | undefined

Value for correct placement in sphere.

bboxOffset number | undefined

Offset in meters from actual context location in which are data fetched.

imageHeight number | undefined

Height of image downloaded from WMS server.

imageWidth number | undefined

Width of image downloaded from WMS server.

proxyUrl string | undefined

URL to proxy service.

url string | undefined

URL for fetch WMS layer content.

useProxy boolean | undefined

Determine if proxy service is used.

Source:
  • spheremap.js, line 365