OpenSheetMusicDisplay
    Preparing search index...

    Interface IRenderNextResult

    Progress returned by OpenSheetMusicDisplay.renderNext. Measure counts are visual (a multi-rest counts as one).

    interface IRenderNextResult {
        done: boolean;
        lastRenderedMeasure: GraphicalMeasure[];
        nextUnrenderedMeasure: GraphicalMeasure[];
        renderedMeasures: number;
        totalMeasures: number;
    }
    Index

    Properties

    done lastRenderedMeasure nextUnrenderedMeasure renderedMeasures totalMeasures

    Properties

    done: boolean

    True once the last measure of the sheet has been rendered -- no more batches remain.

    lastRenderedMeasure: GraphicalMeasure[]

    The last measure position rendered so far (highest measure index): all its GraphicalMeasures, one per staff/instrument (e.g. 3 for a voice + piano score). Empty if nothing has been rendered yet. They share one source measure -- reach it and its number/index via any element's .parentSourceMeasure and .parentSourceMeasure.measureListIndex (0-based).

    nextUnrenderedMeasure: GraphicalMeasure[]

    The next measure position not yet rendered (the frontier): all its GraphicalMeasures (one per staff), or empty once done. Same .parentSourceMeasure / .parentSourceMeasure.measureListIndex accessors.

    renderedMeasures: number

    Visual measures rendered so far, cumulative across batches.

    totalMeasures: number

    Total visual measures in the sheet.

    Settings

    Member Visibility

    On This Page

    Properties