Documentation

Original

Reference

cdi:TabularTextDataSet-delimiter

Definition

The Delimiting character in the data. Must be used if isDelimited is True. "The separator between cells, set by the delimiter property of a dialect description. The default is ,. See the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-data-model/#encoding). From the "CSV Dialect" specification (https://specs.frictionlessdata.io/csv-dialect/#specification): "delimiter: specifies a one-character string to use as the field separator. Default = ,."

CDIF

Definition

Field delimiter (e.g., "," or tab).

Scope

csvw:delimiter - field-separator character.

Documentation

Original

Reference

cdi:TabularTextDataSet-isDelimited

Definition

Indicates whether the data are in a delimited format. If "true," the format is delimited, and the isFixedWidth property must be set to "false." If not set to "true," the property isFixedWitdh must be set to "true."

CDIF

Definition

cdi:isDelimited - whether the file is delimited.

Documentation

Original

Reference

cdi:TabularTextDataSet-isFixedWidth

Definition

Set to true if the file is fixed-width. If true, isDelimited must be set to false.

CDIF

Definition

cdi:isFixedWidth - whether the file is fixed-width.

Documentation

Original

Reference

cdi:TabularTextDataSet-hasHeader

Definition

True if the file contains a header containing column names. From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect "header: A boolean atomic property that, if true, sets the header row count flag to 1, and if false to 0, unless headerRowCount is provided, in which case the value provided for the header property is ignored. The default is true." From http://specs.frictionlessdata.io/csv-dialect/ "header: indicates whether the file includes a header row. If true the first row in the file is a header row, not data. Default = true".

CDIF

Definition

cdi:hasHeader - whether the file has a header row.

Documentation

Original

Reference

cdi:TabularTextDataSet-headerRowCount

Definition

The number of lines in the header From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect "headerRowCount: A numeric atomic property that sets the header row count flag to the single provided value, which MUST be a non-negative integer. The default is 1."

CDIF

Definition

cdi:headerRowCount - number of header rows.

Documentation

Original

Reference

cdi:TabularTextDataSet-headerIsCaseSensitive

Definition

