Interface ToShapefileOptions

Conversion options to Shapefile.

interface ToShapefileOptions {
    dateFormat?: string;
    escapeFormulaChars?: boolean;
    fileName?: string;
    generatePrimaryKey?: boolean;
    locale?: string;
    numberFormat?: string;
    outFields?: string[];
    outSpatialReference?: SpatialReference;
    timeFormat?: string;
    useFormattedValues?: boolean;
}

Hierarchy

  • BaseShapefileOptions
    • ToShapefileOptions

Properties

dateFormat? escapeFormulaChars? fileName? generatePrimaryKey? locale? numberFormat? outFields? outSpatialReference? timeFormat? useFormattedValues?

Properties

OptionaldateFormat

dateFormat?: string

The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the "timestamp" pseudo-format, or a custom format string.

OptionalescapeFormulaChars

escapeFormulaChars?: boolean

Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).

OptionalfileName

fileName?: string

When exporting to a shapefile, the file name to use.

OptionalgeneratePrimaryKey

generatePrimaryKey?: boolean

Indicates if a primary key should be generated if not found, defaults to true.

Optionallocale

locale?: string

The locale to use for formatting values. Accepts a valid locale code (example: "inv", "fr" or "de-AT"). Default is "inv" or invariant culture.

OptionalnumberFormat

numberFormat?: string

The format for numbers. The default is NumberFormat.ROUND_TRIP.

OptionaloutFields

outFields?: string[]

A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise "*" meaning all fields.

OptionaloutSpatialReference

outSpatialReference?: SpatialReference

When exporting to a shapefile, this is the spatial reference of the geometry in the shapefile file. The default is WGS84. When importing from shapefile, this is the spatial reference of the geometry in the result.

OptionaltimeFormat

timeFormat?: string

The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.

OptionaluseFormattedValues

useFormattedValues?: boolean

If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.

Settings

Member Visibility

On This Page

Properties