alphaTab.model.RenderStylesheet

This class represents the rendering stylesheet. It contains settings which control the display of the score when rendered.

 class RenderStylesheet

Properties

barNumberDisplay

Deprecated

Use scoreConfig , tabConfig , slashConfig , or numberedConfig .barNumber for per-staff-type control. The setter broadcasts to all four staff-type entries.

How bar numbers should be displayed score-wide.

JavaScript

barNumberDisplay: BarNumberDisplay;

C#

BarNumberDisplay BarNumberDisplay { get; set; }

Kotlin

var barNumberDisplay: BarNumberDisplay

bracketExtendMode

The mode in which brackets and braces are drawn.

JavaScript

bracketExtendMode: BracketExtendMode;

C#

BracketExtendMode BracketExtendMode { get; set; }

Kotlin

var bracketExtendMode: BracketExtendMode

extendBarLines

Whether barlines should be drawn across staves within the same system.

JavaScript

extendBarLines: boolean;

C#

bool ExtendBarLines { get; set; }

Kotlin

var extendBarLines: Boolean

firstSystemTrackNameMode

The mode what text to display for the track name on the first system

JavaScript

firstSystemTrackNameMode: TrackNameMode;

C#

TrackNameMode FirstSystemTrackNameMode { get; set; }

Kotlin

var firstSystemTrackNameMode: TrackNameMode

firstSystemTrackNameOrientation

The orientation of the the track names on the first system

JavaScript

firstSystemTrackNameOrientation: TrackNameOrientation;

C#

TrackNameOrientation FirstSystemTrackNameOrientation { get; set; }

Kotlin

var firstSystemTrackNameOrientation: TrackNameOrientation

globalDisplayChordDiagramsInScore

Whether to show the chord diagrams in score.

JavaScript

globalDisplayChordDiagramsInScore: boolean;

C#

bool GlobalDisplayChordDiagramsInScore { get; set; }

Kotlin

var globalDisplayChordDiagramsInScore: Boolean

globalDisplayChordDiagramsOnTop

Whether to show the chord diagrams on top.

JavaScript

globalDisplayChordDiagramsOnTop: boolean;

C#

bool GlobalDisplayChordDiagramsOnTop { get; set; }

Kotlin

var globalDisplayChordDiagramsOnTop: Boolean

globalDisplayTuning

Whether to show the tuning.

JavaScript

globalDisplayTuning: boolean;

C#

bool GlobalDisplayTuning { get; set; }

Kotlin

var globalDisplayTuning: Boolean

hideDynamics

Whether dynamics are hidden.

JavaScript

hideDynamics: boolean;

C#

bool HideDynamics { get; set; }

Kotlin

var hideDynamics: Boolean

hideEmptyStaves

Whether to hide empty staves.

JavaScript

hideEmptyStaves: boolean;

C#

bool HideEmptyStaves { get; set; }

Kotlin

var hideEmptyStaves: Boolean

hideEmptyStavesInFirstSystem

Whether to also hide empty staves in the first system. Only has an effect when activating hideEmptyStaves .

JavaScript

hideEmptyStavesInFirstSystem: boolean;

C#

bool HideEmptyStavesInFirstSystem { get; set; }

Kotlin

var hideEmptyStavesInFirstSystem: Boolean

multiTrackMultiBarRest

If multi track: Whether to render multiple subsequent empty (or rest-only) bars together as multi-bar rest.

JavaScript

multiTrackMultiBarRest: boolean;

C#

bool MultiTrackMultiBarRest { get; set; }

Kotlin

var multiTrackMultiBarRest: Boolean

multiTrackTrackNamePolicy

The policy where to show track names when a multiple tracks are rendered.

JavaScript

multiTrackTrackNamePolicy: TrackNamePolicy;

C#

TrackNamePolicy MultiTrackTrackNamePolicy { get; set; }

Kotlin

var multiTrackTrackNamePolicy: TrackNamePolicy

