ContourCarpet Structure Reference


                    
                    
                    type

Corresponding Plotly trace type.

Declaration

Swift

public let type: String


                    
                    
                    animatable

Switch indicating whether the trace supports animation of its data.

Declaration

Swift

public static var animatable: Bool { get }


                    
                    
                    visible

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?


                    
                    
                    showLegend

Determines whether or not an item corresponding to this trace is shown in the legend.

Declaration

Swift

public var showLegend: Bool?


                    
                    
                    legendGroup

Sets the legend group for this trace.

Traces part of the same legend group hide/show at the same time when toggling legend items.

Declaration

Swift

public var legendGroup: String?


                    
                    
                    opacity

Sets the opacity of the trace.

Declaration

Swift

public var opacity: Double?


                    
                    
                    name

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


                    
                    
                    customData

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


                    
                    
                    meta

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


                    
                    
                    stream

Undocumented

Declaration

Swift

public var stream: 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.

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?


                    
                    
                    carpet

The carpet of the carpet axes on which this contour trace lies

Declaration

Swift

public var carpet: String?

Sets the z data.

Declaration

Swift

public var z: ZData?

Sets the x coordinates.

Declaration

Swift

public var a: AData?

a0

Alternate to x.

Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Declaration

Swift

public var a0: Anything?

da

Sets the x coordinate step.

See x0 for more info.

Declaration

Swift

public var da: Double?

Sets the y coordinates.

Declaration

Swift

public var b: BData?

b0

Alternate to y.

Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Declaration

Swift

public var b0: Anything?

db

Sets the y coordinate step.

See y0 for more info.

Declaration

Swift

public var db: Double?


                    
                    
                    text

Sets the text elements associated with each z value.

Declaration

Swift

public var text: Data<String>?


                    
                    
                    hoverText

Same as text.

Declaration

Swift

public var hoverText: Data<String>?


                    
                    
                    transpose

Transposes the z data.

Declaration

Swift

public var transpose: Bool?


                    
                    
                    AType

If array, the heatmap’s x coordinates are given by x (the default behavior when x is provided).

If scaled, the heatmap’s x coordinates are given by x0 and dx (the default behavior when x is not provided).

Declaration

Swift

public enum AType : String, Encodable


                    
                    
                    aType

If array, the heatmap’s x coordinates are given by x (the default behavior when x is provided).

If scaled, the heatmap’s x coordinates are given by x0 and dx (the default behavior when x is not provided).

Declaration

Swift

public var aType: AType?


                    
                    
                    BType

If array, the heatmap’s y coordinates are given by y (the default behavior when y is provided) If scaled, the heatmap’s y coordinates are given by y0 and dy (the default behavior when y is not provided)

Declaration

Swift

public enum BType : String, Encodable


                    
                    
                    bType

If array, the heatmap’s y coordinates are given by y (the default behavior when y is provided) If scaled, the heatmap’s y coordinates are given by y0 and dy (the default behavior when y is not provided)

Declaration

Swift

public var bType: BType?


                    
                    
                    fillColor

Sets the fill color if contours.type is constraint.

Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

Declaration

Swift

public var fillColor: Color?


                    
                    
                    autoContour

Determines whether or not the contour level attributes are picked by an algorithm.

If true, the number of contour levels can be set in ncontours. If false, set the contour level attributes in contours.

Declaration

Swift

public var autoContour: Bool?


                    
                    
                    nContours

Sets the maximum number of contour levels.

The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is true or if contours.size is missing.

Declaration

Swift

public var nContours: Int?


                    
                    
                    contours

Undocumented

Declaration

Swift

public var contours: Contours?


                    
                    
                    line

Undocumented

Declaration

Swift

public var line: SmoothDashedLine?


                    
                    
                    zAuto

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

Declaration

Swift

public var zAuto: Bool?


                    
                    
                    zMin

Sets the lower bound of the color domain.

Value should have the same units as in z and if set, zmax must be set as well.

Declaration

Swift

public var zMin: Double?


                    
                    
                    zMax

Sets the upper bound of the color domain.

Value should have the same units as in z and if set, zmin must be set as well.

Declaration

Swift

public var zMax: Double?


                    
                    
                    zMiddle

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point.

Value should have the same units as in z. Has no effect when zauto is false.

Declaration

Swift

public var zMiddle: Double?


                    
                    
                    colorScale

Sets the colorscale.

The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, usezmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

Declaration

Swift

public var colorScale: ColorScale?


                    
                    
                    autoColorScale

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale.

In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

Declaration

Swift

public var autoColorScale: Bool?


                    
                    
                    reverseScale

Reverses the color mapping if true.

If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

Declaration

Swift

public var reverseScale: Bool?


                    
                    
                    showScale

Determines whether or not a colorbar is displayed for this trace.

Declaration

Swift

public var showScale: Bool?


                    
                    
                    colorBar

Undocumented

Declaration

Swift

public var colorBar: ColorBar?


                    
                    
                    colorAxis

Sets a reference to a shared color axis.

