Interface UploadDataOptions

Data for a layer to be added.

interface UploadDataOptions {
    data: CellData[][];
    dateFormat?: string;
    displayField?: string;
    escapeFormulaChars?: boolean;
    generatePrimaryKey?: boolean;
    geometryFields?: string[];
    geometryFormat?: GeometryFormat;
    includeHeaderRow?: boolean;
    inSpatialReference?: SpatialReference;
    locale?: string;
    numberFormat?: string;
    outFields?: string[];
    outSpatialReference?: SpatialReference;
    primaryKeyField?: string;
    timeFormat?: string;
    useFormattedValues?: boolean;
}

Hierarchy

  • ConversionFormatOptions
    • UploadDataOptions

Properties

data dateFormat? displayField? escapeFormulaChars? generatePrimaryKey? geometryFields? geometryFormat? includeHeaderRow? inSpatialReference? locale? numberFormat? outFields? outSpatialReference? primaryKeyField? timeFormat? useFormattedValues?

Properties

data

data: CellData[][]

The cells in the table.

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.

OptionaldisplayField

displayField?: string

Typically a string field with text formatted for display.

OptionalescapeFormulaChars

escapeFormulaChars?: boolean

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

OptionalgeneratePrimaryKey

generatePrimaryKey?: boolean

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

OptionalgeometryFields

geometryFields?: string[]

The names of the geometry field(s).

OptionalgeometryFormat

geometryFormat?: GeometryFormat

The format of the geometry in this table.

OptionalincludeHeaderRow

includeHeaderRow?: boolean

The header row contains column names.

OptionalinSpatialReference

inSpatialReference?: SpatialReference

The spatial reference of the geometry in this table.

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

The output spatial reference of the converted table.

OptionalprimaryKeyField

primaryKeyField?: string

Optionally the primary key field.

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