Note Entry
get_music_region
note_entry.get_music_region(entry)
Returns an intance of FCMusicRegion that corresponds to the metric location of the input note entry.
| Input |
Type |
Description |
entry |
FCNoteEntry |
|
| Output type |
Description |
FCMusicRegion |
|
get_evpu_notehead_height
note_entry.get_evpu_notehead_height(entry)
Returns the calculated height of the notehead rectangle.
| Input |
Type |
Description |
entry |
FCNoteEntry |
|
| Output type |
Description |
number |
the EVPU height |
get_top_note_position
note_entry.get_top_note_position(entry, entry_metrics)
Returns the vertical page coordinate of the top of the notehead rectangle, not including the stem.
| Input |
Type |
Description |
entry |
FCNoteEntry |
|
entry_metrics (optional) |
FCEntryMetrics |
entry metrics may be supplied by the caller if they are already available |
| Output type |
Description |
number |
|
get_bottom_note_position
note_entry.get_bottom_note_position(entry, entry_metrics)
Returns the vertical page coordinate of the bottom of the notehead rectangle, not including the stem.
| Input |
Type |
Description |
entry |
FCNoteEntry |
|
entry_metrics (optional) |
FCEntryMetrics |
entry metrics may be supplied by the caller if they are already available |
| Output type |
Description |
number |
|
calc_widths
note_entry.calc_widths(entry)
Get the widest left-side notehead width and widest right-side notehead width.
| Input |
Type |
Description |
entry |
FCNoteEntry |
|
| Output type |
Description |
number, number |
widest left-side notehead width and widest right-side notehead width |
calc_left_of_all_noteheads
note_entry.calc_left_of_all_noteheads(entry)
Calculates the handle offset for an expression with “Left of All Noteheads” horizontal positioning.
| Input |
Type |
Description |
entry |
FCNoteEntry |
the entry to calculate from |
| Output type |
Description |
number |
offset from left side of primary notehead rectangle |
calc_left_of_primary_notehead
note_entry.calc_left_of_primary_notehead(entry)
Calculates the handle offset for an expression with “Left of Primary Notehead” horizontal positioning.
| Input |
Type |
Description |
entry |
FCNoteEntry |
the entry to calculate from |
| Output type |
Description |
number |
offset from left side of primary notehead rectangle |
calc_center_of_all_noteheads
note_entry.calc_center_of_all_noteheads(entry)
Calculates the handle offset for an expression with “Center of All Noteheads” horizontal positioning.
| Input |
Type |
Description |
entry |
FCNoteEntry |
the entry to calculate from |
| Output type |
Description |
number |
offset from left side of primary notehead rectangle |
calc_center_of_primary_notehead
note_entry.calc_center_of_primary_notehead(entry)
Calculates the handle offset for an expression with “Center of Primary Notehead” horizontal positioning.
| Input |
Type |
Description |
entry |
FCNoteEntry |
the entry to calculate from |
| Output type |
Description |
number |
offset from left side of primary notehead rectangle |
calc_stem_offset
note_entry.calc_stem_offset(entry)
Calculates the offset of the stem from the left edge of the notehead rectangle. Eventually the PDK Framework may be able to provide this instead.
| Input |
Type |
Description |
entry |
FCNoteEntry |
the entry to calculate from |
| Output type |
Description |
number |
offset of stem from the left edge of the notehead rectangle. |
calc_right_of_all_noteheads
note_entry.calc_right_of_all_noteheads(entry)
Calculates the handle offset for an expression with “Right of All Noteheads” horizontal positioning.
| Input |
Type |
Description |
entry |
FCNoteEntry |
the entry to calculate from |
| Output type |
Description |
number |
offset from left side of primary notehead rectangle |
calc_note_at_index
note_entry.calc_note_at_index(entry, note_index)
This function assumes for note in each(note_entry) always iterates in the same direction.
(Knowing how the Finale PDK works, it probably iterates from bottom to top note.)
Currently the PDK Framework does not seem to offer a better option.
| Input |
Type |
Description |
entry |
FCNoteEntry |
|
note_index |
number |
the zero-based index |
stem_sign
note_entry.stem_sign(entry)
This is useful for many x,y positioning fields in Finale that mirror +/-
based on stem direction.
| Input |
Type |
Description |
entry |
FCNoteEntry |
|
| Output type |
Description |
number |
1 if upstem, -1 otherwise |
duplicate_note
note_entry.duplicate_note(note)
| Input |
Type |
Description |
note |
FCNote |
|
| Output type |
Description |
| `FCNote |
nil` |
delete_note
note_entry.delete_note(note)
Removes the specified FCNote from its associated FCNoteEntry.
| Input |
Type |
Description |
note |
FCNote |
|
| Output type |
Description |
boolean |
true if success |
calc_spans_number_of_octaves
note_entry.calc_spans_number_of_octaves(entry)
Calculates the numer of octaves spanned by a chord (considering only staff positions, not accidentals).
| Input |
Type |
Description |
entry |
FCNoteEntry |
the entry to calculate from |
| Output type |
Description |
number |
of octaves spanned |
add_augmentation_dot
note_entry.add_augmentation_dot(entry)
Adds an augentation dot to the entry. This works even if the entry already has one or more augmentation dots.
| Input |
Type |
Description |
entry |
FCNoteEntry |
the entry to which to add the augmentation dot |
get_next_same_v
note_entry.get_next_same_v(entry)
Returns the next entry in the same V1 or V2 as the input entry.
If the input entry is V2, only the current V2 launch is searched.
If the input entry is V1, only the current measure and layer is searched.
| Input |
Type |
Description |
entry |
FCNoteEntry |
the entry to process |
| Output type |
Description |
FCNoteEntry |
the next entry or nil in none |