Generates a ribbon for the given arguments.
IMPORTANT: If the ribbon generator has been configured with a rendering context, then the ribbon is rendered to this context as a sequence of path method calls and this function returns void.
The "this" context within which this function is invoked, will be the context within which the accessor methods of the generator are invoked. All arguments passed into this function, will be passed to the accessor functions of the generator.
The datum representing the chord for which the ribbon is to be generated.
Rest ...args: any[]Generates a ribbon for the given arguments.
IMPORTANT: If the rendering context of the ribbon generator is null, then the ribbon is returned as a path data string.
The "this" context within which this function is invoked, will be the context within which the accessor methods of the generator are invoked. All arguments passed into this function, will be passed to the accessor functions of the generator.
The datum representing the chord for which the ribbon is to be generated.
Rest ...args: any[]Returns the current rendering context, which defaults to null.
Sets the context and returns this ribbon generator. If the context is not null, then the generated ribbon is rendered to this context as a sequence of path method calls. Otherwise, a path data string representing the generated ribbon is returned. See also d3-path.
Returns the current end angle accessor, which defaults to a function returning the "endAngle" property (assumed to be a number in radians) of the source or target object returned by the source or target accessor, respectively.
Returns the current end angle accessor, which defaults to a function returning the "endAngle" property (assumed to be a number in radians) of the source or target object returned by the source or target accessor, respectively.
Rest ...args: any[]Sets the end angle to a fixed number in radians and returns this ribbon generator.
A fixed numeric value for the end angle in radians.
Sets the end angle accessor to the specified function and returns this ribbon generator.
An accessor function which is invoked for the source and target of the chord. The accessor function is invoked in the same "this" context as the generator was invoked in and receives as the first argument the source or target object returned by the respective source or target accessor function of the generator. It is also passed any additional arguments that were passed into the generator, with the exception of the first element representing the chord datum itself. The function returns the end angle in radians.
Rest ...args: any[]Returns the current pad angle accessor, which defaults to a function returning 0.
Returns the current pad angle accessor, which defaults to a function returning 0.
Rest ...args: any[]Sets the pad angle to a fixed number in radians and returns this ribbon generator.
A fixed numeric value for the pad angle in radians.
Sets the pad angle accessor to the specified function and returns this ribbon generator.
An accessor function which is invoked for the source and target of the chord. The accessor function is invoked in the same "this" context as the generator was invoked in and receives as the first argument the source or target object returned by the respective source or target accessor function of the generator. It is also passed any additional arguments that were passed into the generator, with the exception of the first element representing the chord datum itself. The function returns the pad angle in radians.
Rest ...args: any[]Returns the current radius accessor, which defaults to a function returning the "radius" property (assumed to be a number) of the source or target object returned by the source or target accessor, respectively.
Returns the current radius accessor, which defaults to a function returning the "radius" property (assumed to be a number) of the source or target object returned by the source or target accessor, respectively.
Rest ...args: any[]Sets the radius to a fixed number and returns this ribbon generator.
A fixed numeric value for the radius.
Sets the radius accessor to the specified function and returns this ribbon generator.
An accessor function which is invoked for the source and target of the chord. The accessor function is invoked in the same "this" context as the generator was invoked in and receives as the first argument the source or target object returned by the respective source or target accessor function of the generator. It is also passed any additional arguments that were passed into the generator, with the exception of the first element representing the chord datum itself. The function returns the radius value.
Rest ...args: any[]Returns the current source accessor, which defaults to a function returning the "source" property of the first argument passed into the accessor.
Returns the current source accessor, which defaults to a function returning the "source" property of the first argument passed into the accessor.
Rest ...args: any[]Sets the source accessor to the specified function and returns this ribbon generator.
An accessor function returning the source datum of the chord. The accessor function is invoked in the same "this" context as the generator was invoked in and receives the same arguments that were passed into the ribbon generator.
Rest ...args: any[]Returns the current source radius accessor, which defaults to a function returning the "radius" property (assumed to be a number) of the source or target object returned by the source or target accessor, respectively.
Returns the current source radius accessor, which defaults to a function returning the "radius" property (assumed to be a number) of the source or target object returned by the source or target accessor, respectively.
Rest ...args: any[]Sets the source radius to a fixed number and returns this ribbon generator.
A fixed numeric value for the source radius.
Sets the source radius accessor to the specified function and returns this ribbon generator.
An accessor function which is invoked for the source and target of the chord. The accessor function is invoked in the same "this" context as the generator was invoked in and receives as the first argument the source or target object returned by the respective source or target accessor function of the generator. It is also passed any additional arguments that were passed into the generator, with the exception of the first element representing the chord datum itself. The function returns the source radius value.
Rest ...args: any[]Returns the current start angle accessor, which defaults to a function returning the "startAngle" property (assumed to be a number in radians) of the source or target object returned by the source or target accessor, respectively.
Returns the current start angle accessor, which defaults to a function returning the "startAngle" property (assumed to be a number in radians) of the source or target object returned by the source or target accessor, respectively.
Rest ...args: any[]Sets the start angle to a fixed number in radians and returns this ribbon generator.
A fixed numeric value for the start angle in radians.
Sets the start angle accessor to the specified function and returns this ribbon generator.
An accessor function which is invoked for the source and target of the chord. The accessor function is invoked in the same "this" context as the generator was invoked in and receives as the first argument the source or target object returned by the respective source or target accessor function of the generator. It is also passed any additional arguments that were passed into the generator, with the exception of the first element representing the chord datum itself. The function returns the start angle in radians.
Rest ...args: any[]Returns the current target accessor, which defaults to a function returning the "target" property of the first argument passed into the accessor.
Returns the current target accessor, which defaults to a function returning the "target" property of the first argument passed into the accessor.
Rest ...args: any[]Sets the target accessor to the specified function and returns this ribbon generator.
An accessor function returning the target datum of the chord. The accessor function is invoked in the same "this" context as the generator was invoked in and receives the same arguments that were passed into the ribbon generator.
Rest ...args: any[]Returns the current target radius accessor, which defaults to a function returning the "radius" property (assumed to be a number) of the source or target object returned by the source or target accessor, respectively.
Returns the current target radius accessor, which defaults to a function returning the "radius" property (assumed to be a number) of the source or target object returned by the source or target accessor, respectively.
Rest ...args: any[]Sets the target radius to a fixed number and returns this ribbon generator.
A fixed numeric value for the target radius.
Sets the target radius accessor to the specified function and returns this ribbon generator.
An accessor function which is invoked for the source and target of the chord. The accessor function is invoked in the same "this" context as the generator was invoked in and receives as the first argument the source or target object returned by the respective source or target accessor function of the generator. It is also passed any additional arguments that were passed into the generator, with the exception of the first element representing the chord datum itself. The function returns the target radius value.
Rest ...args: any[]
A ribbon generator to support rendering of chords in a chord diagram.
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 Ribbon.
The third generic corresponds to the datum type of the chord subgroup, i.e. source or target of the cord. The default type is RibbonSubgroup.