References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

Declaration

Swift

public var colorAxis: ColorAxis


                    
                    
                    xAxis

Sets a reference between this trace’s x coordinates and a 2D cartesian x axis.

If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

Declaration

Swift

public var xAxis: XAxis


                    
                    
                    yAxis

Sets a reference between this trace’s y coordinates and a 2D cartesian y axis.

If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

Declaration

Swift

public var yAxis: YAxis


                    
                    
                    init(name:z:a:b:text:hoverText:line:colorScale:reverseScale:)

Creates ContourCarpet object from the most frequently used properties.

Declaration

Swift

public init(name: String? = nil, z: ZData? = nil, a: AData? = nil, b: BData? = nil, text:
        Data<String>? = nil, hoverText: Data<String>? = nil, line: SmoothDashedLine? = nil, colorScale:
        ColorScale? = nil, reverseScale: Bool? = nil)

Parameters

`name`	Sets the trace name.
`z`	Sets the z data.
`a`	Sets the x coordinates.
`b`	Sets the y coordinates.
`text`	Sets the text elements associated with each z value.
`hoverText`	Same as `text`.
`line`
`colorScale`	Sets the colorscale.
`reverseScale`	Reverses the color mapping if true.


                    
                    
                    init(visible:showLegend:legendGroup:opacity:name:uid:ids:customData:meta:stream:uiRevision:carpet:z:a:a0:da:b:b0:db:text:hoverText:transpose:aType:bType:fillColor:autoContour:nContours:contours:line:zAuto:zMin:zMax:zMiddle:colorScale:autoColorScale:reverseScale:showScale:colorBar:colorAxis:xAxis:yAxis:)

Creates ContourCarpet object with specified properties.

Declaration

Swift

public init(visible: Visible? = nil, showLegend: Bool? = nil, legendGroup: String? = nil,
        opacity: Double? = nil, name: String? = nil, uid: String? = nil, ids: [String]? = nil,
        customData: [String]? = nil, meta: Data<Anything>? = nil, stream: Stream? = nil, uiRevision:
        Anything? = nil, carpet: String? = nil, z: ZData? = nil, a: AData? = nil, a0: Anything? = nil,
        da: Double? = nil, b: BData? = nil, b0: Anything? = nil, db: Double? = nil, text: Data<String>?
        = nil, hoverText: Data<String>? = nil, transpose: Bool? = nil, aType: AType? = nil, bType:
        BType? = nil, fillColor: Color? = nil, autoContour: Bool? = nil, nContours: Int? = nil,
        contours: Contours? = nil, line: SmoothDashedLine? = nil, zAuto: Bool? = nil, zMin: Double? =
        nil, zMax: Double? = nil, zMiddle: Double? = nil, colorScale: ColorScale? = nil, autoColorScale:
        Bool? = nil, reverseScale: Bool? = nil, showScale: Bool? = nil, colorBar: ColorBar? = nil,
        colorAxis: ColorAxis = .preset, xAxis: XAxis = .preset, yAxis: YAxis = .preset)

Parameters

`visible`	Determines whether or not this trace is visible.
`showLegend`	Determines whether or not an item corresponding to this trace is shown in the legend.
`legendGroup`	Sets the legend group for this trace.
`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.
`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`.
`carpet`	The `carpet` of the carpet axes on which this contour trace lies
`z`	Sets the z data.
`a`	Sets the x coordinates.
`a0`	Alternate to `x`.
`da`	Sets the x coordinate step.
`b`	Sets the y coordinates.
`b0`	Alternate to `y`.
`db`	Sets the y coordinate step.
`text`	Sets the text elements associated with each z value.
`hoverText`	Same as `text`.
`transpose`	Transposes the z data.
`aType`	If array, the heatmap’s x coordinates are given by x (the default behavior when `x` is provided).
`bType`	If array, the heatmap’s y coordinates are given by y (the default behavior when `y` is provided) If scaled, the heatmap’s y coordinates are given by y0 and dy (the default behavior when `y` is not provided)
`fillColor`	Sets the fill color if `contours.type` is constraint.
`autoContour`	Determines whether or not the contour level attributes are picked by an algorithm.
`nContours`	Sets the maximum number of contour levels.
`contours`
`line`
`zAuto`	Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.
`zMin`	Sets the lower bound of the color domain.
`zMax`	Sets the upper bound of the color domain.
`zMiddle`	Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point.
`colorScale`	Sets the colorscale.
`autoColorScale`	Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`.
`reverseScale`	Reverses the color mapping if true.
`showScale`	Determines whether or not a colorbar is displayed for this trace.
`colorBar`
`colorAxis`	Sets a reference to a shared color axis.
`xAxis`	Sets a reference between this trace’s x coordinates and a 2D cartesian x axis.
`yAxis`	Sets a reference between this trace’s y coordinates and a 2D cartesian y axis.


                    
                    
                    encode(to:)

Encodes the object in a format compatible with Plotly.

Declaration

Swift

public func encode(to encoder: Encoder) throws