Function ribbon

  • Creates a new ribbon generator with the default settings.

    Returns RibbonGenerator<any, Ribbon, RibbonSubgroup>

  • Creates a new ribbon generator with the default settings.

    Accessor functions must be configured for the ribbon generator, should the datum types differ from the defaults.

    The first generic corresponds to the datum type representing a chord for which the ribbon is to be generated. The default type is Chord.

    The second generic corresponds to the datum type of the chord subgroup, i.e. source or target of the cord. The default type is ChordSubgroup.

    Type Parameters

    • Datum

    • SubgroupDatum

    Returns RibbonGenerator<any, Datum, SubgroupDatum>

  • Creates a new ribbon generator with the default settings.

    Accessor functions must be configured for the ribbon generator, should the datum types differ from the defaults.

    The first generic corresponds to the type of the "this" context within which the ribbon generator and its accessor functions will be invoked.

    The second generic corresponds to the datum type representing a chord for which the ribbon is to be generated. The default type is Chord.

    The third generic corresponds to the datum type of the chord subgroup, i.e. source or target of the cord. The default type is ChordSubgroup.

    Type Parameters

    • This

    • Datum

    • SubgroupDatum

    Returns RibbonGenerator<This, Datum, SubgroupDatum>