import BoxedTree from 'd3-mitch-tree/js/BoxedTree.js'

public class | source

BoxedTree

Extends:

events~EventEmitter → BaseTree → BoxedTree

Constructor Summary

Public Constructor
public	constructor(options: object)

Member Summary

Public Members
public	nodeSettings: *

Private Members
private	_getBodyDisplayText: *
private	_getTitleDisplayText: *

Method Summary

Public Methods
public	centerNode(nodeDataItem: ):
public	getBodyDisplayText(nodeDataItem: object): string Gets the body display text for a given data item.
public	getTitleDisplayText(nodeDataItem: object): string Gets the title display text for a given data item.
public	initialize(): *
public	setBodyDisplayTextAccessor(newBodyDisplayTextAccessor: bodyDisplayTextAccessorCallBack): * Sets the body display text accessor, used to get the body display text for the nodes.
public	setTitleDisplayTextAccessor(newTitleDisplayTextAccessor: titleDisplayTextAccessorCallBack): * Sets the title display text accessor, used to get the title display text for the nodes.
public	validateSettings(): *

Private Methods
private	_getLinkPathGenerator(): *
private	_getNodeSize(): undefined[]
private	_linkEnter(source: , linkEnter: , links: , linkPathGenerator: ): *
private	_linkExit(source: , linkExit: , linkExitTransition: , links: , linkPathGenerator: ):
private	_linkUpdate(source: , linkUpdate: , linkUpdateTransition: , links: , linkPathGenerator: ):
private	_nodeEnter(nodeEnter: , nodes: ): *
private	_nodeExit(nodeExit: , nodeExitTransition: , nodes: ):
private	_nodeUpdate(nodeUpdate: , nodeUpdateTransition: , nodes: ):

Inherited Summary

