@types/d3-chord

property source

source: ChordSubgroup;

• Chord subgroup constituting the source of Chord

property target

target: ChordSubgroup;

• Chord subgroup constituting the Target of Chord

property endAngle

endAngle: number;

• The end angle of the chord group in radians

property index

index: number;

• The node index i

property startAngle

startAngle: number;

• The start angle of the chord group in radians

property value

value: number;

• The total outgoing flow value for node i

method padAngle

padAngle: { (): number; (angle: number): this };

• Returns the current pad angle in radians, which defaults to zero.

• Sets the pad angle between adjacent groups to the specified number in radians and returns this chord layout.

  The default is zero.

  Parameter angle

  Pad angle between adjacent groups in radians.

method sortChords

sortChords: {
    (): (a: number, b: number) => number;
    (compare: (a: number, b: number) => number): this;
};

• Returns the current chord comparator, which defaults to null.

• Sets the chord comparator to the specified function or null and returns this chord layout. If the chord comparator is non-null, it is used to sort the chords by their combined flow; this only affects the z-order of the chords. See also d3.ascending and d3.descending.

method sortGroups

sortGroups: {
    (): (a: number, b: number) => number;
    (compare: (a: number, b: number) => number): this;
};

• Returns the current group comparator, which defaults to null.

• Sets the group comparator to the specified function or null and returns this chord layout. If the group comparator is non-null, it is used to sort the groups by their total outflow. See also d3.ascending and d3.descending.

method sortSubgroups

sortSubgroups: {
    (): (a: number, b: number) => number;
    (compare: (a: number, b: number) => number): this;
};

• Returns the current subgroup comparator, which defaults to null.

• Sets the subgroup comparator to the specified function or null and returns this chord layout. If the subgroup comparator is non-null, it is used to sort the subgroups corresponding to matrix[i][0 … n - 1] for a given group i by their total outflow. See also d3.ascending and d3.descending.

call signature

(matrix: number[][]): Chords;

• Computes the chord layout for the specified square matrix of size n×n, where the matrix represents the directed flow amongst a network (a complete digraph) of n nodes.

  Parameter matrix

  An (n x n) matrix representing the directed flow amongst a network (a complete digraph) of n nodes.The given matrix must be an array of length n, where each element matrix[i] is an array of n numbers, where each matrix[i][j] represents the flow from the ith node in the network to the jth node. Each number matrix[i][j] must be nonnegative, though it can be zero if there is no flow from node i to node j.

property groups

groups: ChordGroup[];

• An array of length n, where each group represents the combined outflow for node i, corresponding to the elements matrix[i][0 … n - 1]

property endAngle

endAngle: number;

• * End angle of the chord subgroup in radians

property index

index: number;

• The node index i

property startAngle

startAngle: number;

• Start angle of the chord subgroup in radians

property value

value: number;

• The flow value in matrix[i][j] from node i to node j

property source

source: RibbonSubgroup;

• Ribbon subgroup constituting the source of the Ribbon

property target

target: RibbonSubgroup;

• Ribbon subgroup constituting the target of the Ribbon

method headRadius

headRadius: {
    (): (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number;
    (radius: number): this;
    (
        radius: (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number
    ): this;
};

method context

context: {
    (): CanvasRenderingContext2D | null;
    (context: CanvasRenderingContext2D): this;
};

• 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.

method endAngle

endAngle: {
    (): (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number;
    (angle: number): this;
    (
        angle: (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number
    ): this;
};

• 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.

• Sets the end angle to a fixed number in radians and returns this ribbon generator.

  Parameter angle

  A fixed numeric value for the end angle in radians.

• Sets the end angle accessor to the specified function and returns this ribbon generator.

  Parameter angle

  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.

method padAngle

padAngle: {
    (): (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number;
    (angle: number): this;
    (
        angle: (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number
    ): this;
};

• Returns the current pad angle accessor, which defaults to a function returning 0.

• Sets the pad angle to a fixed number in radians and returns this ribbon generator.

  Parameter angle

  A fixed numeric value for the pad angle in radians.

• Sets the pad angle accessor to the specified function and returns this ribbon generator.

  Parameter angle

  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.

method radius

radius: {
    (): (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number;
    (radius: number): this;
    (
        radius: (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number
    ): this;
};

• 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.

• Sets the radius to a fixed number and returns this ribbon generator.

  Parameter radius

  A fixed numeric value for the radius.

• Sets the radius accessor to the specified function and returns this ribbon generator.

  Parameter radius

  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.

method source

source: {
    (): (this: This, d: RibbonDatum, ...args: any[]) => RibbonSubgroupDatum;
    (
        source: (
            this: This,
            d: RibbonDatum,
            ...args: any[]
        ) => RibbonSubgroupDatum
    ): this;
};

• Returns the current source accessor, which defaults to a function returning the "source" property of the first argument passed into the accessor.

• Sets the source accessor to the specified function and returns this ribbon generator.

  Parameter source

  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.

method sourceRadius

sourceRadius: {
    (): (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number;
    (radius: number): this;
    (
        radius: (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number
    ): this;
};

• 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.

• Sets the source radius to a fixed number and returns this ribbon generator.

  Parameter radius

  A fixed numeric value for the source radius.

• Sets the source radius accessor to the specified function and returns this ribbon generator.

  Parameter radius

  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.

method startAngle

startAngle: {
    (): (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number;
    (angle: number): this;
    (
        angle: (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number
    ): this;
};

• 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.

• Sets the start angle to a fixed number in radians and returns this ribbon generator.

  Parameter angle

  A fixed numeric value for the start angle in radians.

• Sets the start angle accessor to the specified function and returns this ribbon generator.

  Parameter angle

  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.

method target

target: {
    (): (this: This, d: RibbonDatum, ...args: any[]) => RibbonSubgroupDatum;
    (
        target: (
            this: This,
            d: RibbonDatum,
            ...args: any[]
        ) => RibbonSubgroupDatum
    ): this;
};

• Returns the current target accessor, which defaults to a function returning the "target" property of the first argument passed into the accessor.

• Sets the target accessor to the specified function and returns this ribbon generator.

  Parameter target

  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.

method targetRadius

targetRadius: {
    (): (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number;
    (radius: number): this;
    (
        radius: (this: This, d: RibbonSubgroupDatum, ...args: any[]) => number
    ): this;
};

• 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.

• Sets the target radius to a fixed number and returns this ribbon generator.

  Parameter radius

  A fixed numeric value for the target radius.

• Sets the target radius accessor to the specified function and returns this ribbon generator.

  Parameter radius

  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.

call signature

(this: This, d: RibbonDatum, ...args: any[]): void;

• 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.

  Parameter d

  The datum representing the chord for which the ribbon is to be generated.

call signature

(this: This, d: RibbonDatum, ...args: any[]): string | null;

• 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.

  Parameter d

  The datum representing the chord for which the ribbon is to be generated.

property endAngle

endAngle: number;

• End angle of the ribbon subgroup in radians

property radius

radius: number;

• Radius of the ribbon subgroup

property startAngle

startAngle: number;

• Start angle of the ribbon subgroup in radians