D3HierarchyGraph | UI Widget Toolkit

Hierarchy

D3ConnectedGraphSVG
- D3HierarchyGraph

Index

Constructors

constructor

Object literals

Constructors

constructor

new D3HierarchyGraph(element: UIElement, renderer: D3Renderer, parent: Selection<any, any, d3.BaseType, any>): D3HierarchyGraph

Overrides D3ConnectedGraphSVG.constructor
- Defined in core/connected-graph/hierarchy.ts:47
Parameters
- element: UIElement
- renderer: D3Renderer
- parent: Selection<any, any, d3.BaseType, any>
Returns D3HierarchyGraph

Properties

Protected DEFAULT_GRAPH_HEIGHT

DEFAULT_GRAPH_HEIGHT: number

Protected _backgroundSVG

_backgroundSVG: Selection<d3.BaseType, __type, d3.BaseType, any>

the svg that contains the chart

_brush

_brush: Brush

_brushTooltip

_brushTooltip: OneLineTooltip

Protected _colorMgr

_colorMgr: ColorManager

_contextMenuItems

_contextMenuItems: IContextMenuItem[]

_dataTooltip

_dataTooltip: CustomDivTooltip

Protected _decimator

_decimator: IGraphNodeDecimator

cache the decimator used for this graph

Protected _element

_element: UIElement

the original user defined element

Protected _fillColors

_fillColors: any = new WeakMap<Object, string>()

stores the original fill colors for an series

_graphContainer

_graphContainer: any

Protected _graphRect

_graphRect: Rect

The width of the graph. This EXCLUDES the margins.

Protected _handleWidth

_handleWidth: number

width of any graph handles

Protected _interactionState

_interactionState: InteractionState

Protected _margin

_margin: number

Protected _maxGraphWidth

_maxGraphWidth: number

Protected _maxSvgWidth

_maxSvgWidth: number

Protected _minSvgWidth

_minSvgWidth: number

Protected _nodes

_nodes: any

Protected _options

_options: IOptions

Protected _padding

_padding: number

Protected _parent

_parent: Selection<any, any, d3.BaseType, any>

Protected _renderOrigin

_renderOrigin: object

this is where the elements are going to appear from relative from in the SVG

Type declaration

x: number
y: number

Protected _renderer

_renderer: UIRenderer

the parent renderer of this renderer

Protected _requiresRelayout

_requiresRelayout: boolean

indicates we need to relayout the existing graph

Protected _strokeColors

_strokeColors: any = new WeakMap<Object, string>()

stores the original stroke colors for an series

Protected _svg

_svg: Selection<d3.BaseType, __type, d3.BaseType, any>

the svg that contains the chart

Protected _svgRect

_svgRect: Rect

The height of the graph. This INCLUDES the margins.

_tooltipAnalyticsName

_tooltipAnalyticsName: string

_tooltipId

_tooltipId: string

_zoom

_zoom: ZoomBehavior<Element, __type>

configureZoom

configureZoom: function

Type declaration

- (xExtent: number[], yExtent: number[], height: number, width: number): void
- Parameters
  - xExtent: number[]
  - yExtent: number[]
  - height: number
  - width: number
  Returns void

getElbowLinkPath

getElbowLinkPath: function

Type declaration

- (link: IRenderedDiagramLink, fromXY: IXYValue, toXY: IXYValue): any[]
- Parameters
  - link: IRenderedDiagramLink
  - fromXY: IXYValue
  - toXY: IXYValue
  Returns any[]

getLinkEndXY

getLinkEndXY: function

get the xy position of the end of the link

Type declaration

- (link: IRenderedDiagramLink): IXYValue
- Parameters
  - link: IRenderedDiagramLink
  Returns IXYValue

getLinkStartXY

getLinkStartXY: function

get the xy position of the start of the link

Type declaration

- (link: IRenderedDiagramLink): IXYValue
- Parameters
  - link: IRenderedDiagramLink
  Returns IXYValue

hoverEnd

hoverEnd: function

Type declaration

- (): void
- Returns void

linkHoverStart

linkHoverStart: function

Type declaration

- (): void
- Returns void

nodeHoverStart

nodeHoverStart: function

Type declaration

- (): void
- Returns void

onHoverChanged

onHoverChanged: function

Type declaration

- (event?: IEvent): void
- Parameters
  - Optional event: IEvent
  Returns void

Static CHILDREN

CHILDREN: string[] = ['top', 'bottom', 'left', 'right', 'center']

helper function to traverse the node trees. Walks over the top/bottom/left/right/center children arrays and applies the callback function to those nodes

Static IS_RESIZING

IS_RESIZING: boolean

used to disable cross graph calls when in redraw mode

Methods

_focus

_focus(selection: any): void

Inherited from SVGRenderer._focus
- Defined in core/svg-helper.ts:1092
Parameters
- selection: any
Returns void

_select

_select(selection: any): void

Inherited from SVGRenderer._select
- Defined in core/svg-helper.ts:1114
Parameters
- selection: any
Returns void

_unfocus

_unfocus(selection: any): void

