ConcentrationScales

public struct ConcentrationScales : Encodable

Undocumented

  • The label of the links to color based on their concentration within a flow.

    Declaration

    Swift

    public var label: String?

  • Sets the upper bound of the color domain.

    Declaration

    Swift

    public var cMax: Double?

  • Sets the lower bound of the color domain.

    Declaration

    Swift

    public var cMin: Double?

  • 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, usecmin and cmax. 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?

  • When used in a template, named items are created in the output figure in addition to any items the figure already has in this array.

    You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

    Declaration

    Swift

    public var name: String?

  • Used to refer to a named item in this array in the template.

    Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

    Declaration

    Swift

    public var templateItemName: String?

  • Creates ConcentrationScales object with specified properties.

    Declaration

    Swift

    public init(label: String? = nil, cMax: Double? = nil, cMin: Double? = nil, colorScale:
        ColorScale? = nil, name: String? = nil, templateItemName: String? = nil)

    Parameters

    label

    The label of the links to color based on their concentration within a flow.
    cMax

    Sets the upper bound of the color domain.
    cMin

    Sets the lower bound of the color domain.
    colorScale

    Sets the colorscale.
    name

    When used in a template, named items are created in the output figure in addition to any items the figure already has in this array.
    templateItemName

    Used to refer to a named item in this array in the template.