arlas-d3 / Exports / OneSelectionDonut

Class: OneSelectionDonut

Hierarchy

• AbstractDonut

↳ OneSelectionDonut

Table of contents

Constructors

• constructor

Properties

• arc
• donutContext
• donutDimensions
• donutParams
• donutTooltip
• lastSelectedNode
• x
• y

Methods

• addSelectedNode
• createDonutArcs
• dataChange
• deselectAll
• hoverNode
• initializeDonutDimensions
• onClick
• onMouseLeavesContext
• onMouseOut
• onMouseOver
• onSelectionChange
• plot
• plotDonut
• reapplySelection
• removeAllSimilarNodesOfSameRing
• removeHigherNodes
• removeSelectedNode
• removeUnExistingNodes
• resize
• setTooltipPosition
• showTooltip
• structureDataToNodes
• styleNodes
• tweenNode
• unhoverNodesButNotSelected

Constructors

constructor

• new OneSelectionDonut()

Inherited from

AbstractDonut.constructor

Properties

arc

• Protected arc: Arc<AbstractDonut, DefaultArcObject>

Inherited from

AbstractDonut.arc

Defined in

src/donuts/AbstractDonut.ts:34

---

donutContext

• Protected donutContext: Selection<SVGElement, TreeNode, BaseType, TreeNode>

Inherited from

AbstractDonut.donutContext

Defined in

src/donuts/AbstractDonut.ts:31

---

donutDimensions

• donutDimensions: DonutDimensions

Inherited from

AbstractDonut.donutDimensions

Defined in

src/donuts/AbstractDonut.ts:30

---

donutParams

• donutParams: DonutParams

Inherited from

AbstractDonut.donutParams

Defined in

src/donuts/AbstractDonut.ts:29

---

donutTooltip

• Protected donutTooltip: DonutTooltip

Inherited from

AbstractDonut.donutTooltip

Defined in

src/donuts/AbstractDonut.ts:37

---

lastSelectedNode

• Protected lastSelectedNode: DonutNode = null

Inherited from

AbstractDonut.lastSelectedNode

Defined in

src/donuts/AbstractDonut.ts:33

---

x

• Protected x: ScaleLinear<number, number, never>

Inherited from

AbstractDonut.x

Defined in

src/donuts/AbstractDonut.ts:35

---

y

• Protected y: ScalePower<number, number, never>

Inherited from

AbstractDonut.y

Defined in

src/donuts/AbstractDonut.ts:36

Methods

addSelectedNode

▸ Protected addSelectedNode(clickedNode): void

Description

Add the selected node to selectedArcsList

Parameters

Name	Type	Description
clickedNode	DonutNode	The selected node on the donut

Returns

void

Inherited from

AbstractDonut.addSelectedNode

Defined in

src/donuts/AbstractDonut.ts:160

---

createDonutArcs

▸ Protected createDonutArcs(): void

Description

Creates donuts arcs

Returns

void

Inherited from

AbstractDonut.createDonutArcs

Defined in

src/donuts/AbstractDonut.ts:73

---

dataChange

▸ dataChange(newData): void

Parameters

Name	Type
newData	TreeNode

Returns

void

Overrides

AbstractDonut.dataChange

Defined in

src/donuts/OneSelectionDonut.ts:25

---

deselectAll

▸ Protected deselectAll(): void

Description

Set isSelected attribute to false for all the donut's nodes

Returns

void

Inherited from

AbstractDonut.deselectAll

Defined in

src/donuts/AbstractDonut.ts:253

---

hoverNode

▸ Protected hoverNode(hoveredNode): void

Parameters

Name	Type
hoveredNode	DonutNode

Returns

void

Overrides

AbstractDonut.hoverNode

Defined in

src/donuts/OneSelectionDonut.ts:49

---

initializeDonutDimensions

▸ Protected initializeDonutDimensions(): void

Description

Inialize donuts dimensions

Returns

void

Inherited from

AbstractDonut.initializeDonutDimensions

Defined in

src/donuts/AbstractDonut.ts:86

---

onClick

▸ Protected onClick(event, clickedNode): void

Parameters

Name	Type
event	PointerEvent
clickedNode	DonutNode

Returns

void

Overrides

AbstractDonut.onClick

Defined in

src/donuts/OneSelectionDonut.ts:58

---

onMouseLeavesContext

▸ Protected onMouseLeavesContext(): void

Returns

void

Inherited from

AbstractDonut.onMouseLeavesContext

Defined in

src/donuts/AbstractDonut.ts:347

---

onMouseOut

▸ Protected onMouseOut(): void

Returns

void

Inherited from

AbstractDonut.onMouseOut

Defined in

