GitHub View on GitHub

Chord Provider Song structure Chord_Provider.Song Structure Reference

Song

struct Song

The structure of a song as shown in Chord Provider

Show on GitHub

id
The ID of the song
Declaration
Swift

var id: UUID = UUID()
Show on GitHub

Display options

displayOptions
The display options for the Song
Declaration
Swift

var displayOptions = DisplayOptions()
Show on GitHub

Meta data directives

metaData
The meta data about the Song
Declaration
Swift

var metaData = MetaData()
Show on GitHub

Meta data directives that are defined

definedMetaData
An array of defined directives that only should be set once

Note
Used in the directive menus to disable once only directives
Declaration
Swift

var definedMetaData: [ChordPro.Directive] = []
Show on GitHub

All the sections in the song

sections
The sections of the song
Declaration
Swift

var sections = [Song.Section]()
Show on GitHub

All the chords in the song

chords
The chords of the song
Declaration
Swift

var chords: [ChordDefinition] = []
Show on GitHub

The structure for `Song` display options

DisplayOptions
The structure for Song display options
See more
Declaration
Swift

struct DisplayOptions: Codable, Equatable
Show on GitHub

The structure for meta data about the song

MetaData
Structure for meta data about the song
See more
Declaration
Swift

struct MetaData
Show on GitHub

Render a `Song` structure into a SwiftUI `View`

RenderView
Render a Song structure into a SwiftUI View
See more
Declaration
Swift

struct RenderView: View
Show on GitHub

The structure for a section in the `Song`

Section
A section in the Song
See more
Declaration
Swift

struct Section: Identifiable
Show on GitHub