Class: GenerateSpatialDataParameters

SuperMap.GenerateSpatialDataParameters

The GenerateSpatialDataParameters class. This class provides reference information for dynamic segmentation.

new SuperMap.GenerateSpatialDataParameters(options)

GenerateSpatialDataParameters.js, line 9
Name Type Description
options Object

The parameters.

Name Type Description
routeTable string

The route dataset.
routeIDField string

The ID field of the route dataset
dataReturnOption SuperMap.DataReturnOption

Sets the data return options.
attributeFilter string optional

Attribute filter criteria.
eventTable string

The event table name for spatial data.
eventRouteIDField string

The event route ID field for spatial data.
measureField string optional

The measure field for the event table. It is significant only when it is the point event.
measureStartField string optional

The start measure field for the event table. It is significant only when it is the line event.
measureEndField string optional

The end measure field for the event table. It is significant only when it is the line event.
measureOffsetField string optional

The measure offset field.
errorInfoField string optional

The error information field of the points or lines for describing the error information that the event can not generate its corresponding points or lines.
retainedFields Array.<string> optional

Field set(except system field) which want to be retained in results spatial data.

Members

attributeFilterstring

Attribute filter criteria. Valid when SuperMap.GenerateSpatialDataParameters.prototype.dataReturnOption.dataReturnMode is DataReturnMode.DATASET_AND_RECORDSET or DataReturnMode.RECORDSET_ONLY.

dataReturnOptionSuperMap.DataReturnOption

Sets the data return options.

errorInfoFieldstring

The error information field of the points or lines for describing the error information that the event can not generate its corresponding points or lines.

eventRouteIDFieldstring

The event route ID field for spatial data.

eventTablestring

The event table name for spatial data.

measureEndFieldstring

The end measure field for the event table. It is significant only when it is the line event.

measureFieldstring

The measure field for the event table. It is significant only when it is the point event.

measureOffsetFieldstring

The measure offset field.

measureStartFieldstring

The start measure field for the event table. It is significant only when it is the line event.

retainedFieldsArray.<string>

Field set(except system field) which want to be retained in results spatial data. When generate spatial data, no matter whether to keep the specific field, routing ID field, tick mark value field(point event is tick mark field, line event is start and end tick mark field) will be all hold in reuslt spaital data, If not specific then retainedFields parameter or retainedField parameter's longth is 0, then return all users field.

routeIDFieldstring

The ID field of the route dataset

routeTablestring

The route dataset.

Methods

destroy()

GenerateSpatialDataParameters.js, line 111

Disposes the resource. The property that references resource is set to null.