From class BaseTree
public	loadOnDemandSettings: *
public	nodeSettings: *
private	_allowFocus: *
private	_allowNodeCentering: *
private	_allowPan: *
private	_allowZoom: *
private	_data: *
private	_duration: *
private	_element: *
private	_getChildren: *
private	_getId: *
private	_getParentId: *
private	_heightWithoutMargin: *
private	_isFlatData: *
private	_linkPathGenerator: *
private	_links: *
private	_margins: *
private	_maxScale: *
private	_minScale: *
private	_nodeDepthMultiplier: *
private	_nodes: undefined[]
private	_orientation: *
private	_panningContainer: *
private	_root: *
private	_svg: *
private	_theme: *
private	_treeGenerator: *
private	_view: *
private	_visibleNodes: *
private	_widthWithoutMargin: *
private	_zoomListener: *
public	centerNode(nodeDataItem: *): object Center the view to a D3 tree node.
public	collapse(nodeDataItem: object): object Collapses the given node data item.
public	collapseRecursively(nodeDataItem: object): object Collapses the given node data item, and its children and descendants.
public	expand(nodeDataItem: object): object Expands the given node data item.
public	expandRecursively(nodeDataItem: object): object Expands the given node data item, and its children and descendants.
public	focusToNode(idOrNodeDataItem: *): object Focuses and expands all the way through to a node.
public	getAllowFocus(): boolean Gets the boolean value indicating whether to focus to the clicked node or not.
public	getAllowNodeCentering(): boolean Gets the boolean value indicating whether to pan to a clicked node.
public	getAllowPan(): boolean Gets the boolean value indicating whether the drag-to-pan pan feature is enabled or not.
public	getAllowZoom(): boolean Gets the boolean value indicating whether the mouse wheel to zoom in/out feature is enabled or not.
public	getChildren(dataItem: object): object[] Gets the children data items for a given data item.
public	getData(): object[] Gets the data items used to render the nodes.
public	getDataItem(id: *): object Get a single data item given an id.
public	getDuration(): number Gets the duration of animations for the tree.
public	getElement(): object Gets the container DOM element.
public	getHeight(): number Gets the height of SVG, including the margins.
public	getHeightWithoutMargins(): number Gets the height of the SVG for the tree diagram.
public	getId(dataItem: object): * Gets the ID for a given data item.
public	getIsFlatData(): boolean Returns a boolean whether the tree is using flat data or not.
public	getLinks(): object[] Get the array of D3 link data items the D3 tree has generated.
public	getLoadOnDemandSettings(): LoadOnDemandSettings Gets the load on demand settings object.
public	getMargins(): object Gets the margins for the tree diagram.
public	getMaxScale(): number Gets the maximum zoom scaling.
public	getMinScale(): number Gets the minimum zoom scaling.
public	getNode(idOrDataItem: * \| object): object Get a single node given an id or a data item.
public	getNodeDepthMultiplier(): number Gets the node depth multiplier that affects the distance between the parent node and the child node.
public	getNodeSettings(): NodeSettings Gets the node settings object.
public	getNodes(): object[] Get the array of D3 node data items the D3 tree has generated.
public	getOrientation(): string Gets the tree orientation.
public	getPanningContainer(): object Gets the D3 selection object for the panning container element.
public	getParentId(dataItem: object): * Gets the parent ID for a given data item.
public	getRoot(): object Gets the root node object.
public	getSvg(): object Gets the D3 selection object for the SVG element.
public	getTheme(): string Gets the tree theme.
public	getTreeGenerator(): function Gets the D3 generator object used to generate the tree nodes coordinates.
public	getView(): object Gets the D3 selection object for the view element.
public	getVisibleNodes(): object[] Get the array of visible D3 node data items the D3 tree has generated.
public	getWidth(): number Gets the width of SVG, including the margins.
public	getWidthWithoutMargins(): number Gets the width of the SVG for the tree diagram.
public	getZoomListener(): function Gets the D3 zoom listener used for the panning, zooming and focus features.
public	hideSiblings(nodeDataItem: object): object Hide the siblings nodes for a given node.
public	initialize(): object Creates and set up the the tree diagram.
public	nodeFocus(nodeDataItem: object): object Focuses to a node, given a node data item.
public	nodeToggle(nodeDataItem: *): object Toggles the children visibility for a given node data item.
public	regenerateNodeData(): object Regenerates the node data.
public	removeSelection(nodeDataItem: object): object Remove node selections for a given node and it's children.
public	setAllowFocus(newAllowFocus: boolean): object Sets the boolean value indicating whether to focus to the clicked node or not.
public	setAllowNodeCentering(newAllowNodeCentering: boolean): object Whether to pan to a clicked node.
public	setAllowPan(newAllowPan: *): object Sets the boolean value indicating whether the drag-to-pan pan feature is enabled or not.
public	setAllowZoom(newAllowZoom: boolean): object Sets the boolean value indicating whether the mouse wheel to zoom in/out feature is enabled or not.
public	setChildrenAccessor(newChildrenAccessor: getChildrenCallBack): object Sets the children accessor callback function, defining how to get the children data items from a given data item.
public	setData(newData: object[]): object Sets the data items the tree should use to render the nodes.
public	setDuration(newDuration: *): object Sets the duration of animations for the tree.
public	setElement(newElement: object): object Sets the container DOM element
public	setHeightWithoutMargins(newHeightWithoutMargin: *): object Sets the height of the SVG for the tree diagram.
public	setIdAccessor(newIdAccessor: getIdCallBack): object Sets the ID accessor callback function, defining how to get a unique ID from a given data item.
public	setIsFlatData(newIsFlatData: boolean): * Sets the is flat data flag.
public	setMargins(newMargins: object): object Sets the margins for the tree diagram.
public	setMaxScale(newMaxScale: *): object Sets the maximum zoom scaling.
public	setMinScale(newMinScale: *): object Sets the minimum zoom scaling.
public	setNodeDepthMultiplier(newNodeDepthMultiplier: number): object Sets the node depth multiplier value.
public	setOrientation(orientation: string): object Sets the tree orientation.
public	setParentIdAccessor(newParentIdAccessor: getParentIdCallBack): object Sets the parent ID accessor callback function, defining how to get the parent ID from a given data item.
public	setTheme(theme: string): object Sets the tree theme.
public	setWidthWithoutMargins(newWidthWithoutMargin: *): object Sets the width of the SVG for the tree diagram.
public	update(nodeDataItem: object): object Updates the tree given a D3 tree node.
public	updateDimensions(): object Updates the dimensions of the SVG.
public	updateTreeWithFocusOnNode(nodeDataItem: object): object Updates the tree diagram so only the relevant focused node and direct parent hierarchies are shown.
public	validateSettings(): object Validates the settings to ensure the tree diagram is ready to be generated.
private	_addUnderlyingChildNode(parentNodeDataItem: object, dataItem: object): object Creates and adds a child D3 tree node to a given parent D3 tree node.
private	_createNode(parentNodeDataItem: object, dataItem: object): object Creates a child D3 tree node.
private	_getLinkPathGenerator(): function Gets the path generator used to render the links between the nodes.
private	_getNodeSize(): number[] Called when updating dimensions when node settings is configured to be 'nodesize'.
private	_linkEnter(source: , linkEnter: , links: , linkPathGenerator: ): object Defines how to create the links for newly added data objects.
private	_linkExit(source: object, linkExit: , linkExitTransition: , links: , linkPathGenerator: ): object Defines how to remove the links for the removed data objects.
private	_linkUpdate(source: , linkUpdate: , linkUpdateTransition: , links: , linkPathGenerator: *): object Defines how to update the links for the data objects.
private	_nodeEnter(nodeEnter: , nodes: ): object Defines how to create the nodes for newly added data objects.
private	_nodeExit(nodeExit: , nodeExitTransition: , nodes: *): object Defines how to remove the nodes for the removed data objects.
private	_nodeUpdate(nodeUpdate: , nodeUpdateTransition: , nodes: *): object Defines how to update the nodes for the data objects.
private	_onNodeClick(nodeDataItem: object, index: number, arr: object[]): boolean Triggers the nodeClick event when a D3 node is clicked on, and proceeds to focus/expand/collapse the node.
private	_populateUnderlyingChildren(nodeDataItem: object): object Populates the node's children to a hidden property.
private	_processLoadedDataForNodeFocus(nodeDataItem: object, result: object[]): object Process the loaded data from AJAX resulting from a node expand.
private	_processLoadedDataForNodeToggle(nodeDataItem: object, result: object[]): object Process the loaded data from AJAX resulting from a node toggle.
private	_updateLinks(nodeDataItem: object, links: object[]): object Updates the tree node links given a D3 tree node.
private	_updateNodes(nodeDataItem: object, nodes: object[]): object Updates the tree nodes given a D3 tree node.

