Interface NWCTXTFile

interface NWCTXTFile {
    clip: boolean;
    extra?: null | string;
    fonts: Partial<Record<"PageSmallText" | "PageText" | "PageTitleText" | "StaffBold" | "StaffItalic" | "StaffLyric" | "User1" | "User2" | "User3" | "User4" | "User5" | "User6", NWCTXTFontConfig>>;
    properties: {
        Editor?: {
            ActiveStaff?: number;
            CaretIndex?: number;
            CaretPos?: number;
        };
        PgMargins?: {
            Bottom?: number;
            Left?: number;
            Mirror?: boolean;
            Right?: number;
            Top?: number;
        };
        PgSetup?: {
            AllowLayering?: boolean;
            BarNumbers?: string;
            DurationPadding?: boolean;
            ExtendLastSystem?: boolean;
            JustifyVertically?: boolean;
            PageNumbers?: number;
            PrintSystemSepMark?: boolean;
            StaffLabels?: string;
            StaffSize?: number;
            StartingBar?: number;
            TitlePage?: boolean;
            Zoom?: number;
        };
        SongInfo?: {
            Author?: string;
            Comments?: string;
            Copyright1?: string;
            Copyright2?: string;
            Lyricist?: string;
            Title?: string;
        };
    };
    staffs: NWCTXTStaff[];
    version: string;
}

Hierarchy

Properties

clip: boolean

true if the parsed content is in the clipboard format (!NoteWorthyComposerClip), false otherwise (!NoteWorthyComposer)

extra?: null | string

Extra information after Note Worthy Composer version

Example

"Single"
fonts: Partial<Record<"PageSmallText" | "PageText" | "PageTitleText" | "StaffBold" | "StaffItalic" | "StaffLyric" | "User1" | "User2" | "User3" | "User4" | "User5" | "User6", NWCTXTFontConfig>>
properties: {
    Editor?: {
        ActiveStaff?: number;
        CaretIndex?: number;
        CaretPos?: number;
    };
    PgMargins?: {
        Bottom?: number;
        Left?: number;
        Mirror?: boolean;
        Right?: number;
        Top?: number;
    };
    PgSetup?: {
        AllowLayering?: boolean;
        BarNumbers?: string;
        DurationPadding?: boolean;
        ExtendLastSystem?: boolean;
        JustifyVertically?: boolean;
        PageNumbers?: number;
        PrintSystemSepMark?: boolean;
        StaffLabels?: string;
        StaffSize?: number;
        StartingBar?: number;
        TitlePage?: boolean;
        Zoom?: number;
    };
    SongInfo?: {
        Author?: string;
        Comments?: string;
        Copyright1?: string;
        Copyright2?: string;
        Lyricist?: string;
        Title?: string;
    };
}

Type declaration

  • Optional Editor?: {
        ActiveStaff?: number;
        CaretIndex?: number;
        CaretPos?: number;
    }
    • Optional ActiveStaff?: number

      Default

      1
      
    • Optional CaretIndex?: number

      Default

      1
      
    • Optional CaretPos?: number

      Default

      0
      
  • Optional PgMargins?: {
        Bottom?: number;
        Left?: number;
        Mirror?: boolean;
        Right?: number;
        Top?: number;
    }
    • Optional Bottom?: number

      Default

      1.27
      
    • Optional Left?: number

      Default

      1.27
      
    • Optional Mirror?: boolean

      Default

      false
      
    • Optional Right?: number

      Default

      1.27
      
    • Optional Top?: number

      Default

      1.27
      
  • Optional PgSetup?: {
        AllowLayering?: boolean;
        BarNumbers?: string;
        DurationPadding?: boolean;
        ExtendLastSystem?: boolean;
        JustifyVertically?: boolean;
        PageNumbers?: number;
        PrintSystemSepMark?: boolean;
        StaffLabels?: string;
        StaffSize?: number;
        StartingBar?: number;
        TitlePage?: boolean;
        Zoom?: number;
    }
    • Optional AllowLayering?: boolean
    • Optional BarNumbers?: string

      Default

      "None"
      
    • Optional DurationPadding?: boolean

      Default

      false
      
    • Optional ExtendLastSystem?: boolean

      Default

      false
      
    • Optional JustifyVertically?: boolean

      Default

      true
      
    • Optional PageNumbers?: number

      Default

      0
      
    • Optional PrintSystemSepMark?: boolean

      Default

      false
      
    • Optional StaffLabels?: string

      Default

      "None"
      
    • Optional StaffSize?: number

      Default

      16
      
    • Optional StartingBar?: number

      Default

      1
      
    • Optional TitlePage?: boolean

      Default

      true
      
    • Optional Zoom?: number

      Default

      4
      
  • Optional SongInfo?: {
        Author?: string;
        Comments?: string;
        Copyright1?: string;
        Copyright2?: string;
        Lyricist?: string;
        Title?: string;
    }
    • Optional Author?: string
    • Optional Comments?: string
    • Optional Copyright1?: string
    • Optional Copyright2?: string
    • Optional Lyricist?: string
    • Optional Title?: string
staffs: NWCTXTStaff[]
version: string

Note Worthy Composer version as a string

Example

"2.751"

Generated using TypeDoc