Class Dashes

The <dashes> element

Parent element: <direction-type>

The <dashes> element represents dashes, used for instance with cresc. and dim. marks.

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

Hierarchy

Dashes

Implements

XMLElement<"dashes", DashesAttributes, DashesContents>

Index

Constructors

constructor

new Dashes(opts?): Dashes
Parameters
- Optional opts: {
  attributes?: Partial<DashesAttributes>;
  contents?: [];
  }
  - Optional attributes?: Partial<DashesAttributes>
  - Optional contents?: []
Returns Dashes
- Defined in generated/elements.ts:38735

Properties

attributes

attributes: DashesAttributes

contents: []

`Readonly` schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        dash-length: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        number: {
            type: "optional";
            value: {
                max: 16;
                min: 1;
                type: "int";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        space-length: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["start", "stop", "continue"];
                type: "choices";
            };
        };
    };
    contents: readonly [];
    name: "dashes";
} = Dashes.schema

Type declaration

Readonly attributes: {
    color: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        };
    };
    dash-length: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
    default-x: {
        label: "default-x";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    default-y: {
        label: "default-y";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    number: {
        type: "optional";
        value: {
            max: 16;
            min: 1;
            type: "int";
        };
    };
    relative-x: {
        label: "relative-x";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    relative-y: {
        label: "relative-y";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    space-length: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
    type: {
        type: "required";
        value: {
            choices: readonly ["start", "stop", "continue"];
            type: "choices";
        };
    };
}
- 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 dash-length: {
      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 default-x: {
      label: "default-x";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "default-x"
  - Readonly type: "label"
  - Readonly value: {
        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 default-y: {
      label: "default-y";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "default-y"
  - Readonly type: "label"
  - Readonly value: {
        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 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 number: {
      type: "optional";
      value: {
          max: 16;
          min: 1;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 16;
        min: 1;
        type: "int";
    }
    - Readonly max: 16
    - Readonly min: 1
    - Readonly type: "int"
- Readonly relative-x: {
      label: "relative-x";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "relative-x"
  - Readonly type: "label"
  - Readonly value: {
        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 relative-y: {
      label: "relative-y";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "relative-y"
  - Readonly type: "label"
  - Readonly value: {
        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 space-length: {
      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 type: {
      type: "required";
      value: {
          choices: readonly ["start", "stop", "continue"];
          type: "choices";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
    choices: readonly ["start", "stop", "continue"];
    type: "choices";
    }
    - Readonly choices: readonly ["start", "stop", "continue"]
    - Readonly type: "choices"
Readonly contents: readonly []
Readonly name: "dashes"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    color: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        };
    };
    dash-length: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
    default-x: {
        label: "default-x";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    default-y: {
        label: "default-y";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    number: {
        type: "optional";
        value: {
            max: 16;
            min: 1;
            type: "int";
        };
    };
    relative-x: {
        label: "relative-x";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    relative-y: {
        label: "relative-y";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    space-length: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
    type: {
        type: "required";
        value: {
            choices: readonly ["start", "stop", "continue"];
            type: "choices";
        };
    };
}
- 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 dash-length: {
      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 default-x: {
      label: "default-x";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "default-x"
  - Readonly type: "label"
  - Readonly value: {
        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 default-y: {
      label: "default-y";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "default-y"
  - Readonly type: "label"
  - Readonly value: {
        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 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 number: {
      type: "optional";
      value: {
          max: 16;
          min: 1;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 16;
        min: 1;
        type: "int";
    }
    - Readonly max: 16
    - Readonly min: 1
    - Readonly type: "int"
- Readonly relative-x: {
      label: "relative-x";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "relative-x"
  - Readonly type: "label"
  - Readonly value: {
        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 relative-y: {
      label: "relative-y";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "relative-y"
  - Readonly type: "label"
  - Readonly value: {
        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 space-length: {
      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 type: {
      type: "required";
      value: {
          choices: readonly ["start", "stop", "continue"];
          type: "choices";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
    choices: readonly ["start", "stop", "continue"];
    type: "choices";
    }
    - Readonly choices: readonly ["start", "stop", "continue"]
    - Readonly type: "choices"
Readonly contents: readonly []
Readonly name: "dashes"

Methods

getColor

getColor(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:38749

getDashLength

getDashLength(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:38758

getDefaultX

getDefaultX(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:38767

getDefaultY

getDefaultY(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:38776

getId

getId(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:38785

getNumber

getNumber(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:38794

getRelativeX

getRelativeX(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:38803

getRelativeY

getRelativeY(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:38812

getSpaceLength

getSpaceLength(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:38821

getType

getType(): "start" | "stop" | "continue"
Gets

Returns "start" | "stop" | "continue"
- Defined in generated/elements.ts:38740

setColor

setColor(color): Dashes
Sets
Parameters
- color: null | string
Returns Dashes
- Defined in generated/elements.ts:38753

setDashLength

setDashLength(dashLength): Dashes
Sets
Parameters
- dashLength: null | number
Returns Dashes
- Defined in generated/elements.ts:38762

setDefaultX

setDefaultX(defaultX): Dashes
Sets
Parameters
- defaultX: null | number
Returns Dashes
- Defined in generated/elements.ts:38771

setDefaultY

setDefaultY(defaultY): Dashes
Sets
Parameters
- defaultY: null | number
Returns Dashes
- Defined in generated/elements.ts:38780

setId

setId(id): Dashes
Sets
Parameters
- id: null | string
Returns Dashes
- Defined in generated/elements.ts:38789

setNumber

setNumber(number): Dashes
Sets
Parameters
- number: null | number
Returns Dashes
- Defined in generated/elements.ts:38798

setRelativeX

setRelativeX(relativeX): Dashes
Sets
Parameters
- relativeX: null | number
Returns Dashes
- Defined in generated/elements.ts:38807

setRelativeY

setRelativeY(relativeY): Dashes
Sets
Parameters
- relativeY: null | number
Returns Dashes
- Defined in generated/elements.ts:38816

setSpaceLength

setSpaceLength(spaceLength): Dashes
Sets
Parameters
- spaceLength: null | number
Returns Dashes
- Defined in generated/elements.ts:38825

setType

setType(type): Dashes
Sets
Parameters
- type: "start" | "stop" | "continue"
Returns Dashes
- Defined in generated/elements.ts:38744

Class Dashes

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<DashesAttributes>; contents?: []; }

Optional attributes?: Partial<DashesAttributes>

Optional contents?: []

Returns Dashes

Properties

attributes

contents

Readonly schema

Type declaration

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 dash-length: { 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 default-x: { label: "default-x"; type: "label"; value: { type: "optional"; value: { max: number; min: number; type: "float"; }; }; }

Readonly label: "default-x"

Readonly type: "label"

Readonly value: { 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 default-y: { label: "default-y"; type: "label"; value: { type: "optional"; value: { max: number; min: number; type: "float"; }; }; }

Readonly label: "default-y"

Readonly type: "label"

Readonly value: { 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 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 number: { type: "optional"; value: { max: 16; min: 1; type: "int"; }; }

Readonly type: "optional"

Readonly value: { max: 16; min: 1; type: "int"; }

Readonly max: 16

Readonly min: 1

Readonly type: "int"

Readonly relative-x: { label: "relative-x"; type: "label"; value: { type: "optional"; value: { max: number; min: number; type: "float"; }; }; }

Readonly label: "relative-x"

Readonly type: "label"

Readonly value: { 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 relative-y: { label: "relative-y"; type: "label"; value: { type: "optional"; value: { max: number; min: number; type: "float"; }; }; }

Readonly label: "relative-y"

Readonly type: "label"

Readonly value: { 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 space-length: { type: "optional"; value: { max: number; min: number; type: "float"; }; }

`Optional` opts: {
attributes?: Partial<DashesAttributes>;
contents?: [];
}

`Optional` attributes?: Partial<DashesAttributes>

`Optional` contents?: []

`Readonly` schema

`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` dash-length: {
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` default-x: {
label: "default-x";
type: "label";
value: {
type: "optional";
value: {
max: number;
min: number;
type: "float";
};
};
}

`Readonly` label: "default-x"

`Readonly` type: "label"

`Readonly` value: {
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` default-y: {
label: "default-y";
type: "label";
value: {
type: "optional";
value: {
max: number;
min: number;
type: "float";
};
};
}

`Readonly` label: "default-y"

`Readonly` type: "label"

`Readonly` value: {
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` 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` number: {
type: "optional";
value: {
max: 16;
min: 1;
type: "int";
};
}

`Readonly` type: "optional"

`Readonly` value: {
max: 16;
min: 1;
type: "int";
}

`Readonly` max: 16

`Readonly` min: 1

`Readonly` type: "int"

`Readonly` relative-x: {
label: "relative-x";
type: "label";
value: {
type: "optional";
value: {
max: number;
min: number;
type: "float";
};
};
}

`Readonly` label: "relative-x"

`Readonly` type: "label"

`Readonly` value: {
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` relative-y: {
label: "relative-y";
type: "label";
value: {
type: "optional";
value: {
max: number;
min: number;
type: "float";
};
};
}

`Readonly` label: "relative-y"

`Readonly` type: "label"

`Readonly` value: {
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` space-length: {
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` type: {
type: "required";
value: {
choices: readonly ["start", "stop", "continue"];
type: "choices";
};
}

`Readonly` type: "required"

`Readonly` value: {
choices: readonly ["start", "stop", "continue"];
type: "choices";
}

`Readonly` choices: readonly ["start", "stop", "continue"]

`Readonly` type: "choices"

`Readonly` contents: readonly []

`Readonly` name: "dashes"

`Static` `Readonly` schema

`Readonly` color: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
};
}

`Readonly` type: "optional"