Inherited from SVGRenderer._unfocus
- Defined in core/svg-helper.ts:1103
Parameters
- selection: any
Returns void

_unselect

_unselect(selection: any): void

Inherited from SVGRenderer._unselect
- Defined in core/svg-helper.ts:1125
Parameters
- selection: any
Returns void

Protected bindZoom

bindZoom(): void

Inherited from D3ConnectedGraphSVG.bindZoom
- Defined in core/connected-graph/base.ts:710
Returns void

brush

brush(event: IEvent): void

Inherited from SVGRenderer.brush
- Defined in core/svg-helper.ts:900
Parameters
- event: IEvent
Returns void

Protected configureContextMenu

configureContextMenu(): void

Inherited from D3ConnectedGraphSVG.configureContextMenu
- Defined in core/connected-graph/base.ts:741
Returns void

Protected configureItemHover

configureItemHover(elem: any, node: IRenderedDiagramNode): void

- Defined in core/connected-graph/hierarchy.ts:647
configure the hover requirements for a node

Parameters
- elem: any
- node: IRenderedDiagramNode
Returns void

Protected configureLinkHover

configureLinkHover(elem: any, link: IRenderedDiagramLink): void

Inherited from D3ConnectedGraphSVG.configureLinkHover
- Defined in core/connected-graph/base.ts:785
configure the hover requirements for a node

Parameters
- elem: any
- link: IRenderedDiagramLink
Returns void

Protected configureTooltip

configureTooltip(): void

Inherited from SVGRenderer.configureTooltip
- Defined in core/svg-helper.ts:902
Returns void

Protected configureView

configureView(): void

Inherited from D3ConnectedGraphSVG.configureView
- Defined in core/connected-graph/base.ts:940
Returns void

createHandles

createHandles(): void

Inherited from SVGRenderer.createHandles
- Defined in core/svg-helper.ts:1170
Returns void

createImage

createImage(): Promise<any>

Inherited from SVGRenderer.createImage
- Defined in core/svg-helper.ts:1253
Returns Promise<any>

createLayout

createLayout(): void

Inherited from SVGRenderer.createLayout
- Defined in core/svg-helper.ts:903
Returns void

cursorChange

cursorChange(event: IEvent): void

Inherited from SVGRenderer.cursorChange
- Defined in core/svg-helper.ts:898
Parameters
- event: IEvent
Returns void

focus

focus(event: IEvent): void

Inherited from SVGRenderer.focus
- Defined in core/svg-helper.ts:1073
bring an item into focus

Parameters
- event: IEvent
  
  the event to focus on
Returns void

getAnimateDuration

getAnimateDuration(): number

Inherited from SVGRenderer.getAnimateDuration
- Defined in core/svg-helper.ts:1032
Returns number

getColorManager

getColorManager(): ColorManager

Inherited from UIElementRenderer.getColorManager
- Defined in core/renderer.ts:38
get the colors the renderer is using for the given element

Returns ColorManager

getElement

getElement(): UIElement

Inherited from SVGRenderer.getElement
- Defined in core/svg-helper.ts:1025
Returns UIElement

Protected getHeightWidth

getHeightWidth(options: IOptions): void

Inherited from D3ConnectedGraphSVG.getHeightWidth
- Defined in core/connected-graph/base.ts:925
Parameters
- options: IOptions
Returns void

getOptions

getOptions(): IOptions

Inherited from SVGRenderer.getOptions

Overrides UIElementRenderer.getOptions
- Defined in core/svg-helper.ts:1028
Returns IOptions

getRenderedCss

getRenderedCss(): Css

Inherited from SVGRenderer.getRenderedCss
- Defined in core/svg-helper.ts:1045
Get the css actually rendered. This is useful for legend swatches and the like.

Returns Css

The css rendered, or undefined if called before the chart is rendered

getTooltipData

getTooltipData(event: IEvent): any

Inherited from SVGRenderer.getTooltipData
- Defined in core/svg-helper.ts:1054
tooltip the element.

Parameters
- event: IEvent
  
  the event to pass to the renderer
Returns any

hover

hover(event: IEvent): void

Inherited from SVGRenderer.hover
- Defined in core/svg-helper.ts:1064
deprecated

('Deprecated since 1.14.0 in favor of focus. Will be removed in 2.x') hover event

Parameters
- event: IEvent
  
  the event to pass to the renderer
Returns void

Protected initialize

initialize(element: UIElement, renderer: UIRenderer, parent: Selection<any, any, d3.BaseType, any>): void

Inherited from SVGRenderer.initialize
- Defined in core/svg-helper.ts:974
Parameters
- element: UIElement
- renderer: UIRenderer
- parent: Selection<any, any, d3.BaseType, any>
Returns void

initializeGraphArea

initializeGraphArea(options: IOptions): Selection<SVGGElement, __type, Element | Document | EnterElement | Window, any>

Inherited from D3ConnectedGraphSVG.initializeGraphArea
- Defined in core/connected-graph/base.ts:771
Parameters
- options: IOptions
Returns Selection<SVGGElement, __type, Element | Document | EnterElement | Window, any>

