Class: Export

Extends

• vcs.vcm.widgets.Widget

Members

active{boolean}

className{string}

class Name of the Object

initialized{boolean}

name{string}

unique Name

Methods

getAppearanceThemes(){Array.<string>}

Gets the appearance themes

Deprecated

• 3.6

getCitygmlClassOptions(){Array.<vcs.vcm.widgets.Export.CityGMLClassOptions>}

Returns an array of objects with a value and a title property

getClassName(){string} inherited

returns the class name of this object.

Deprecated

• Yes

Returns:

className

getConfigObject(){Object} inherited

getFormatOptions(){Array.<string>}

Gets the format options available

Deprecated

• 3.6

getId(){string} inherited

returns the id of this object

Deprecated

• Yes

getLodOptions(){Array.<string>}

Gets the lod options available

Deprecated

• 3.6

getName(){string} inherited

returns the name of the Object, the name is either given by the config Object or a uuid is generated

Deprecated

• Yes

getSupportedMaps(){Array.<string>} inherited

Returns the widgets supported maps

getTexturedFormats(){Array.<string>}

Gets formats with texture

Deprecated

• 3.6

isActive(){boolean} inherited

returns the active state of the widget

Deprecated

• v3.6 use the property active directly

Returns:

state of the widget

isInitialized(){boolean} inherited

checks if the Widget is already initialized

Deprecated

• Yes

Returns:

true if all requirements are there

isSupported(map){boolean} inherited

returns true if this widget supports the given map. Should be overriden by the widget

Name	Type	Description
map	string | vcs.vcm.maps.Map	the map or className to check for support

prepareRequestAndSend(query, url, token){Promise}

Request and FME data download. Takes a query Object

Name	Type	Description
query	vcs.vcm.widgets.Export.Query
url	string	optional url, otherwise widgets url is taken
token	string	optional token override for the widgets token

Type Definitions

vcs.vcm.widgets.Export.CityGMLClassOptions{Object}

Properties:

Name	Type	Description
value	string	the CityGML class value
name	string	the associated string representation, eg. Building, Tunnel
citygmlOnly	boolean	whether this class can only be handled when exporting to the CityGML format

vcs.vcm.widgets.Export.Options{vcs.vcm.widgets.Widget.Options}

Properties:

Name	Type	Argument	Default	Description
serverUrl	string			the FME server URL
securityToken	string			the FME security token for the given server
showFreeFormCrsInput	boolean	<optional>	false	show a text input for the output CRS
dataProjection	vcs.vcm.util.Projection.Options | undefined			the datas projection, defaults to the frameworks projection
coordinateSystem	string | Array.<string> | undefined			the output coordinate EPSG. The default value is the data projection. If you pass an array, the first entry is the default and the others become available as a select field
heightMode	string	<optional>	'absolute'
formats	Array.<string> | undefined			the supported export formats
lod	Array.<string>			an array of allowed levels of detail
citygmlclasses	Array.<string>			the supported citygml classes
appearanceThemes	Array.<string>
maxarea	number	<optional>	2000000
classificationType	string | undefined	<optional>	'both'	classifiaction type of the drawing layer
style	vcs.vcm.util.style.VectorStyleItem.Options | undefined			the style used on the drawing layer

vcs.vcm.widgets.Export.Query{Object}

Properties:

Name	Type	Description
format	string	the export format
email	string	the email address to send the download to
cityGmlClasses	Array.<vcs.vcm.widgets.Export.CityGMLClassOptions>	an array of strings representing thematic classes keys
texture	boolean	boolean value wether to add textures
appearance	string	string value of the appearance theme to use
level	string	string value of the level of detail to use
useFeatureGeometry	boolean | undefined	whether to use the feature geometry or not
crs	string | undefined	the output CRS to use