spcx

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:
  • spacemap.js, line 19

TypeDefs

CameraOptions

Options for define camera setting.

Properties:
Name Type Description
type string | undefined

Type of used camera/controls. Possible values are "mode1", "mode2"

position spcx.Vector | undefined

ToDo

look spcx.Vector | undefined

ToDo

Source:
  • spacemap.js, line 140

ContextOptions

Context options for viewer.

Properties:
Name Type Description
camera spcx.CameraOptions

ToDo

extent Array.<number> | undefined

ToDo

Source:
  • spacemap.js, line 203

Project

Options for define whole project.

Properties:
Name Type Description
projectKey string

Key of project.

proxyUrl string | undefined

URL to proxy service.

emptyTextureUrl string

URL used for empty image.

extent Array.<number>

ToDo

zoom number

ToDo

useWireframe boolean | undefined

ToDo

tileData string

ToDo

tileTextures spcx.TileTextures

ToDo

camera spcx.CameraOptions

ToDo

zOffset number | undefined

ToDo

Source:
  • spacemap.js, line 171

TileTexture

Options for define one texture used on DMT tiles.

Properties:
Name Type Description
id string

ID of texture (layer)

type string

Type of used texture. Possible values are "tile", "WMS"

tileUrl string | undefined

URL of tiled texture.

wmsUrl string | undefined

URL of WMS texture.

textureSize number | undefined

Size of WMS texture.

textureSizes Array.<spcx.TileTextureSize> | undefined

size of textures for different distance from camera

useProxy boolean | undefined

Determine if proxy service is used.

Source:
  • spacemap.js, line 105

TileTextures

Options for define textures used on DMT tiles.

Properties:
Name Type Description
background spcx.TileTexture

ToDo

overlays Array.<spcx.TileTexture>

ToDo

Source:
  • spacemap.js, line 124

TileTextureSize

Properties:
Name Type Description
maxDistance number

maximal distance (tile count) of tile from camera for this texture size

size number

texture size in pixel

Source:
  • spacemap.js, line 81

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:
  • spacemap.js, line 53

Version

Version of spaceMAP 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:
  • spacemap.js, line 35

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.

Source:
  • spacemap.js, line 68