src/donuts/AbstractDonut.ts:340

---

onMouseOver

▸ Protected onMouseOver(event, hoveredNode): void

Parameters

Name	Type
event	MouseEvent
hoveredNode	DonutNode

Returns

void

Inherited from

AbstractDonut.onMouseOver

Defined in

src/donuts/AbstractDonut.ts:317

---

onSelectionChange

▸ onSelectionChange(selectedArcsList): void

Parameters

Name	Type
selectedArcsList	SimpleNode[][]

Returns

void

Overrides

AbstractDonut.onSelectionChange

Defined in

src/donuts/OneSelectionDonut.ts:37

---

plot

▸ plot(): void

Description

Plots the donut

Returns

void

Inherited from

AbstractDonut.plot

Defined in

src/donuts/AbstractDonut.ts:45

---

plotDonut

▸ Protected plotDonut(): void

Description

Draws the donuts arcs

Returns

void

Inherited from

AbstractDonut.plotDonut

Defined in

src/donuts/AbstractDonut.ts:136

---

reapplySelection

▸ Protected reapplySelection(): void

Description

Set isSelected attribute to true giving the selectedArcsList

Returns

void

Inherited from

AbstractDonut.reapplySelection

Defined in

src/donuts/AbstractDonut.ts:262

---

removeAllSimilarNodesOfSameRing

▸ Protected removeAllSimilarNodesOfSameRing(selectedArc): void

Description

REMOVES ALL THE NODES OF SAME RING HAVING THE SAME VALUE FROM THE SELECTEDARCSLIST,

Parameters

Name	Type	Description
selectedArc	SimpleNode[]	Path from the selected arc to the ultimate parent (as an array)

Returns

void

Inherited from

AbstractDonut.removeAllSimilarNodesOfSameRing

Defined in

src/donuts/AbstractDonut.ts:237

---

removeHigherNodes

▸ Protected removeHigherNodes(clickedNode): void

Description

Removes from selectArcsList all the parent nodes of the clicked node that are selected

Parameters

Name	Type	Description
clickedNode	DonutNode	The selected/unselected node of the donut

Returns

void

Inherited from

AbstractDonut.removeHigherNodes

Defined in

src/donuts/AbstractDonut.ts:198

---

removeSelectedNode

▸ Protected removeSelectedNode(clickedNode): void

Description

Removes the selected node from selectedArcsList

Parameters

Name	Type	Description
clickedNode	DonutNode	The unselected node from the donut

Returns

void

Inherited from

AbstractDonut.removeSelectedNode

Defined in

src/donuts/AbstractDonut.ts:178

---

removeUnExistingNodes

▸ Protected removeUnExistingNodes(): void

Description

Removes the unexisting nodes in the donut from the selectedArcsList

Returns

void

Inherited from

AbstractDonut.removeUnExistingNodes

Defined in

src/donuts/AbstractDonut.ts:221

---

resize

▸ resize(donutContainer): void

Description

Resizes donut on window resize event.

Parameters

Name	Type
donutContainer	HTMLElement

Returns

void

Inherited from

AbstractDonut.resize

Defined in

src/donuts/AbstractDonut.ts:58

---

setTooltipPosition

▸ Protected setTooltipPosition(event): void

Parameters

Name	Type
event	any

Returns

void

Inherited from

AbstractDonut.setTooltipPosition

Defined in

src/donuts/AbstractDonut.ts:359

---

showTooltip

▸ Protected showTooltip(node): void

Parameters

Name	Type
node	DonutNode

Returns

void

Inherited from

AbstractDonut.showTooltip

Defined in

src/donuts/AbstractDonut.ts:351

---

structureDataToNodes

▸ Protected structureDataToNodes(): void

Description

Transforms input data to d3 nodes

Returns

void

Inherited from

AbstractDonut.structureDataToNodes

Defined in

src/donuts/AbstractDonut.ts:109

---

styleNodes

▸ Protected styleNodes(): void

Description

Styles the nodes according to their states

Returns

void

Inherited from

AbstractDonut.styleNodes

Defined in

src/donuts/AbstractDonut.ts:274

---

tweenNode

▸ Protected tweenNode(node, duration): void

Description

Apply animation after clicking on the node.

Parameters

Name	Type	Description
node	DonutNode	Clicked on node
duration	number	Duration of the animation

Returns

void

Inherited from

AbstractDonut.tweenNode

Defined in

src/donuts/AbstractDonut.ts:302

---

unhoverNodesButNotSelected

▸ Protected unhoverNodesButNotSelected(): void

Returns

void

Overrides

AbstractDonut.unhoverNodesButNotSelected

Defined in

src/donuts/OneSelectionDonut.ts:54