Public Constructors

public constructor(options: object) source

Override:

BaseTree#constructor

Params:

Name	Type	Attribute	Description
options	object		The options object.
options.getBodyDisplayText	bodyDisplayTextAccessorCallBack		Determines how to obtain the body text to display for a node corresponding to a data item.
options.getTitleDisplayText	titleDisplayTextAccessorCallBack		Determines how to obtain the title text to display for a node corresponding to a data item.

Public Members

public nodeSettings: * source

Override:

BaseTree#nodeSettings

Private Members

private _getBodyDisplayText: * source

private _getTitleDisplayText: * source

Public Methods

public centerNode(nodeDataItem: ): source

Center the view to a D3 tree node.

Override:

BaseTree#centerNode

Params:

Name	Type	Attribute	Description
nodeDataItem	*

Return:

public getBodyDisplayText(nodeDataItem: object): string source

Gets the body display text for a given data item.

Params:

Name	Type	Attribute	Description
nodeDataItem	object		The data item to get the body display text from.

Return:

string

The body display text to render for the node.

public getTitleDisplayText(nodeDataItem: object): string source

Gets the title display text for a given data item.

Params:

Name	Type	Attribute	Description
nodeDataItem	object		The D3 node data item to get the title display text from.

Return:

string

The title display text to render for the node.

public initialize(): * source

Creates and set up the the tree diagram.

Override:

BaseTree#initialize

Return:

public setBodyDisplayTextAccessor(newBodyDisplayTextAccessor: bodyDisplayTextAccessorCallBack): * source

Sets the body display text accessor, used to get the body display text for the nodes.

Params:

Name	Type	Attribute	Description
newBodyDisplayTextAccessor	bodyDisplayTextAccessorCallBack

Return:

public setTitleDisplayTextAccessor(newTitleDisplayTextAccessor: titleDisplayTextAccessorCallBack): * source

Sets the title display text accessor, used to get the title display text for the nodes.

Params:

Name	Type	Attribute	Description
newTitleDisplayTextAccessor	titleDisplayTextAccessorCallBack

Return:

public validateSettings(): * source

Validates the settings to ensure the tree diagram is ready to be generated.

Override:

BaseTree#validateSettings

Return:

Private Methods

private _getLinkPathGenerator(): * source

Gets the path generator used to render the links between the nodes.

Override:

BaseTree#_getLinkPathGenerator

Return:

private _getNodeSize(): undefined[] source

