Class LineDetail

The <line-detail> element

Parent element: <staff-details>

If the <staff-lines> element is present, the appearance of each line may be individually specified with a <line-detail> element.

The print-object attribute allows lines to be hidden within a staff. This is used in special situations such as a widely-spaced percussion staff where a note placed below the higher line is distinct from a note placed above the lower line. Hidden staff lines are included when specifying clef lines and determining <display-step> / <display-octave> values, but are not counted as lines for the purposes of the <system-layout> and <staff-layout> elements.

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

Hierarchy

  • LineDetail

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getColor getLine getLineType getPrintObject getWidth setColor setLine setLineType setPrintObject setWidth

Constructors

constructor

Properties

attributes

attributes: LineDetailAttributes

contents

contents: []

Readonly schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        line: {
            type: "required";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        line-type: {
            type: "optional";
            value: {
                choices: readonly ["dashed", "dotted", "solid", "wavy"];
                type: "choices";
            };
        };
        print-object: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        width: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    contents: readonly [];
    name: "line-detail";
} = LineDetail.schema

Type declaration

  • Readonly attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        line: {
            type: "required";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        line-type: {
            type: "optional";
            value: {
                choices: readonly ["dashed", "dotted", "solid", "wavy"];
                type: "choices";
            };
        };
        print-object: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        width: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    }
    • Readonly color: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "#000000";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "#000000"
    • Readonly line: {
          type: "required";
          value: {
              max: number;
              min: 1;
              type: "int";
          };
      }
      • Readonly type: "required"
      • Readonly value: {
            max: number;
            min: 1;
            type: "int";
        }
        • Readonly max: number
        • Readonly min: 1
        • Readonly type: "int"
    • Readonly line-type: {
          type: "optional";
          value: {
              choices: readonly ["dashed", "dotted", "solid", "wavy"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["dashed", "dotted", "solid", "wavy"];
            type: "choices";
        }
        • Readonly choices: readonly ["dashed", "dotted", "solid", "wavy"]
        • Readonly type: "choices"
    • Readonly print-object: {
          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 width: {
          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 []
  • Readonly name: "line-detail"

Static Readonly schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        line: {
            type: "required";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        line-type: {
            type: "optional";
            value: {
                choices: readonly ["dashed", "dotted", "solid", "wavy"];
                type: "choices";
            };
        };
        print-object: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        width: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    contents: readonly [];
    name: "line-detail";
} = ...

Type declaration

  • Readonly attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        line: {
            type: "required";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        line-type: {
            type: "optional";
            value: {
                choices: readonly ["dashed", "dotted", "solid", "wavy"];
                type: "choices";
            };
        };
        print-object: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        width: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    }
    • Readonly color: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "#000000";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "#000000"
    • Readonly line: {
          type: "required";
          value: {
              max: number;
              min: 1;
              type: "int";
          };
      }
      • Readonly type: "required"
      • Readonly value: {
            max: number;
            min: 1;
            type: "int";
        }
        • Readonly max: number
        • Readonly min: 1
        • Readonly type: "int"
    • Readonly line-type: {
          type: "optional";
          value: {
              choices: readonly ["dashed", "dotted", "solid", "wavy"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["dashed", "dotted", "solid", "wavy"];
            type: "choices";
        }
        • Readonly choices: readonly ["dashed", "dotted", "solid", "wavy"]
        • Readonly type: "choices"
    • Readonly print-object: {
          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 width: {
          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 []
  • Readonly name: "line-detail"

Methods

getColor

getLine

getLineType

  • Gets

    Returns null | "dashed" | "dotted" | "solid" | "wavy"

getPrintObject

getWidth

setColor

setLine

setLineType

setPrintObject

setWidth

Settings

Theme

On This Page

Generated using TypeDoc