numberedConfig

Score-wide display configuration for the numbered (jianpu) staff.

JavaScript

numberedConfig: NumberedStaffConfig;

C#

NumberedStaffConfig NumberedConfig { get; set; }

Kotlin

var numberedConfig: NumberedStaffConfig

otherSystemsTrackNameMode

The mode what text to display for the track name on the first system

JavaScript

otherSystemsTrackNameMode: TrackNameMode;

C#

TrackNameMode OtherSystemsTrackNameMode { get; set; }

Kotlin

var otherSystemsTrackNameMode: TrackNameMode

otherSystemsTrackNameOrientation

The orientation of the the track names on other systems

JavaScript

otherSystemsTrackNameOrientation: TrackNameOrientation;

C#

TrackNameOrientation OtherSystemsTrackNameOrientation { get; set; }

Kotlin

var otherSystemsTrackNameOrientation: TrackNameOrientation

perTrackChordDiagramsOnTop

Whether to show the chord diagrams on top. (per-track)

JavaScript

perTrackChordDiagramsOnTop: Map<number, boolean> | null;

C#

Map<double, bool>? PerTrackChordDiagramsOnTop { get; set; }

Kotlin

var perTrackChordDiagramsOnTop: alphaTab.collections.DoubleBooleanMap<Double, Boolean>?

perTrackDisplayTuning

Whether to show the tuning.(per-track)

JavaScript

perTrackDisplayTuning: Map<number, boolean> | null;

C#

Map<double, bool>? PerTrackDisplayTuning { get; set; }

Kotlin

var perTrackDisplayTuning: alphaTab.collections.DoubleBooleanMap<Double, Boolean>?

perTrackMultiBarRest

If single track: Whether to render multiple subsequent empty (or rest-only) bars together as multi-bar rest.

JavaScript

perTrackMultiBarRest: Set<number> | null;

C#

Set<double>? PerTrackMultiBarRest { get; set; }

Kotlin

var perTrackMultiBarRest: Set<Double>?

scoreConfig

Score-wide display configuration for the standard-notation staff.

JavaScript

scoreConfig: ScoreStaffConfig;

C#

ScoreStaffConfig ScoreConfig { get; set; }

Kotlin

var scoreConfig: ScoreStaffConfig

showSingleStaffBrackets

Whether to show brackets and braces across single staves. This allows a more consistent view for identifying staves when using hideEmptyStaves

JavaScript

showSingleStaffBrackets: boolean;

C#

bool ShowSingleStaffBrackets { get; set; }

Kotlin

var showSingleStaffBrackets: Boolean

singleTrackTrackNamePolicy

The policy where to show track names when a single track is rendered.

JavaScript

singleTrackTrackNamePolicy: TrackNamePolicy;

C#

TrackNamePolicy SingleTrackTrackNamePolicy { get; set; }

Kotlin

var singleTrackTrackNamePolicy: TrackNamePolicy

slashConfig

Score-wide display configuration for the slash staff.

JavaScript

slashConfig: SlashStaffConfig;

C#

SlashStaffConfig SlashConfig { get; set; }

Kotlin

var slashConfig: SlashStaffConfig

tabConfig

Score-wide display configuration for the tablature staff.

JavaScript

tabConfig: TabStaffConfig;

C#

TabStaffConfig TabConfig { get; set; }

Kotlin

var tabConfig: TabStaffConfig

tuningDisplayMode

The place where tuning information is displayed.

JavaScript

tuningDisplayMode: TuningDisplayMode;

C#

TuningDisplayMode TuningDisplayMode { get; set; }

Kotlin

var tuningDisplayMode: TuningDisplayMode

useSystemSignSeparator

Whether to draw the // sign to separate systems.

JavaScript

useSystemSignSeparator: boolean;

C#

bool UseSystemSignSeparator { get; set; }

Kotlin

var useSystemSignSeparator: Boolean