## Index

### Classes AppUtil

- ModalEventHandlerProxy
- QueryParser

### Classes Other

- DomBuilder
- MappedMeasures
- MappedNotes
- MappedSystems
- SelectionMap
- SuiNoteTextComponent
- SuiRockerComponent
- SuiSampler
- SuiTextEditor
- SuiTextInputComponent
- SuiToggleComponent
- SuiTracker
- SuiXhrLoader
- SvgBox
- SvgPage
- SvgPageMap
- SvgPoint
- TickIteratorBase
- VxSystem

### Classes SmoModifier

- SmoArticulation
- SmoAudioPlayerSettings
- SmoBarline
- SmoDynamicText
- SmoFormattingManager
- SmoGraceNote
- SmoInstrument
- SmoLayoutManager
- SmoLyric
- SmoMeasureFormat
- SmoMeasureModifierBase
- SmoMeasureText
- SmoMicrotone
- SmoNoteModifierBase
- SmoOrnament
- SmoPageLayout
- SmoPartInfo
- SmoRehearsalMark
- SmoRepeatSymbol
- SmoScoreInfo
- SmoScoreModifierBase
- SmoScorePreferences
- SmoScoreText
- SmoSlur
- SmoStaffHairpin
- SmoStaffTextBracket
- SmoSystemGroup
- SmoTempoText
- SmoTextGroup
- SmoTie
- SmoVolta
- StaffModifierBase
- TimeSignature

### Classes SmoObject

- SmoMeasure
- SmoNote
- SmoScore
- SmoSystemStaff
- SmoTuplet

### Classes SmoToMidi

- SmoToMidi

### Classes SmoToXml

- SmoToXml
- XmlHelpers
- XmlState
- XmlToSmo

### Classes SmoTransform

- PasteBuffer
- SmoAudioScore
- SmoBeamer
- SmoContractNoteActor
- SmoContractTupletActor
- SmoDuration
- SmoMakeTupletActor
- SmoSelection
- SmoSelector
- SmoStretchNoteActor
- SmoTickIterator
- SmoUnmakeTupletActor
- TickMap
- UndoBuffer

### Classes SmoUtilities

- SmoAudioPitch
- SmoMusic
- SmoOperation

### Classes SuiApplication

- SmoConfiguration
- SuiApplication
- SuiEventHandler
- SuiKeyCommands

### Classes SuiAudio

- CuedAudioContexts
- SuiAudioPlayer
- SuiOscillator
- SuiReverb
- SuiSampleMedia
- SuiWavetable

### Classes SuiDialog

- SuiChordChangeDialog
- SuiComponentAdapter
- SuiComponentBase
- SuiComponentParent
- SuiDialogAdapterBase
- SuiDialogBase
- SuiDialogNotifier
- SuiDropdownComponent
- SuiDropdownComposite
- SuiInsertMeasures
- SuiLoadFileDialog
- SuiLoadMxmlDialog
- SuiLyricComponent
- SuiMidiLoadAdapter
- SuiModifierDialogFactory
- SuiSmoLoadAdapter
- SuiXmlLoadAdapter

### Classes SuiRender

- SuiInlineText
- SuiLayoutFormatter
- SuiMapper
- SuiRenderState
- SuiScoreRender
- SuiScoreView
- SuiScoreViewOperations
- SuiScroller
- VxMeasure

### Classes SuiUiBase

- BrowserEventSource
- CompleteNotifier
- ModalComponent
- ModalEventHandler

### Interfaces Other

