SongExport Enumeration Reference


                    
                    
                    loadImage(source:fileURL:)

Load an image from the cache if found or else from an URL

Declaration

Swift

static func loadImage(source: String, fileURL: URL?) async -> NSImage?

Parameters

`source`	The image source as defined in the song
`fileURL`	The optional URL of the song file

Return Value

<#description#>

Show on GitHub

Export a single `Song` to PDF


                    
                    
                    export(song:)

Export a single song to PDF

Declaration

Swift

static func export(
    song: Song
) async throws -> (pdf: Data, toc: [PDFBuild.TOCInfo])

Parameters


                                song

The Song to export

Return Value

The song as PDF Data and the TOC as a TOCInfo array

Show on GitHub

Get all the PDF elements for a `Song`


                    
                    
                    getSongElements(song:counter:)

Get all the PDF elements for a Song

Declaration

Swift

static func getSongElements(
    song: Song,
    counter: PDFBuild.PageCounter
) async -> [PDFElement]

Parameters

`song`	The `Song`
`counter`	The `PageCounter` class

Return Value

All the PDF elements in an array

Show on GitHub


                    
                    
                    labelDivider(section:)

Calculate the type of divider for a section

Note

If the label is empty, a spacer is returned, else a divider

Declaration

Swift

static func labelDivider(section: Song.Section) -> PDFElement

Parameters


                                section

The Section

Return Value

A Spacer or a Divider

Show on GitHub

SongExport

Declaration

Parameters

Return Value

Export a single Song to PDF

Declaration

Parameters

Return Value

Get all the PDF elements for a Song

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Export a single `Song` to PDF

Get all the PDF elements for a `Song`