Scene

public final class Scene : Encodable, SubplotAxis

Undocumented

  • uid

    Unique identifier of the axis.

    Declaration

    Swift

    public var uid: UInt
  • Undocumented

    Declaration

    Swift

    public var backgroundColor: Color?
  • Undocumented

    See more

    Declaration

    Swift

    public struct Camera : Encodable
  • Undocumented

    Declaration

    Swift

    public var camera: Camera?
  • Undocumented

    Declaration

    Swift

    public var domain: Domain?
  • If cube, this scene’s axes are drawn as a cube, regardless of the axes’ ranges.

    If data, this scene’s axes are drawn in proportion with the axes’ ranges. If manual, this scene’s axes are drawn in proportion with the input of aspectratio (the default behavior if aspectratio is provided). If auto, this scene’s axes are drawn using the results of data except when one axis is more than four times the size of the two others, where in that case the results of cube are used.

    See more

    Declaration

    Swift

    public enum AspectMode : String, Encodable
  • If cube, this scene’s axes are drawn as a cube, regardless of the axes’ ranges.

    If data, this scene’s axes are drawn in proportion with the axes’ ranges. If manual, this scene’s axes are drawn in proportion with the input of aspectratio (the default behavior if aspectratio is provided). If auto, this scene’s axes are drawn using the results of data except when one axis is more than four times the size of the two others, where in that case the results of cube are used.

    Declaration

    Swift

    public var aspectMode: AspectMode?
  • Sets this scene’s axis aspectratio.

    See more

    Declaration

    Swift

    public struct AspectRatio : Encodable
  • Sets this scene’s axis aspectratio.

    Declaration

    Swift

    public var aspectRatio: AspectRatio?
  • Undocumented

    See more

    Declaration

    Swift

    public struct XAxis : Encodable
  • Undocumented

    Declaration

    Swift

    public var xAxis: XAxis?
  • Undocumented

    See more

    Declaration

    Swift

    public struct YAxis : Encodable
  • Undocumented

    Declaration

    Swift

    public var yAxis: YAxis?
  • Undocumented

    See more

    Declaration

    Swift

    public struct ZAxis : Encodable
  • Undocumented

    Declaration

    Swift

    public var zAxis: ZAxis?
  • Determines the mode of drag interactions for this scene.

    See more

    Declaration

    Swift

    public enum DragMode : Encodable
  • Determines the mode of drag interactions for this scene.

    Declaration

    Swift

    public var dragMode: DragMode?
  • Determines the mode of hover interactions for this scene.

    See more

    Declaration

    Swift

    public enum HoverMode : Encodable
  • Determines the mode of hover interactions for this scene.

    Declaration

    Swift

    public var hoverMode: HoverMode?
  • Controls persistence of user-driven changes in camera attributes.

    Defaults to layout.uirevision.

    Declaration

    Swift

    public var uiRevision: Anything?
  • Undocumented

    See more

    Declaration

    Swift

    public struct Annotation : Encodable
  • Undocumented

    Declaration

    Swift

    public var annotations: [Annotation]?
  • Shared and preset default axis reference used to initialize layout and all traces.

    Declaration

    Swift

    public static let preset: Scene
  • Creates Scene object with specified properties.

    Declaration

    Swift

    public init(uid: UInt = UInt.random(in: 2...UInt.max), backgroundColor: Color? = nil, camera:
            Camera? = nil, domain: Domain? = nil, aspectMode: AspectMode? = nil, aspectRatio: AspectRatio? =
            nil, xAxis: XAxis? = nil, yAxis: YAxis? = nil, zAxis: ZAxis? = nil, dragMode: DragMode? = nil,
            hoverMode: HoverMode? = nil, uiRevision: Anything? = nil, annotations: [Annotation]? = nil)

    Parameters

    uid

    Unique identifier of the axis.

    backgroundColor

    camera

    domain

    aspectMode

    If cube, this scene’s axes are drawn as a cube, regardless of the axes’ ranges.

    aspectRatio

    Sets this scene’s axis aspectratio.

    xAxis

    yAxis

    zAxis

    dragMode

    Determines the mode of drag interactions for this scene.

    hoverMode

    Determines the mode of hover interactions for this scene.

    uiRevision

    Controls persistence of user-driven changes in camera attributes.

    annotations