FdcExportOptions class

Cross-format options that control row selection, column selection and text serialization behavior for FDC exports.

Format-specific settings belong in writer-specific option types; these options define behavior shared by dataset/grid export orchestration and the built-in CSV, JSON and XML writers.

Constructors

FdcExportOptions({FdcExportScope scope = FdcExportScope.currentView, FdcExportValueMode valueMode = FdcExportValueMode.raw, bool includeHeaders = true, bool includeNonPersistentFields = false, List<FdcExportColumn> columns = const <FdcExportColumn>[], String csvDelimiter = ',', String lineTerminator = '\n', String rootElementName = 'rows', String rowElementName = 'row', bool sanitizeSpreadsheetFormulas = true})

Creates a FdcExportOptions.

Properties

columns → List<FdcExportColumn>

Optional explicit export column list.

final

csvDelimiter → String

CSV field delimiter. Must be non-empty and cannot contain quotes or line breaks. Defaults to ,.

final

hashCode → int

The hash code for this object.

no setter, override

includeHeaders → bool

Whether tabular writers emit a header row before the exported data rows.

final

includeNonPersistentFields → bool

Whether automatically inferred columns may include non-persistent fields.

final

lineTerminator → String

Line terminator used by built-in text writers.

final

rootElementName → String

Root element name used by the built-in XML writer.

final

rowElementName → String

Element name used for each exported row by the built-in XML writer.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sanitizeSpreadsheetFormulas → bool

Prefixes spreadsheet-like text formulas with an apostrophe.

final

scope → FdcExportScope

Selects which dataset rows are included when exporting through FdcExporter.exportDataSet.

final

valueMode → FdcExportValueMode

Controls whether writers preserve typed values where possible or convert them to display-oriented text.

final

Methods

copyWith({FdcExportScope? scope, FdcExportValueMode? valueMode, bool? includeHeaders, bool? includeNonPersistentFields, List<FdcExportColumn>? columns, String? csvDelimiter, String? lineTerminator, String? rootElementName, String? rowElementName, bool? sanitizeSpreadsheetFormulas}) → FdcExportOptions

Returns a copy with the supplied properties replaced.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

override