Edit

SpatialCsvWriteOptions interface

  • Reference
Package:
azure-maps-spatial-io

Options for writing delimited files.

Extends
SpatialDataWriteOptions

Properties

delimiter

The delimiter character that separates the cells in a row of data. Default: ","
elvColName

If spatialformat is 'latlonelv' this specifies the name of the elevation column to be written in the header. Default: "elv"
geoColName

The column name for the column in which the GeoJSON geometry is written to. Default: "geo"
includeTypesInHeader

Specifies if OData type information should be included in the header beside each column name in brackets. Possible type values: string, number, boolean, date, geography Default: false
latColName

If spatialformat is "latlon" or "latlonelv" this specifies the name of the latitude column to be written in the header. Default: "lat"
lonColName

If spatialformat is "latlon" or "latlonelv" this specifies the name of the longitude column to be written in the header. Default: "lon"
spatialformat

Specifies how the GeoJSON data should be written. If set to 'latlon' and the geometry is a Point type a latitude and longitude columns will be added. If the geometry is not a Point, its row will not be written. If set to 'latlonelv' an elevation column will also be added. Elevation data will be retrieved from 3rd value in position of Point if specified or by set to 0. If set to 'wkt' the geometry value will be written as a Well-Known Text string. Default: "wkt"
textQualifier

Specifies the value that wraps text strings that contain the delimiter. Default: "

Inherited Properties

format

The spatial data format to write the shapes to. Default: "GeoJSON"

Property Details

delimiter

The delimiter character that separates the cells in a row of data. Default: ","

delimiter?: string

Property Value

string

elvColName

If spatialformat is 'latlonelv' this specifies the name of the elevation column to be written in the header. Default: "elv"

elvColName?: string

Property Value

string

geoColName

The column name for the column in which the GeoJSON geometry is written to. Default: "geo"

geoColName?: string

Property Value

string

includeTypesInHeader

Specifies if OData type information should be included in the header beside each column name in brackets. Possible type values: string, number, boolean, date, geography Default: false

includeTypesInHeader?: boolean

Property Value

boolean

latColName

If spatialformat is "latlon" or "latlonelv" this specifies the name of the latitude column to be written in the header. Default: "lat"

latColName?: string

Property Value

string

lonColName

If spatialformat is "latlon" or "latlonelv" this specifies the name of the longitude column to be written in the header. Default: "lon"

lonColName?: string

Property Value

string

spatialformat

Specifies how the GeoJSON data should be written. If set to 'latlon' and the geometry is a Point type a latitude and longitude columns will be added. If the geometry is not a Point, its row will not be written. If set to 'latlonelv' an elevation column will also be added. Elevation data will be retrieved from 3rd value in position of Point if specified or by set to 0. If set to 'wkt' the geometry value will be written as a Well-Known Text string. Default: "wkt"

spatialformat?: "latlon" | "latlonelv" | "wkt"

Property Value

"latlon" | "latlonelv" | "wkt"

textQualifier

Specifies the value that wraps text strings that contain the delimiter. Default: "

textQualifier?: string

Property Value

string

Inherited Property Details

format

The spatial data format to write the shapes to. Default: "GeoJSON"

format?: "KML" | "GPX" | "GeoRSS" | "GML" | "GeoJSON" | "CSV"

Property Value

"KML" | "GPX" | "GeoRSS" | "GML" | "GeoJSON" | "CSV"

Inherited From SpatialDataWriteOptions.format