OpenSheetMusicDisplay
    Preparing search index...

    Interface IRenderNextOptions

    Options for OpenSheetMusicDisplay.renderNext (incremental, "system by system" rendering).

    interface IRenderNextOptions {
        measures?: number;
        systems?: number;
    }
    Index

    Properties

    Properties

    measures?: number

    Target number of visual measures to advance per batch (a multi-rest counts as ONE -- it renders as a single GraphicalMeasure). Defaults to 8. This is a TARGET, not an exact count: a batch always ends on a whole music-system (line) boundary, so the system the measure count lands inside is deferred to the next batch (and a batch always renders at least one whole system). The measures actually drawn may therefore be somewhat fewer or more than this -- e.g. 8 lands part-way into a system, so only the complete systems before it are drawn; or if 8 doesn't fill one system, the layout extends until one whole system is ready. To see what was actually rendered, read the returned IRenderNextResult: renderedMeasures (total visual measures drawn so far, cumulative) and lastRenderedMeasure (the GraphicalMeasures at the last drawn measure position). Ignored when systems is set (and applicable).

    systems?: number

    How many whole music systems (lines) to render in this batch, instead of advancing by measures. Each batch then ends exactly on a system boundary. Takes precedence over measures when > 0. VERTICAL ONLY: a single horizontal staffline (RenderSingleHorizontalStaffline) is one system, so systems is ignored there and rendering falls back to measures.