ImageRepresentation

 
struct ImageRepresentation : Equatable

An image representation of a visual instruction component.

  • File formats of visual instruction component images.

    See more

    Declaration

    Swift

    public enum Format : String
    View Source on GitHub

  • Initializes an image representation bearing the image at the given base URL.

    Declaration

    Swift

    public init(imageBaseURL: URL?)
    View Source on GitHub

  • The URL whose path is the prefix of all the possible URLs returned by imageURL(scale:format:).

    Declaration

    Swift

    public let imageBaseURL: URL?
    View Source on GitHub

  • Returns a remote URL to the image file that represents the component.

    Declaration

    Swift

    public func imageURL(scale: CGFloat? = nil, format: Format = .png) -> URL?

    Parameters

    scale

    The image’s scale factor. If this argument is unspecified, the current screen’s native scale factor is used. Only the values 1, 2, and 3 are currently supported.
    format

    The file format of the image. If this argument is unspecified, PNG is used.

    Return Value

    A remote URL to the image.

    View Source on GitHub