If True, the case of the labels in the header is significant. From the "CSV Dialect" specification (http://specs.frictionlessdata.io/csv-dialect/): "caseSensitiveHeader: indicates that case in the header is meaningful. For example, columns CAT and Cat should not be equated. Default = false."

CDIF

Definition

cdi:headerIsCaseSensitive - whether header matching is case-sensitive.

Documentation

Original

Reference

cdi:TabularTextDataSet-lineTerminator

Definition

The strings that can be used at the end of a row, set by the lineTerminators property of a dialect description. The default is [CRLF, LF]. See the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-data-model/#encoding) 5.9 Dialect "lineTerminators: An atomic property that sets the line terminators flag to either an array containing the single provided string value, or the provided array. The default is ['rn', 'n']." Also, from the "CSV Dialect" specification (http://specs.frictionlessdata.io/csv-dialect/): "lineTerminator: specifies the character sequence which should terminate rows. Default = rn."

CDIF

Definition

Allowed line terminators, in order (default [CRLF, LF]).

Scope

cdi:lineTerminator - line terminator characters.

Documentation

Original

Reference

cdi:TabularTextDataSet-quoteCharacter

Definition

"The string that is used around escaped cells, or null, set by the quoteChar property of a dialect description. The default is ".". See W3C Recommendation "Model for Tabular Data and Metadata on the Web", https://www.w3.org/TR/tabular-data-model/#parsing. From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.9 Dialect: "quoteChar: An atomic property that sets the quote character flag to the single provided value, which MUST be a string or null. If the value is null, the escape character flag is also set to null. The default is '"'." From the CSV Dialect specification (http://specs.frictionlessdata.io/csv-dialect/): "quoteChar: specifies a one-character string to use as the quoting character. Default = "."

CDIF

Definition

cdi:quoteCharacter - quote character for quoted values.

Documentation

Original

Reference

cdi:TabularTextDataSet-escapeCharacter

Definition

"The string that is used to escape the quote character within escaped cells, or null" see https://www.w3.org/TR/tabular-data-model/#encoding. From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect "doubleQuote: A boolean atomic property that, if true, sets the escape character flag to ". If false, to \. The default is true." From http://specs.frictionlessdata.io/csv-dialect/ "doubleQuote: controls the handling of quotes inside fields. If true, two consecutive quotes should be interpreted as one. Default = true".

CDIF

Definition

cdi:escapeCharacter - escape character within quoted values.

Documentation

Original

Reference

cdi:commentPrefix

CDIF

Definition

Character(s) that mark a line as a comment.

Scope

cdi:commentPrefix - prefix marking a comment line.

Documentation

Original

Reference

cdi:TabularTextDataSet-skipBlankRows

Definition

If the value is True, blank rows are ignored. From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.9 Dialect: "skipBlankRows: A boolean atomic property that sets the skip blank rows flag to the single provided boolean value. The default is false."

CDIF

Definition

cdi:skipBlankRows - whether to skip blank rows.

Documentation

Original

Reference

cdi:TabularTextDataSet-skipDataColumns

Definition

The number of columns to skip at the beginning of the row. From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.9 Dialect: "skipColumns: A numeric atomic property that sets the skip columns flag to the single provided numeric value, which MUST be a non-negative integer. The default is 0." A value other than 0 will mean that the source numbers of columns will be different from their numbers.

CDIF

Definition

cdi:skipDataColumns - number of data columns to skip.

Documentation

Original

Reference

cdi:TabularTextDataSet-skipInitialSpace

Definition

If the value is True, skip whitespace at the beginning of a line or following a delimiter. From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.9 Dialect: "skipInitialSpace: A boolean atomic property that, if true, sets the trim flag to 'start' and if false, to false. If the trim property is provided, the skipInitialSpace property is ignored. The default is false." From the CSV Dialect specification (http://specs.frictionlessdata.io/csv-dialect/): "skipInitialSpace: specifies how to interpret whitespace which immediately follows a delimiter; if false, it means that whitespace immediately after a delimiter should be treated as part of the following field. Default = true."

CDIF

Definition

cdi:skipInitialSpace - whether to skip initial whitespace.

Documentation

Original

Reference

cdi:TabularTextDataSet-skipRows

Definition

Number of input rows to skip preceding the header or data. From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.9 Dialect: "skipRows: A numeric atomic property that sets the skip rows flag to the single provided numeric value, which MUST be a non-negative integer. The default is 0." A value greater than 0 will mean that the source numbers of rows will be different from their numbers.

CDIF

Definition

cdi:skipRows - number of leading rows to skip.

Documentation

Original

Reference

cdi:TabularTextDataSet-treatConsecutiveDelimitersAsOne

Definition

If the value is True, consecutive (adjacent) delimiters are treated as a single delimiter; if the value is False consecutive (adjacent) delimiters indicate a missing value.

CDIF

Definition

cdi:treatConsecutiveDelimitersAsOne - whether consecutive delimiters collapse.

Documentation

Original

Reference

cdi:TabularTextDataSet-trim

Definition

Specifies which spaces to remove from a data value (start, end, both, neither) From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.9 Dialect: "trim: An atomic property that, if the boolean true, sets the trim flag to true and if the boolean false to false. If the value provided is a string, sets the trim flag to the provided value, which MUST be one of 'true', 'false', 'start', or 'end'. The default is true."

CDIF

Definition

Which spaces to remove from a data value (DDI-CDI TabularTextDataSet.trim, TrimValues enumeration).

Scope

cdi:trim - whitespace-trimming mode.

Documentation

Original

Reference

cdi:TabularTextDataSet-tableDirection

Definition

Indicates the direction in which columns are arranged in each row. From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) 5.3.2: "tableDirection: An atomic property that MUST have a single string value that is one of 'rtl', 'ltr', or 'auto'. Indicates whether the tables in the group should be displayed with the first column on the right, on the left, or based on the first character in the table that has a specific direction. The value of this property becomes the value of the table direction annotation for all the tables in the table group. See Bidirectional Tables in [tabular-data-model] for details. The default value for this property is 'auto'."

CDIF

Definition

Direction in which columns are arranged in each row (DDI-CDI TabularTextDataSet.tableDirection, TableDirectionValues enumeration).

Scope

cdi:tableDirection - row / column primary direction.

Documentation

Original

Reference

cdi:TabularTextDataSet-textDirection

Definition

Indicates the reading order of text within cells. From the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-metadata/) Inherited 5.7: "textDirection: An atomic property that MUST have a single string value that is one of 'ltr', 'rtl', 'auto' or 'inherit' (the default). Indicates whether the text within cells should be displayed as left-to-right text (ltr), as right-to-left text (rtl), according to the content of the cell (auto) or in the direction inherited from the table direction annotation of the table. The value of this property determines the text direction annotation for the column, and the text direction annotation for the cells within that column: if the value is inherit then the value of the text direction annotation is the value of the table direction annotation on the table, otherwise it is the value of this property. See Bidirectional Tables in [tabular-data-model] for details."

CDIF

Definition

Reading order of text within cells (DDI-CDI TabularTextDataSet.textDirection, TextDirectionValues enumeration).

Scope

cdi:textDirection - text direction (ltr / rtl / ...).