Hiyve Components - v1.0.0
    Preparing search index...

    Interface StaffSnippetProps

    Props for StaffSnippet.

    interface StaffSnippetProps {
        height?: number;
        highlight?: readonly number[];
        highlightColor?: string;
        labels?: Partial<StaffSnippetLabels>;
        loadEngine: NotationEngineLoader;
        musicxml: string;
        noteStyles?: ReadonlyMap<string, MusicXmlNoteStyle>;
        onError?: (error: Error) => void;
        onStatusChange?: (status: StaffStatus) => void;
        sx?: SxProps<Theme>;
        zoom?: number;
    }
    Index

    Properties

    height? highlight? highlightColor? labels? loadEngine musicxml noteStyles? onError? onStatusChange? sx? zoom?

    Properties

    height?: number

    Height of the box the staff is centred in, in pixels (default: 176)

    highlight?: readonly number[]

    Notes to light up, by their place in the question's notes — lowest first in a chord or harmonic interval, left to right otherwise

    highlightColor?: string

    Colour of a lit note (MUI palette path or CSS colour; default: primary.main)

    labels?: Partial<StaffSnippetLabels>
    loadEngine: NotationEngineLoader

    Supplies the notation engine (an OpenSheetMusicDisplay-compatible build)

    musicxml: string

    The one-bar MusicXML to draw, as a question gives it

    noteStyles?: ReadonlyMap<string, MusicXmlNoteStyle>

    Note styles as MusicXmlPlayer takes them, keyed by musicXmlNoteKey: a colour, and the note played in a wrong note's place, drawn beside it

    onError?: (error: Error) => void

    Called when the engine or the score fails to load

    onStatusChange?: (status: StaffStatus) => void

    Told as the staff is drawn: 'drawing', then 'drawn' — or 'failed', when it says so in its box with a button to try again

    sx?: SxProps<Theme>
    zoom?: number

    Size of the staff relative to the engine's own (default: 1.1)

    Settings

    Member Visibility

    On This Page

    Properties