web-music-score
    Preparing search index...

    Type Alias StaffConfig

    StaffConfig: BaseConfig & {
        clef: Clef | `${Clef}`;
        grandId?: string;
        isOctaveDown?: boolean;
        maxNote?: string;
        minNote?: string;
        type: "staff";
    }

    Staff config to add staff notation line in score configuration.

    Type Declaration

    • clef: Clef | `${Clef}`

      G-clef or F-clef for this staff config?

    • OptionalgrandId?: string

      To create grand staff: use same grandId value (e.g. "grand1") for two consequtive staves, first having G-clef and second having F-clef.

    • OptionalisOctaveDown?: boolean

      Set octave down with G-clef for guitar treble staff notation line.

    • OptionalmaxNote?: string

      Highest note (e.g. "C6") that can be presented in this staff notation line.

    • OptionalminNote?: string

      Lowest note (e.g. "C2")that can be presented in this staff notation line.

    • type: "staff"

      Config type, must be "staff" for staff config.