Treemap

public struct Treemap<ValuesData> : Trace, DomainSubplot where ValuesData : Plotable

Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles.

The treemap sectors are determined by the entries in labels or ids and in parents.

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 opacity of the trace.

    Declaration

    Swift

    public var opacity: Double?

  • 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>?

  • Undocumented

    Declaration

    Swift

    public var hoverLabel: HoverLabel?

  • Undocumented

    Declaration

    Swift

    public var stream: Stream?

  • Undocumented

    Declaration

    Swift

    public var transforms: [Transform]

  • 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?

  • Sets the labels of each of the sectors.

    Declaration

    Swift

    public var labels: [String]?

  • Sets the parent sectors for each of the sectors.

    Empty string items “ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be "ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

    Declaration

    Swift

    public var parents: [String]?

  • Sets the values associated with each of the sectors.

    Use with branchvalues to determine how the values are summed.

    Declaration

    Swift

    public var values: ValuesData?

  • Determines how the items in values are summed.

    When set to total, items in values are taken to be value of all its descendants. When set to remainder, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

    See more

    Declaration

    Swift

    public enum BranchValues : String, Encodable

  • Determines how the items in values are summed.

    When set to total, items in values are taken to be value of all its descendants. When set to remainder, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

    Declaration

    Swift

    public var branchValues: BranchValues?

  • Determines default for values when it is not provided, by inferring a 1 for each of the leaves and/or branches, otherwise 0.

    See more

    Declaration

    Swift

    public struct Count : OptionSet, Encodable

  • Determines default for values when it is not provided, by inferring a 1 for each of the leaves and/or branches, otherwise 0.

    Declaration

    Swift

    public var count: Count?

  • Sets the level from which this trace hierarchy is rendered.

    Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.

    Declaration

    Swift

    public var level: Anything?

  • Sets the number of rendered sectors from any given level.

    Set maxdepth to -1 to render all the levels in the hierarchy.

    Declaration

    Swift

    public var maxDepth: Int?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Tiling : Encodable

  • Undocumented

    Declaration

    Swift

    public var tiling: Tiling?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Marker : Encodable

  • Undocumented

    Declaration

    Swift

    public var marker: Marker?

  • Undocumented

    See more

    Declaration

    Swift

    public struct PathBar : Encodable

  • Undocumented

    Declaration

    Swift

    public var pathBar: PathBar?

  • Sets text elements associated with each sector.

    If trace textinfo contains a text flag, these elements will be seen on the chart. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

    Declaration

    Swift

    public var text: Data<String>?

  • Determines which trace information appear on the graph.

    See more

    Declaration

    Swift

    public struct TextInfo : OptionSet, Encodable

  • Determines which trace information appear on the graph.

    Declaration

    Swift

    public var textInfo: TextInfo?

  • Template string used for rendering the information text that appear on points.

    Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-format#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

    Declaration

    Swift

    public var textTemplate: Data<String>?

  • Sets hover text elements associated with each sector.

    If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a text flag.

    Declaration

    Swift

    public var hoverText: Data<String>?

  • 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.

    See more

    Declaration

    Swift

    public struct HoverInfo : OptionSet, Encodable

  • 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?

  • Template string used for rendering the information that appear on hover box.

    Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-format#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example “{fullData.name}”. To hide the secondary box completely, use an empty tag <extra></extra>.

    Declaration

    Swift

    public var hoverTemplate: Data<String>?

  • Sets the font used for textinfo.

    Declaration

    Swift

    public var textFont: VariableFont?

  • Sets the font used for textinfo lying inside the sector.

    Declaration

    Swift

    public var insideTextFont: VariableFont?

  • Sets the font used for textinfo lying outside the sector.

    This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.

    Declaration

    Swift

    public var outsideTextFont: OutsideTextFont?

  • Sets the positions of the text elements.

    Declaration

    Swift

    public var textPosition: TextPosition?

  • Determines whether or not the sectors are reordered from largest to smallest.

    Declaration

    Swift

    public var sort: Bool?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Root : Encodable

  • Undocumented

    Declaration

    Swift

    public var root: Root?

  • Declaration

    Swift

    public var domain: Domain?

  • Creates Treemap object from the most frequently used properties.

    Declaration

    Swift

    public init(name: String? = nil, values: ValuesData? = nil, marker: Marker? = nil, text:
        Data<String>? = nil, hoverText: Data<String>? = nil)

    Parameters

    name

    Sets the trace name.
    values

    Sets the values associated with each of the sectors.
    marker

    text

    Sets text elements associated with each sector.
    hoverText

    Sets hover text elements associated with each sector.

  • Creates Treemap object with specified properties.

    Declaration

    Swift

    public init(visible: Visible? = nil, opacity: Double? = nil, name: String? = nil, uid: String? =
        nil, ids: [String]? = nil, customData: [String]? = nil, meta: Data<Anything>? = nil, hoverLabel:
        HoverLabel? = nil, stream: Stream? = nil, transforms: [Transform] = [], uiRevision: Anything? =
        nil, labels: [String]? = nil, parents: [String]? = nil, values: ValuesData? = nil, branchValues:
        BranchValues? = nil, count: Count? = nil, level: Anything? = nil, maxDepth: Int? = nil, tiling:
        Tiling? = nil, marker: Marker? = nil, pathBar: PathBar? = nil, text: Data<String>? = nil,
        textInfo: TextInfo? = nil, textTemplate: Data<String>? = nil, hoverText: Data<String>? = nil,
        hoverInfo: HoverInfo? = nil, hoverTemplate: Data<String>? = nil, textFont: VariableFont? = nil,
        insideTextFont: VariableFont? = nil, outsideTextFont: OutsideTextFont? = nil, textPosition:
        TextPosition? = nil, sort: Bool? = nil, root: Root? = nil, domain: Domain? = nil)

    Parameters

    visible

    Determines whether or not this trace is visible.
    opacity

    Sets the opacity of the trace.
    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.
    hoverLabel

    stream

    transforms

    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.
    labels

    Sets the labels of each of the sectors.
    parents

    Sets the parent sectors for each of the sectors.
    values

    Sets the values associated with each of the sectors.
    branchValues

    Determines how the items in values are summed.
    count

    Determines default for values when it is not provided, by inferring a 1 for each of the leaves and/or branches, otherwise 0.
    level

    Sets the level from which this trace hierarchy is rendered.
    maxDepth

    Sets the number of rendered sectors from any given level.
    tiling

    marker

    pathBar

    text

    Sets text elements associated with each sector.
    textInfo

    Determines which trace information appear on the graph.
    textTemplate

    Template string used for rendering the information text that appear on points.
    hoverText

    Sets hover text elements associated with each sector.
    hoverInfo

    Determines which trace information appear on hover.
    hoverTemplate

    Template string used for rendering the information that appear on hover box.
    textFont

    Sets the font used for textinfo.
    insideTextFont

    Sets the font used for textinfo lying inside the sector.
    outsideTextFont

    Sets the font used for textinfo lying outside the sector.
    textPosition

    Sets the positions of the text elements.
    sort

    Determines whether or not the sectors are reordered from largest to smallest.
    root

    domain

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws