Title

public struct Title : Encodable
extension Layout.Title: ExpressibleByStringLiteral

Undocumented

  • Sets the plot’s title.

    Note that before the existence of title.text, the title’s contents used to be defined as the title attribute itself. This behavior has been deprecated.

    Declaration

    Swift

    public var text: String?

  • Sets the title font.

    Note that the title’s font used to be customized by the now deprecated titlefont attribute.

    Declaration

    Swift

    public var font: Font?

  • Sets the container x refers to.

    container spans the entire width of the plot. paper refers to the width of the plotting area only.

    See more

    Declaration

    Swift

    public enum XAxisReference : String, Encodable

  • Sets the container x refers to.

    container spans the entire width of the plot. paper refers to the width of the plotting area only.

    Declaration

    Swift

    public var xReference: XAxisReference?

  • Sets the container y refers to.

    container spans the entire height of the plot. paper refers to the height of the plotting area only.

    See more

    Declaration

    Swift

    public enum YAxisReference : String, Encodable

  • Sets the container y refers to.

    container spans the entire height of the plot. paper refers to the height of the plotting area only.

    Declaration

    Swift

    public var yReference: YAxisReference?
  • x

    Sets the x position with respect to xref in normalized coordinates from 0 (left) to 1 (right).

    Declaration

    Swift

    public var x: Double?
  • y

    Sets the y position with respect to yref in normalized coordinates from 0 (bottom) to 1 (top).

    auto places the baseline of the title onto the vertical center of the top margin.

    Declaration

    Swift

    public var y: Double?

  • Sets the title’s horizontal alignment with respect to its x position.

    left means that the title starts at x, right means that the title ends at x and center means that the title’s center is at x. auto divides xref by three and calculates the xanchor value automatically based on the value of x.

    Declaration

    Swift

    public var xAnchor: XAutoAnchor?

  • Sets the title’s vertical alignment with respect to its y position.

    top means that the title’s cap line is at y, bottom means that the title’s baseline is at y and middle means that the title’s midline is at y. auto divides yref by three and calculates the yanchor value automatically based on the value of y.

    Declaration

    Swift

    public var yAnchor: YAutoAnchor?

  • Sets the padding of the title.

    Each padding value only applies when the corresponding xanchor/yanchor value is set accordingly. E.g. for left padding to take effect, xanchor must be set to left. The same rule applies if xanchor/yanchor is determined automatically. Padding is muted if the respective anchor value is middle/center.

    Declaration

    Swift

    public var padding: Padding?

  • Creates Title object with specified properties.

    Declaration

    Swift

    public init(text: String? = nil, font: Font? = nil, xReference: XAxisReference? = nil,
        yReference: YAxisReference? = nil, x: Double? = nil, y: Double? = nil, xAnchor: XAutoAnchor? =
        nil, yAnchor: YAutoAnchor? = nil, padding: Padding? = nil)

    Parameters

    text

    Sets the plot’s title.
    font

    Sets the title font.
    xReference

    Sets the container x refers to.
    yReference

    Sets the container y refers to.
    x

    Sets the x position with respect to xref in normalized coordinates from 0 (left) to 1 (right).
    y

    Sets the y position with respect to yref in normalized coordinates from 0 (bottom) to 1 (top).
    xAnchor

    Sets the title’s horizontal alignment with respect to its x position.
    yAnchor

    Sets the title’s vertical alignment with respect to its y position.
    padding

    Sets the padding of the title.

  • Declaration

    Swift

    public init(stringLiteral: String)