Class: EngravingItem

Engraving.EngravingItem

Extends

Members

(static, readonly) addToSkyline :Boolean

Whether this element is accounted for in layout calculations.

Type:
  • Boolean
Since:
  • 4.6

(static) articulationAnchor :Number

Articulation anchor

Type:
  • Number

(static, readonly) bbox :Rect

Bounding box of this element.

This value is in spatium units for compatibility with other EngravingItem positioning properties.

Type:
  • Rect

(static, readonly) canvasPos :Point

Position of this element relative to the canvas (user interface), in spatium units.

Type:
  • Point
Since:
  • 4.6

(static) color :Color

Item color

Type:
  • Color
See:

(static) direction :Engraving.Direction

The direction of this element,

Type:

(static, readonly) effectiveStaffIdx :Number

Effective staff index for this element. Used by system objects, as they may not always appear at their staffIdx

Type:
  • Number
Since:
  • 4.6

(static, readonly) enabled :Boolean

The enabled element flag.

Type:
  • Boolean
Since:
  • 4.6

(static, readonly) generated :Boolean

Indicates that the element is generated.

Type:
  • Boolean

(static) headGroup :Engraving.NoteHeadGroup

Group of note head

Type:

(static) headType :Engraving.NoteHeadType

Type of note head

Type:

(static, readonly) header :Boolean

The header element flag.

Type:
  • Boolean
Since:
  • 4.6

(static) hideStavesWhenIndividuallyEmpty :Boolean

For parts: Whether to only hide staves on a system if the entire instrument is empty.

Type:
  • Boolean
Since:
  • 4.6

(static) hideWhenEmpty :Engraving.AutoOnOff

For staves and parts: Whether to hide systems when they are empty.

Type:
Since:
  • 4.6

(static) horizontalDirection :Engraving.DirectionH

For parentheses: The horizontal direction.

Type:
Since:
  • 4.6

(static, readonly) isMovable :Boolean

The isMovable element flag. Controls whether this element can be dragged by the mouse.

Type:
  • Boolean
Since:
  • 4.6

(static) keysig_mode :Engraving.KeyMode

For key signatures: The key signature mode.

Type:
Since:
  • 4.6

(static) lineType :Engraving.SlurStyleType

For slurs & ties: The line style of the slur tie.

Type:

(static) offsetX :Number

X-axis offset from a reference position in spatium units.

Type:
  • Number
See:
  • Engraving.EngravingItem.offset

(static) offsetY :Number

Y-axis offset from a reference position in spatium units.

Type:
  • Number
See:
  • Engraving.EngravingItem.offset

(static, readonly) pagePos :Point

Position of this element in page coordinates, in spatium units.

Type:
  • Point

(static, readonly) parent :Engraving.EngravingItem

Parent item for this item.

Type:

(static, readonly) pos :Point

Reference position of this element relative to its parent element, in spatium units. Use pos.x or pos.y to access the X and Y components of this point.

Type:
  • Point
Since:
  • 4.6
See:
  • Engraving.EngravingItem::posX
  • Engraving.EngravingItem::posY

(static, readonly) posX :Number

Reference position of this element relative to its parent element.

This is an offset from the parent object that is determined by the autoplace feature. It includes any other offsets applied to the element. You can use this value to accurately position other elements related to the same parent.

This value is in spatium units for compatibility with EngravingItem.offsetX.

Type:
  • Number

(static, readonly) posY :Number

Reference position of this element relative to its parent element.

This is an offset from the parent object that is determined by the autoplace feature. It includes any other offsets applied to the element. You can use this value to accurately position other elements related to the same parent.

This value is in spatium units for compatibility with EngravingItem.offsetY.

Type:
  • Number

(static, readonly) selected :Boolean

Indicates that the element is selected.

Type:
  • Boolean

(static) showCourtesy :Boolean

For clefs, key signatures, time signatures and system breaks: Whether to generate courtesy objects.

Type:
  • Boolean

(static) slurDirection :Engraving.Direction

For chords, stems, beams and two-chord tremolos: The slur direction.

Type:

(static) small :Boolean

Whether this element is cue size.

Type:
  • Boolean

(static, readonly) staff :Engraving.Staff

Staff which this item belongs to.

Type:
  • Engraving.Staff

(static, readonly) staffIdx :Number

Staff index for this element.

Type:
  • Number
Since:
  • 4.6

(static) stemDirection :Engraving.Direction

For chords, stems, beams and two-chord tremolos: The stem direction.

Type:

(static) subType :Number

Unlike the name might suggest, this property no longer returns the subtype and is scarcely used. Named 'subtype' prior to MuseScore 4.6

Type:
  • Number

(static, readonly) subtype :Number

Subtype of this element.

Type:
  • Number
Since:
  • 4.6

(static, readonly) trailer :Boolean

The trailer element flag.

Type:
  • Boolean
Since:
  • 4.6

(static, readonly) up :Boolean

If the element points upwards. Valid for: Chords, stems, beams, ties, slurs, guitar bends, tuplets, tremolos, articulations

Type:
  • Boolean
Since:
  • 4.6

(static, readonly) vStaffIdx :Number

Staff index for this element, accounting for cross-staffing.

Type:
  • Number
Since:
  • 4.6

(static) visible :Boolean

Indicates that the element is visible.

Type:
  • Boolean

(static) z :Number

Stacking order of this element

Type:
  • Number

Table of contents