Class Print

The <print> element

Parent elements: <measure> (partwise), <part> (timewise)

The <print> element contains general printing parameters, including layout elements. The <part-name-display> and <part-abbreviation-display> elements may also be used here to change how a part name or abbreviation is displayed over the course of a piece. They take effect when the current measure or a succeeding measure starts a new system.

Layout group elements in a <print> element only apply to the current page, system, or staff. Music that follows continues to take the default values from the layout determined by the <defaults> element.

https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/print/

Hierarchy

  • Print

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getBlankPage getId getMeasureLayout getMeasureNumbering getNewPage getNewSystem getPageLayout getPageNumber getPartAbbreviationDisplay getPartNameDisplay getStaffLayouts getStaffSpacing getSystemLayout setBlankPage setId setMeasureLayout setMeasureNumbering setNewPage setNewSystem setPageLayout setPageNumber setPartAbbreviationDisplay setPartNameDisplay setStaffLayouts setStaffSpacing setSystemLayout

Constructors

constructor

Properties

attributes

attributes: PrintAttributes

contents

contents: PrintContents

Readonly schema

schema: {
    attributes: {
        blank-page: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        new-page: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        new-system: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        page-number: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        staff-spacing: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    contents: readonly [{
        type: "optional";
        value: typeof PageLayout;
    }, {
        type: "optional";
        value: typeof SystemLayout;
    }, {
        label: "staff-layouts";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof StaffLayout;
        };
    }, {
        type: "optional";
        value: typeof MeasureLayout;
    }, {
        type: "optional";
        value: typeof MeasureNumbering;
    }, {
        type: "optional";
        value: typeof PartNameDisplay;
    }, {
        type: "optional";
        value: typeof PartAbbreviationDisplay;
    }];
    name: "print";
} = Print.schema

Type declaration

  • Readonly attributes: {
        blank-page: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        new-page: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        new-system: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        page-number: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        staff-spacing: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    }
    • Readonly blank-page: {
          type: "optional";
          value: {
              max: number;
              min: 1;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: number;
            min: 1;
            type: "int";
        }
        • Readonly max: number
        • Readonly min: 1
        • Readonly type: "int"
    • Readonly id: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "_";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "_"
    • Readonly new-page: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
    • Readonly new-system: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
    • Readonly page-number: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
    • Readonly staff-spacing: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: number;
            min: number;
            type: "float";
        }
        • Readonly max: number
        • Readonly min: number
        • Readonly type: "float"
  • Readonly contents: readonly [{
        type: "optional";
        value: typeof PageLayout;
    }, {
        type: "optional";
        value: typeof SystemLayout;
    }, {
        label: "staff-layouts";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof StaffLayout;
        };
    }, {
        type: "optional";
        value: typeof MeasureLayout;
    }, {
        type: "optional";
        value: typeof MeasureNumbering;
    }, {
        type: "optional";
        value: typeof PartNameDisplay;
    }, {
        type: "optional";
        value: typeof PartAbbreviationDisplay;
    }]
  • Readonly name: "print"

Static Readonly schema

schema: {
    attributes: {
        blank-page: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        new-page: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        new-system: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        page-number: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        staff-spacing: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    contents: readonly [{
        type: "optional";
        value: typeof PageLayout;
    }, {
        type: "optional";
        value: typeof SystemLayout;
    }, {
        label: "staff-layouts";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof StaffLayout;
        };
    }, {
        type: "optional";
        value: typeof MeasureLayout;
    }, {
        type: "optional";
        value: typeof MeasureNumbering;
    }, {
        type: "optional";
        value: typeof PartNameDisplay;
    }, {
        type: "optional";
        value: typeof PartAbbreviationDisplay;
    }];
    name: "print";
} = ...

Type declaration

  • Readonly attributes: {
        blank-page: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        new-page: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        new-system: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        page-number: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        staff-spacing: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    }
    • Readonly blank-page: {
          type: "optional";
          value: {
              max: number;
              min: 1;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: number;
            min: 1;
            type: "int";
        }
        • Readonly max: number
        • Readonly min: 1
        • Readonly type: "int"
    • Readonly id: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "_";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "_"
    • Readonly new-page: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
    • Readonly new-system: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
    • Readonly page-number: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
    • Readonly staff-spacing: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: number;
            min: number;
            type: "float";
        }
        • Readonly max: number
        • Readonly min: number
        • Readonly type: "float"
  • Readonly contents: readonly [{
        type: "optional";
        value: typeof PageLayout;
    }, {
        type: "optional";
        value: typeof SystemLayout;
    }, {
        label: "staff-layouts";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof StaffLayout;
        };
    }, {
        type: "optional";
        value: typeof MeasureLayout;
    }, {
        type: "optional";
        value: typeof MeasureNumbering;
    }, {
        type: "optional";
        value: typeof PartNameDisplay;
    }, {
        type: "optional";
        value: typeof PartAbbreviationDisplay;
    }]
  • Readonly name: "print"

Methods

getBlankPage

getId

getMeasureLayout

getMeasureNumbering

getNewPage

getNewSystem

getPageLayout

getPageNumber

getPartAbbreviationDisplay

getPartNameDisplay

getStaffLayouts

getStaffSpacing

getSystemLayout

setBlankPage

setId

setMeasureLayout

setMeasureNumbering

setNewPage

setNewSystem

setPageLayout

setPageNumber

setPartAbbreviationDisplay

setPartNameDisplay

setStaffLayouts

setStaffSpacing

setSystemLayout

Settings

Theme

On This Page

Generated using TypeDoc