api.engraving Style

Provides an access to score style settings. Style settings for a score can be obtained by querying the Score.style property.

Example
let style = curScore.style;
let genClef = style.value("genClef"); // retrieves style setting on clefs generation, true by default
style.setValue("genClef", false); // disables generating clefs for this score

Methods

value(key) → {Variant}

Get the value of style by key. Key should be one of Sid values.

Parameters:
keyString

Key

Returns:

Value. Type of the returned value depends on type of the corresponding style setting.

Type: 
Variant

setValue(key, value)

Sets the value of style setting named key to value. Key should be one of Sid values.

Parameters:
keyString

Key

valueVariant

Value

resetValue(key)

Resets the value of style setting named key to its default. Key should be one of Sid values.

Parameters:
keyString

Key

Since
  • 4.7