LayoutName

public struct LayoutName : Codable, ExpressibleByStringLiteral, Identifiable, Hashable

Layouts describe how information is shown on the Stream Deck + touch display.

There are built-in pre-defined layouts or create a custom layout JSON file. The layout name or path to the custom layout json file is defined in the manifest.

The layout can also be dynamically changed using the setFeedbackLayout event.

  • id

    Declaration

    Swift

    public var id: String

  • Declaration

    Swift

    public init(_ layoutName: String)

  • Declaration

    Swift

    public init(stringLiteral value: String)

  • Declaration

    Swift

    public init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • The default layout.

    Declaration

    Swift

    public static let icon: LayoutName

  • The layout best suited for custom images with a title.

    Declaration

    Swift

    public static let canvas: LayoutName

  • The layout best suited for representing a single value.

    Declaration

    Swift

    public static let value: LayoutName

  • The layout best suited for representing a single value range.

    Declaration

    Swift

    public static let indicator: LayoutName

  • The layout best suited for representing a single value range, where the data can be further explained using color.

    Declaration

    Swift

    public static let gradient: LayoutName

  • The layout best suited for representing two value ranges.

    Declaration

    Swift

    public static let doubleIndicator: LayoutName