- AccidentalArray
- ButtonDefinition
- ClefSign
- ColumnMappedParams
- DialogDom
- EventHandler
- EventHandlerParams
- FontInfo
- FontPurpose
- GraceNoteParams
- ISmoBeamGroup
- ISmoMeasureFormatMgr
- KeyBinding
- KeyEvent
- MeasureNumber
- MeasureSvg
- MeasureTickmaps
- MenuChoiceDefinition
- MenuDefinition
- ModifierTab
- Pitch
- PitchKey
- Renderable
- RenderedPage
- SmoAttrs
- SmoAudioPlayerParameters
- SmoBarlineParams
- SmoFormattingManagerParams
- SmoLyricParams
- SmoLyricPersist
- SmoMeasureFormatParams
- SmoModifierBase
- SmoObjectParams
- SmoOscillatorInfo
- SmoPageLayoutParams
- SmoRenderConfiguration
- SmoRepeatSymbolParams
- SmoScorePreferencesParams
- SmoSelectionParams
- SmoSystemGroupParams
- SmoTempoTextParams
- SmoVoice
- SuiDomParams
- SuiInstance
- SuiMenuParams
- SuiNoteTextParams
- SuiRendererInstance
- SuiRibbonParams
- SuiRockerCompositeParams
- SuiTextEditorParams
- SuiToggleCompositeParams
- SvgDimensions
- TickMappable
- Ticks
- TieLine
- Transposable
- VexNoteValue
- WaveTable
- XmlLyricData
- XmlSlurType
- XmlTieType
- XmlTupletData
- XmlWedgeInfo

### Interfaces SmoModifier

- SmoPartInfoParams

### Interfaces SmoParameters

- SmoInstrumentParams
- SmoMeasureParams
- SmoNoteParams
- SmoScoreParams
- SmoSlurParams
- SmoStaffHairpinParams
- SmoStaffTextBracketParams
- SmoSystemStaffParams
- SmoTieParams
- SmoTupletParams
- TimeSignatureParameters

### Interfaces SmoParams

- SmoArticulationParameters
- SmoDynamicTextParams
- SmoDynamicTextPersist
- SmoMeasureTextParams
- SmoMicrotoneParams
- SmoOrnamentParams
- SmoRehearsalMarkParams
- SmoScoreTextParams
- SmoTextGroupParams
- SmoVoltaParams

### Interfaces SmoToXml

- SmoState

### Interfaces SmoTransform

- SmoContractNoteParams
- SmoContractTupletParams
- SmoMakeTupletParams
- SmoStretchNoteParams
- SmoUnmakeTupletParams

### Interfaces SmoUtilities

- KeySignatureRole

### Interfaces SuiApplication

- KeyCommandParams
- SmoConfigurationParams

### Interfaces SuiAudio

- AudioSample
- CuedAudioContext
- CuedAudioLink
- InstrumentSampleChooser
- SampleChooserParams
- SoundParamMeasureLink
- SoundParams
- SuiAudioPlayerParams
- SuiOscillatorParams

### Interfaces SuiDialog

- DialogDefinition
- DialogTranslation
- DialogTranslationElement

### Interfaces SuiDialogParams

- DialogDefinitionElement
- DialogDefinitionOption
- SuiBaseComponentParams
- SuiDialogAdapterParams
- SuiDialogParams
- SuiDropdownComponentParams
- SuiDropdownCompositeParams
- SuiRockerComponentParams
- SuiTextInputComponentParams
- SuiToggleComponentParams

### Interfaces SuiParameters

- SuiInlineBlock
- SuiInlineTextParams

### Interfaces SuiRender

- MeasureEstimate
- SuiRendererBase
- ViewMapEntry

### Interfaces SuiRenderParams

- ScoreRenderParams

### Interfaces SuiUiBase

- SmoUiConfiguration

### Interfaces {SmoParams}

- ScaledPageLayout
- SmoGlobalLayout
- SmoLayoutManagerParams

### Type Aliases

- BatchSelectionOperation
- ButtonAction
- Clef
- PitchLetter
- SampleChooser
- SmoModifier
- SmoTextGroupPurpose
- engravingFontType

### Variables

- engravingFontTypes

### Functions Other

- IsOscillatorType
- createTopDomContainer
- getDomContainer

### Functions SuiAudio

- sampleFromFrequency
- sampleFromMinDuration

## Type Aliases

### BatchSelectionOperation

BatchSelectionOperation: "dotDuration" | "undotDuration" | "doubleDuration" | "halveDuration" | "doubleGraceNoteDuration" | "halveGraceNoteDuration"

- Defined in src/smo/xform/operations.ts:31

supported operations for {@link SmoOperation.batchSelectionOperation} to change a note's duration

### ButtonAction

ButtonAction: "menu" | "modal" | "collapseChild" | "collapseChildMenu" | "collapseParent" | "collapseGrandchild" | "collapseMore"

- Defined in src/ui/buttons/button.ts:15

Button actions are one of the following.

