Skip to content

arlas-d3 / Exports / DonutParams

Class: DonutParams

Table of contents

Constructors

Properties

Constructors

constructor

• new DonutParams()

Properties

colorsSaturationWeight

• colorsSaturationWeight: number

Description

Knowing that saturation scale is [0, 1], colorsSaturationWeight is a factor (between 0 and 1) that tightens this scale to [(1-colorsSaturationWeight), 1]. Therefore colors saturation of donuts arcs will be within this tightened scale..

Defined in

src/donuts/DonutParams.ts:106

containerWidth

• containerWidth: number

Defined in

src/donuts/DonutParams.ts:116

customizedCssClass

• customizedCssClass: any

Description

Css class name to use to customize a specific powerbar's style.

Defined in

src/donuts/DonutParams.ts:44

diameter

• diameter: number

Dimensions

Defined in

src/donuts/DonutParams.ts:115

donutContainer

• donutContainer: HTMLElement

Description

The div element that wraps the donut component.

Defined in

src/donuts/DonutParams.ts:96

donutData

• donutData: TreeNode

Description

Data displayed on the donut. Each node's size must be specified

Defined in

src/donuts/DonutParams.ts:34

donutNodeColorizer

• donutNodeColorizer: ColorGenerator

Description

an object that implements ColorGenerator interface.

Defined in

src/donuts/DonutParams.ts:110

donutNodes

• donutNodes: DonutNode[]

Description

D3 nodes diplayed on the donut.

Defined in

src/donuts/DonutParams.ts:88

hoveredNodeTooltipEvent

• hoveredNodeTooltipEvent: Subject<DonutTooltip>

Deprecated

Description

Emits the tooltip of the hovered node.

Defined in

src/donuts/DonutParams.ts:73

hoveredNodesEvent

• hoveredNodesEvent: Subject<Map<string, string>>

Description

Emits the hovered node and the path to it's parents. The key of the map is the node's name and the value is its color on the donut.

Defined in

src/donuts/DonutParams.ts:67

id

• id: any

Description

Id of the donut.

Defined in

src/donuts/DonutParams.ts:29

keysToColors

• keysToColors: [string, string][]

Description

List of [key, color] couples that associates a hex color to each key

Defined in

src/donuts/DonutParams.ts:100

multiselectable

• multiselectable: boolean = true

Description

Whether the donut is multi-selectable.

Defined in

src/donuts/DonutParams.ts:55

numberFormatChar

• numberFormatChar: string = ''

Defined in

src/donuts/DonutParams.ts:112

opacity

• opacity: number = 0.4

Description

Sets the opacity of non-hovered or non-selected nodes.

Defined in

src/donuts/DonutParams.ts:39

selectedArcsList

• selectedArcsList: { fieldName: string ; fieldValue: string }[][]

Description

List of selected nodes.

Defined in

src/donuts/DonutParams.ts:49

selectedNodesEvent

• selectedNodesEvent: Subject<{ fieldName: string ; fieldValue: string }[][]>

Description

Emits the list of selected nodes and the paths to their ultimate parent

Defined in

src/donuts/DonutParams.ts:60

svgElement

• svgElement: SVGElement

Description

The SVG element that's the donut is built on.

Defined in

src/donuts/DonutParams.ts:92

tooltip

• tooltip: ARLASDonutTooltip = {}

Description

Tooltip displayed when a node is hovered.

Defined in

src/donuts/DonutParams.ts:83

tooltipEvent

• tooltipEvent: Subject<ARLASDonutTooltip>

Description

Emits the tooltip of the hovered node.

Defined in

src/donuts/DonutParams.ts:78