ImageRenderer
is one other new API for SwiftUI that comes with iOS 16. It lets you simply convert any SwiftUI views into a picture. The implementation may be very easy. You instantiate an occasion of ImageRenderer
with a view for the conversion:
let renderer = ImageRenderer(content material: theView) |
You may then entry the cgImage
or uiImage
property to retrieve the generated picture.
As all the time, I like to exhibit the utilization of an API with an instance. Earlier, we’ve constructed a line chart utilizing the brand new Charts framework. Let’s see the way to let customers save the chart as a picture within the picture album and share it utilizing ShareLink
.
Revisit the Chart View
First, let’s revisit the code of the ChartView instance. We used the brand new API of the Charts
framework to create a line chart and show the climate information. Right here is the code snippet:
}
}
.chartPlotStyle { plotArea in
plotArea
.background(.blue.opacity(0.1))
}
.chartYAxis {
AxisMarks(place: .main)
}
.body(width: 350, top: 300)
.padding(.horizontal)
}
}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
var physique: some View { VStack { Chart { ForEach(chartData, id: .metropolis) { sequence in ForEach(sequence.information) { merchandise in LineMark( x: .worth(“Month”, merchandise.date), y: .worth(“Temp”, merchandise.temperature) ) } .foregroundStyle(by: .worth(“Metropolis”, sequence.metropolis)) .image(by: .worth(“Metropolis”, sequence.metropolis)) } } .chartXAxis { AxisMarks(values: .stride(by: .month)) { worth in AxisGridLine() AxisValueLabel(format: .dateTime.month(.defaultDigits))
} } .chartPlotStyle { plotArea in plotArea .background(.blue.opacity(0.1)) } .chartYAxis { AxisMarks(place: .main) } .body(width: 350, top: 300) .padding(.horizontal)
} } |
To make use of ImageRenderer
, we first refactor this piece of code into a way like this:
}
}
.chartPlotStyle { plotArea in
plotArea
.background(.blue.opacity(0.1))
}
.chartYAxis {
AxisMarks(place: .main)
}
.body(width: 350, top: 300)
.padding(.horizontal)
}
}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
personal func makeChartView() –> some View { VStack { Chart { ForEach(chartData, id: .metropolis) { sequence in ForEach(sequence.information) { merchandise in LineMark( x: .worth(“Month”, merchandise.date), y: .worth(“Temp”, merchandise.temperature) ) } .foregroundStyle(by: .worth(“Metropolis”, sequence.metropolis)) .image(by: .worth(“Metropolis”, sequence.metropolis)) } } .chartXAxis { AxisMarks(values: .stride(by: .month)) { worth in AxisGridLine() AxisValueLabel(format: .dateTime.month(.defaultDigits))
} } .chartPlotStyle { plotArea in plotArea .background(.blue.opacity(0.1)) } .chartYAxis { AxisMarks(place: .main) } .body(width: 350, top: 300)
.padding(.horizontal)
} } |
Subsequent, we declare a variable to carry the view:
var chartView = ChartView() |
Changing the View into an Picture utilizing ImageRenderer
Now we’re able to convert the chart view into a picture. We’ll add a button named Save to Photographs for saving the chart view picture within the picture album.
Let’s implement the button like this:
VStack(spacing: 20) {
chartView
HStack {
Button {
let renderer = ImageRenderer(content material: chartView)
if let picture = renderer.uiImage {
UIImageWriteToSavedPhotosAlbum(picture, nil, nil, nil)
}
} label: {
Label(“Save to Photographs”, systemImage: “picture”)
}
.buttonStyle(.borderedProminent)
}
}
}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
var physique: some View {
VStack(spacing: 20) { chartView
HStack { Button { let renderer = ImageRenderer(content material: chartView)
if let picture = renderer.uiImage { UIImageWriteToSavedPhotosAlbum(picture, nil, nil, nil) } } label: { Label(“Save to Photographs”, systemImage: “picture”) } .buttonStyle(.borderedProminent) } }
} |
Within the closure of the button, we create an occasion of ImageRenderer
with chartView
and get the rendered picture by utilizing the uiImage
property. Then we name UIImageWriteToSavedPhotosAlbum
to avoid wasting the picture to the picture album.
Word: It’s worthwhile to add a key named Privateness – Picture Library Utilization Description within the data.plist earlier than the app can correctly save a picture to the built-in picture album.
Including a Share Button
Earlier, you realized the way to use ShareLink
to current a share sheet for content material sharing. With ImageRenderer
, you possibly can simply construct a operate for customers to share the chart view.
For comfort objective, let’s refactor the code for picture rendering right into a separate technique:
return renderer.uiImage ?? UIImage()
}
@MainActor personal func generateSnapshot() –> UIImage { let renderer = ImageRenderer(content material: chartView)
return renderer.uiImage ?? UIImage() } |
The generateSnapshot
technique converts the chartView
into a picture.
Word: If you’re new to @MainActor
, you possibly can take a look at this text.
With this helper technique, we are able to create a ShareLink
like this within the VStack
view:
ShareLink(merchandise: Picture(uiImage: generateSnapshot()), preview: SharePreview(“Climate Chart”, picture: Picture(uiImage: generateSnapshot()))) .buttonStyle(.borderedProminent) |
Now once you faucet the Share button, the app captures the road chart and allows you to share it as a picture.
Adjusting the Picture Scale
You could discover the decision of the rendered picture is a bit low. The ImageRenderer
class has a property named scale
so that you can modify the dimensions of the rendered picture. By default, its worth is ready to 1.0. To generate a picture with the next decision, you possibly can set it to 2.0
or 3.0
. Alternatively, you possibly can set the worth to the dimensions of the display:
renderer.scale = UIScreen.important.scale |
Abstract
The ImageRenderer
class has made it very straightforward to transform any SwiftUI views into a picture. In case your app helps iOS 16 or up, you should utilize this new API to create some handy options to your customers. Apart from rendering photographs, ImageRenderer
additionally permits you to render a PDF doc. You may check with the official documentation for additional particulars.
For charts, Apple additionally comes with a extra particular renderer referred to as ChartRendere
r for exporting a chart as a picture. Later, we’ll additional look into this class.