Called when updating dimensions when node settings is configured to be 'nodesize'.

Override:

BaseTree#_getNodeSize

Return:

undefined[]

private _linkEnter(source: , linkEnter: , links: , linkPathGenerator: ): * source

Defines how to create the links for newly added data objects.

Override:

BaseTree#_linkEnter

Params:

Name	Type	Attribute	Description
source	*
linkEnter	*
links	*
linkPathGenerator	*

Return:

private _linkExit(source: , linkExit: , linkExitTransition: , links: , linkPathGenerator: ): source

Defines how to remove the links for the removed data objects.

Override:

BaseTree#_linkExit

Params:

Name	Type	Attribute	Description
source	*
linkExit	*
linkExitTransition	*
links	*
linkPathGenerator	*

Return:

private _linkUpdate(source: , linkUpdate: , linkUpdateTransition: , links: , linkPathGenerator: ): source

Defines how to update the links for the data objects.

Override:

BaseTree#_linkUpdate

Params:

Name	Type	Attribute	Description
source	*
linkUpdate	*
linkUpdateTransition	*
links	*
linkPathGenerator	*

Return:

private _nodeEnter(nodeEnter: , nodes: ): * source

Defines how to create the nodes for newly added data objects.

Override:

BaseTree#_nodeEnter

Params:

Name	Type	Attribute	Description
nodeEnter	*
nodes	*

Return:

private _nodeExit(nodeExit: , nodeExitTransition: , nodes: ): source

Defines how to remove the nodes for the removed data objects.

Override:

BaseTree#_nodeExit

Params:

Name	Type	Attribute	Description
nodeExit	*
nodeExitTransition	*
nodes	*

Return:

private _nodeUpdate(nodeUpdate: , nodeUpdateTransition: , nodes: ): source

Defines how to update the nodes for the data objects.

Override:

BaseTree#_nodeUpdate

Params:

Name	Type	Attribute	Description
nodeUpdate	*
nodeUpdateTransition	*
nodes	*

BoxedTree

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(options: object) source

Override:

Params:

Public Members

public nodeSettings: * source

Override:

Private Members

private _getBodyDisplayText: * source

private _getTitleDisplayText: * source

Public Methods

public centerNode(nodeDataItem: *): * source

Override:

Params:

Return:

public getBodyDisplayText(nodeDataItem: object): string source

Params:

Return:

public getTitleDisplayText(nodeDataItem: object): string source

Params:

Return:

public initialize(): * source

Override:

Return:

public setBodyDisplayTextAccessor(newBodyDisplayTextAccessor: bodyDisplayTextAccessorCallBack): * source

Params:

Return:

public setTitleDisplayTextAccessor(newTitleDisplayTextAccessor: titleDisplayTextAccessorCallBack): * source

Params:

Return:

public validateSettings(): * source

Override:

Return:

Private Methods

private _getLinkPathGenerator(): * source

Override:

Return:

private _getNodeSize(): undefined[] source

Override:

Return:

private _linkEnter(source: *, linkEnter: *, links: *, linkPathGenerator: *): * source

Override:

Params:

Return:

private _linkExit(source: *, linkExit: *, linkExitTransition: *, links: *, linkPathGenerator: *): * source

Override:

Params:

Return:

private _linkUpdate(source: *, linkUpdate: *, linkUpdateTransition: *, links: *, linkPathGenerator: *): * source

Override:

Params:

Return:

private _nodeEnter(nodeEnter: *, nodes: *): * source

Override:

Params:

Return:

private _nodeExit(nodeExit: *, nodeExitTransition: *, nodes: *): * source

Override:

Params:

Return:

private _nodeUpdate(nodeUpdate: *, nodeUpdateTransition: *, nodes: *): * source

Override:

Params:

Return:

public centerNode(nodeDataItem: ): source

private _linkEnter(source: , linkEnter: , links: , linkPathGenerator: ): * source

private _linkExit(source: , linkExit: , linkExitTransition: , links: , linkPathGenerator: ): source

private _linkUpdate(source: , linkUpdate: , linkUpdateTransition: , links: , linkPathGenerator: ): source

private _nodeEnter(nodeEnter: , nodes: ): * source

private _nodeExit(nodeExit: , nodeExitTransition: , nodes: ): source

private _nodeUpdate(nodeUpdate: , nodeUpdateTransition: , nodes: ): source