- collapse... buttons are used to expand/collapse button groups in a ribbon. all buttons with these classes have 'ctor' constructor, and perform actions based on their bind method
- menu brings up a modal menu with class 'ctor'
- modal brings up a modal dialog with class 'ctor'
- collapseChildMenu brings up a modal menu, and is also collapsable.

### Clef

Clef: "treble" | "bass" | "tenor" | "alto" | "soprano" | "percussion" | "mezzo-soprano" | "baritone-c" | "baritone-f" | "subbass" | "french"

- Defined in src/smo/data/common.ts:172

Restriction from string to supported clefs

### PitchLetter

PitchLetter: "a" | "b" | "c" | "d" | "e" | "f" | "g"

- Defined in src/smo/data/common.ts:39

constraint for SmoPitch.letter value, in lower case

### SampleChooser

SampleChooser: ((params: SampleChooserParams, samples: SmoOscillatorInfo[]) => AudioSample | null)

- Defined in src/render/audio/samples.ts:23

#### Type declaration

- - (params: SampleChooserParams, samples: SmoOscillatorInfo[]): AudioSample | null

  - A function prototype that chooses from among samples to return the correct one for that note

    #### Parameters

    - ##### params: SampleChooserParams

    - ##### samples: SmoOscillatorInfo[]

    #### Returns AudioSample | null

### SmoModifier

SmoModifier: SmoNoteModifierBase | SmoMeasureModifierBase | StaffModifierBase | SmoScoreModifierBase

- Defined in src/smo/data/score.ts:146

Union of modifier types Smo modifier types

### SmoTextGroupPurpose

SmoTextGroupPurpose: "NONE" | "TITLE" | "SUBTITLE" | "COMPOSER" | "COPYRIGHT"

- Defined in src/smo/data/scoreText.ts:254

Suggestion for text purpose, maybe used to find a match..maybe not used at all

### engravingFontType

engravingFontType: "Bravura" | "Gonville" | "Petaluma" | "Leland"

- Defined in src/smo/data/score.ts:38

List of engraving fonts available in Smoosic

## Variables

### Const engravingFontTypes

engravingFontTypes: engravingFontType[] = ...

- Defined in src/smo/data/score.ts:42

Arrary of engraving fonts available in Smoosic

## Other Functions

### IsOscillatorType

- IsOscillatorType(otype: string): otype is OscillatorType

- - Defined in src/smo/data/scoreModifiers.ts:139

  web audio API defines this

  #### Parameters

  - ##### otype: string

  #### Returns otype is OscillatorType

### createTopDomContainer

- createTopDomContainer(selector: string | HTMLElement, elementType?: string): HTMLElement

- - Defined in src/common/htmlHelpers.ts:213

  Create a top-level HTML element for modal containers - dialogs etc. from a jquery selector, or just return same if it exists

  #### Parameters

  - ##### selector: string | HTMLElement

  - ##### Optional elementType: string

  #### Returns HTMLElement

### getDomContainer

- getDomContainer(selector: string | HTMLElement): HTMLElement | undefined

- - Defined in src/common/htmlHelpers.ts:186

  Extract an HTMLElement from a Jquery id, DOM element ID, or HTMLELement. If an HTMLElement can't be created, return null

  #### Parameters

  - ##### selector: string | HTMLElement

  #### Returns HTMLElement | undefined

  HTMLElement

## SuiAudio Functions

### sampleFromFrequency

- sampleFromFrequency(params: SampleChooserParams, samples: SmoOscillatorInfo[]): null | AudioSample

- - Defined in src/render/audio/samples.ts:64

  Give a set of samples, return the one that closest matches the frequency

  #### Parameters

  - ##### params: SampleChooserParams

  - ##### samples: SmoOscillatorInfo[]

  #### Returns null | AudioSample

### sampleFromMinDuration

- sampleFromMinDuration(params: SampleChooserParams, samples: SmoOscillatorInfo[]): null | AudioSample

- - Defined in src/render/audio/samples.ts:49

  For instruments like violin that require different samples depending on note duration

  #### Parameters

  - ##### params: SampleChooserParams

  - ##### samples: SmoOscillatorInfo[]

  #### Returns null | AudioSample

Generated using TypeDoc