TabularData · IOS API REFERENCE

FormattingOptions

struct · iOS 15.0+ · SDK 27.1

struct FormattingOptions

A set of parameters that indicate how to present the contents of data frame or column types to a printable string.

Members (23)

get · iOS 15.4+

dateFormatStyle

TypeScript

get dateFormatStyle(): _Foundation_Date_FormatStyle

Swift declaration

var dateFormatStyle: Date.FormatStyle { get set }

The date format style.

set · iOS 15.4+

dateFormatStyle

TypeScript

set dateFormatStyle(value: _Foundation_Date_FormatStyle)

Swift declaration

var dateFormatStyle: Date.FormatStyle { get set }

The date format style.

get · iOS 15.0+

maximumRowCount

TypeScript

get maximumRowCount(): number

Swift declaration

var maximumRowCount: Int

The largest number of rows a description can generate.

set · iOS 15.0+

maximumRowCount

TypeScript

set maximumRowCount(value: number)

Swift declaration

var maximumRowCount: Int

The largest number of rows a description can generate.

get · iOS 15.0+

maximumCellWidth

TypeScript

get maximumCellWidth(): number

Swift declaration

var maximumCellWidth: Int

The largest number of characters a description can generate per cell.

set · iOS 15.0+

maximumCellWidth

TypeScript

set maximumCellWidth(value: number)

Swift declaration

var maximumCellWidth: Int

The largest number of characters a description can generate per cell.

init · iOS 15.0+

init

TypeScript

static initMaximumLineWidthMaximumCellWidthMaximumRowCountIncludesColumnTypes(maximumLineWidth: number, maximumCellWidth?: number, maximumRowCount?: number, includesColumnTypes?: boolean): FormattingOptions

Swift declaration

init(maximumLineWidth: Int, maximumCellWidth: Int = 50, maximumRowCount: Int = 20, includesColumnTypes: Bool = true)

Creates a formatting options instance. - Parameters: - maximumLineWidth: The largest number of characters a description can generate per line. - maximumCellWidth: The largest number of characters a description can generate per cell. - maximumRowCount: The largest number of rows a description can generate. - includesColumnTypes: A Boolean that indicates whether the description prints a column's type.

get · iOS 15.0+

maximumLineWidth

TypeScript

get maximumLineWidth(): number

Swift declaration

var maximumLineWidth: Int

The largest number of characters a description can generate per line.

set · iOS 15.0+

maximumLineWidth

TypeScript

set maximumLineWidth(value: number)

Swift declaration

var maximumLineWidth: Int

The largest number of characters a description can generate per line.

get · iOS 17.0+

includesRowIndices

TypeScript

get includesRowIndices(): boolean

Swift declaration

var includesRowIndices: Bool

A Boolean value that indicates whether the description includes the row indices.

set · iOS 17.0+

includesRowIndices

TypeScript

set includesRowIndices(value: boolean)

Swift declaration

var includesRowIndices: Bool

A Boolean value that indicates whether the description includes the row indices.

get · iOS 15.4+

integerFormatStyle

TypeScript

get integerFormatStyle(): _Foundation_IntegerFormatStyle<number>

Swift declaration

var integerFormatStyle: IntegerFormatStyle<Int> { get set }

The integer format style.

set · iOS 15.4+

integerFormatStyle

TypeScript

set integerFormatStyle(value: _Foundation_IntegerFormatStyle<number>)

Swift declaration

var integerFormatStyle: IntegerFormatStyle<Int> { get set }

The integer format style.

get · iOS 15.0+

includesColumnTypes

TypeScript

get includesColumnTypes(): boolean

Swift declaration

var includesColumnTypes: Bool

A Boolean value that indicates whether the description includes the column types.

set · iOS 15.0+

includesColumnTypes

TypeScript

set includesColumnTypes(value: boolean)

Swift declaration

var includesColumnTypes: Bool

A Boolean value that indicates whether the description includes the column types.

get · iOS 15.4+

floatingPointFormatStyle

TypeScript

get floatingPointFormatStyle(): _Foundation_FloatingPointFormatStyle<number>

Swift declaration

var floatingPointFormatStyle: FloatingPointFormatStyle<Double> { get set }

The floating point format style.

set · iOS 15.4+

floatingPointFormatStyle

TypeScript

set floatingPointFormatStyle(value: _Foundation_FloatingPointFormatStyle<number>)

Swift declaration

var floatingPointFormatStyle: FloatingPointFormatStyle<Double> { get set }

The floating point format style.

get · iOS 17.0+

includesRowAndColumnCounts

TypeScript

get includesRowAndColumnCounts(): boolean

Swift declaration

var includesRowAndColumnCounts: Bool

A Boolean value that indicates whether the description includes the number of rows and columns.

set · iOS 17.0+

includesRowAndColumnCounts

TypeScript

set includesRowAndColumnCounts(value: boolean)

Swift declaration

var includesRowAndColumnCounts: Bool

A Boolean value that indicates whether the description includes the number of rows and columns.

get · iOS 15.4+

locale

TypeScript

get locale(): _Foundation_Locale

Swift declaration

var locale: Locale { get set }

The locale.

set · iOS 15.4+

locale

TypeScript

set locale(value: _Foundation_Locale)

Swift declaration

var locale: Locale { get set }

The locale.

init · iOS 15.4+

init

TypeScript

static initLocale(locale: _Foundation_Locale): FormattingOptions

Swift declaration

init(locale: Locale)

Creates a formatting options instance with a locale.

init · iOS 15.0+

init

TypeScript

static init(): FormattingOptions

Swift declaration

init()

Creates a formatting options instance with default parameters.

Skipped declarations

No declarations were skipped in this snapshot.

All TabularData types →