Protected initializeLinkLayer

initializeLinkLayer(graphArea: Selection<any, any, d3.BaseType, any>): void

Inherited from D3ConnectedGraphSVG.initializeLinkLayer
- Defined in core/connected-graph/base.ts:798
Parameters
- graphArea: Selection<any, any, d3.BaseType, any>
Returns void

invalidate

invalidate(options: IOptions): void

Inherited from SVGRenderer.invalidate
- Defined in core/svg-helper.ts:1136
Parameters
- options: IOptions
Returns void

Protected loadOptions

loadOptions(options: IOptions): void

Inherited from SVGRenderer.loadOptions
- Defined in core/svg-helper.ts:1000
Parameters
- options: IOptions
Returns void

render

render(options: IOptions): void

Overrides SVGRenderer.render
- Defined in core/connected-graph/hierarchy.ts:1088
render the hierarchical graph

Parameters
- options: IOptions
Returns void

Protected renderLegend

renderLegend(graphHeight?: number): number

Inherited from D3ConnectedGraphSVG.renderLegend
- Defined in core/connected-graph/base.ts:644
Parameters
- Optional graphHeight: number
Returns number

Protected renderLinkHelper

renderLinkHelper(graphArea: Selection<any, any, d3.BaseType, any>, renderedLinks: IRenderedDiagramLink[], isUpdate?: boolean): void

Inherited from D3ConnectedGraphSVG.renderLinkHelper
- Defined in core/connected-graph/base.ts:805
Parameters
- graphArea: Selection<any, any, d3.BaseType, any>
- renderedLinks: IRenderedDiagramLink[]
- Optional isUpdate: boolean
Returns void

saveImage

saveImage(): void

Inherited from SVGRenderer.saveImage
- Defined in core/svg-helper.ts:1356
Returns void

select

select(event: IEvent): void

Inherited from SVGRenderer.select
- Defined in core/svg-helper.ts:1082
select an item

Parameters
- event: IEvent
  
  the event to focus on
Returns void

setColorManager

setColorManager(colorManager: ColorManager): void

Inherited from SVGRenderer.setColorManager

Overrides UIElementRenderer.setColorManager
- Defined in core/svg-helper.ts:970
Parameters
- colorManager: ColorManager
Returns void

updateHandles

updateHandles(): void

Inherited from SVGRenderer.updateHandles
- Defined in core/svg-helper.ts:1149
Returns void

zoom

zoom(event: IEvent): void

Inherited from SVGRenderer.zoom
- Defined in core/svg-helper.ts:899
Parameters
- event: IEvent
Returns void

Static isNodeRendered

isNodeRendered(renderedNode: IRenderedDiagramNode): Selection<any, any, Element | Document | EnterElement | Window, any>

- Defined in core/connected-graph/hierarchy.ts:136
Parameters
- renderedNode: IRenderedDiagramNode
Returns Selection<any, any, Element | Document | EnterElement | Window, any>

Object literals

Protected AXIS_PADDING

AXIS_PADDING: object

X

X: number = 10

Y

Y: object

BOTTOM

BOTTOM: number = 10

TOP

TOP: number = 10

Protected LEGEND_PADDING

LEGEND_PADDING: object

X

X: number = 10

Y

Y: object

BOTTOM

BOTTOM: number = 10

TOP

TOP: number = 10

Protected MIN_MARGIN

MIN_MARGIN: object

BOTTOM

BOTTOM: number = 10

LEFT

LEFT: number = 0

RIGHT

RIGHT: number = 10

TOP

TOP: number = 0

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

element: UIElement

renderer: D3Renderer

parent: Selection<any, any, d3.BaseType, any>

Returns D3HierarchyGraph

Properties

Protected DEFAULT_GRAPH_HEIGHT

Protected _backgroundSVG

_brush

_brushTooltip

Protected _colorMgr

_contextMenuItems

_dataTooltip

Protected _decimator

Protected _element

Protected _fillColors

_graphContainer

Protected _graphRect

Protected _handleWidth

Protected _interactionState

Protected _margin

Protected _maxGraphWidth

Protected _maxSvgWidth

Protected _minSvgWidth

Protected _nodes

Protected _options

Protected _padding

Protected _parent

Protected _renderOrigin

Type declaration

x: number

y: number

Protected _renderer

Protected _requiresRelayout

Protected _strokeColors

Protected _svg

Protected _svgRect

_tooltipAnalyticsName

_tooltipId

_zoom

configureZoom

Type declaration

Parameters

xExtent: number[]

yExtent: number[]

height: number

width: number

Returns void

getElbowLinkPath

Type declaration

Parameters

link: IRenderedDiagramLink

fromXY: IXYValue

toXY: IXYValue

Returns any[]

getLinkEndXY

Type declaration

Parameters

link: IRenderedDiagramLink

Returns IXYValue

getLinkStartXY

Type declaration

Parameters

link: IRenderedDiagramLink

Returns IXYValue

hoverEnd

Type declaration

Returns void

linkHoverStart

Type declaration

Returns void

nodeHoverStart