Table

public struct Table<CellData> : Trace, DomainSubplot where CellData : Plotable

Table view for detailed data viewing.

The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a column-major order, ie. the grid is represented as a vector of column vectors.

See also

Documentation for Python, JavaScript or R

  • Corresponding Plotly trace type.

    Declaration

    Swift

    public let type: String

  • Switch indicating whether the trace supports animation of its data.

    Declaration

    Swift

    public static var animatable: Bool { get }

  • Determines whether or not this trace is visible.

    If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

    Declaration

    Swift

    public var visible: Visible?

  • Sets the trace name.

    The trace name appear as the legend item and on hover.

    Declaration

    Swift

    public var name: String?
  • uid

    Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

    Declaration

    Swift

    public var uid: String?
  • ids

    Assigns id labels to each datum.

    These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

    Declaration

    Swift

    public var ids: [String]?

  • Assigns extra data each datum.

    This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

    Declaration

    Swift

    public var customData: [String]?

  • Assigns extra meta information associated with this trace that can be used in various text attributes.

    Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

    Declaration

    Swift

    public var meta: Data<Anything>?

  • Determines which trace information appear on hover.

    If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

    Declaration

    Swift

    public var hoverInfo: HoverInfo?

  • Undocumented

    Declaration

    Swift

    public var hoverLabel: HoverLabel?

  • Undocumented

    Declaration

    Swift

    public var stream: Stream?

  • Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title.

    Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

    Declaration

    Swift

    public var uiRevision: Anything?

  • Declaration

    Swift

    public var domain: Domain?

  • The width of columns expressed as a ratio.

    Columns fill the available width in proportion of their specified column widths.

    Declaration

    Swift

    public var columnWidth: Data<Double>?

  • Specifies the rendered order of the data columns; for example, a value 2 at position 0 means that column index 0 in the data will be rendered as the third column, as columns have an index base of zero.

    Declaration

    Swift

    public var columnOrder: [Int]?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Header : Encodable

  • Undocumented

    Declaration

    Swift

    public var header: Header?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Cells<CellData> : Encodable where CellData : Plotable

  • Undocumented

    Declaration

    Swift

    public var cells: Cells<CellData>?

  • Creates Table object with specified properties.

    Declaration

    Swift

    public init(visible: Visible? = nil, name: String? = nil, uid: String? = nil, ids: [String]? =
        nil, customData: [String]? = nil, meta: Data<Anything>? = nil, hoverInfo: HoverInfo? = nil,
        hoverLabel: HoverLabel? = nil, stream: Stream? = nil, uiRevision: Anything? = nil, domain:
        Domain? = nil, columnWidth: Data<Double>? = nil, columnOrder: [Int]? = nil, header: Header? =
        nil, cells: Cells<CellData>? = nil)

    Parameters

    visible

    Determines whether or not this trace is visible.
    name

    Sets the trace name.
    uid

    Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
    ids

    Assigns id labels to each datum.
    customData

    Assigns extra data each datum.
    meta

    Assigns extra meta information associated with this trace that can be used in various text attributes.
    hoverInfo

    Determines which trace information appear on hover.
    hoverLabel

    stream

    uiRevision

    Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title.
    domain

    columnWidth

    The width of columns expressed as a ratio.
    columnOrder

    Specifies the rendered order of the data columns; for example, a value 2 at position 0 means that column index 0 in the data will be rendered as the third column, as columns have an index base of zero.
    header

    cells

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws