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

public class | source

BoxedNodeSettings

Extends:

NodeSettings → BoxedNodeSettings

Constructor Summary

Public Constructor
public	constructor(ownerObject: object, options: object)

Member Summary

Private Members
private	_bodyBoxHeight: *
private	_bodyBoxPadding: *
private	_bodyBoxWidth: *
private	_titleBoxHeight: *
private	_titleBoxPadding: *
private	_titleBoxWidth: *

Method Summary

Public Methods
public	getBodyBoxHeight(): number Gets the body box height value.
public	getBodyBoxPadding(): object Gets the body box padding values.
public	getBodyBoxWidth(): number Gets the body box width value.
public	getTitleBoxHeight(): number Gets the title box height value.
public	getTitleBoxPadding(): object Gets the title box padding values.
public	getTitleBoxWidth(): number Gets the title box width value.
public	setBodyBoxHeight(height: number): object Sets the body box height value.
public	setBodyBoxPadding(newPadding: object): object Sets the body box padding values.
public	setBodyBoxWidth(width: number): object Sets the body box width value.
public	setTitleBoxHeight(height: number): object Sets the title box height value.
public	setTitleBoxPadding(newPadding: object): object Sets the title box padding values.
public	setTitleBoxWidth(width: number): object Sets the title box width value.

Inherited Summary

From class NodeSettings
private	_horizontalSpacing: *
private	_ownerObject: *
private	_sizingMode: *
private	_verticalSpacing: *
public	back(): object Gets the owner object.
public	getHorizontalSpacing(): number Gets the horizontal spacing value.
public	getSizingMode(): string Gets the sizing mode.
public	getVerticalSpacing(): number Gets the vertical spacing value.
public	setHorizontalSpacing(newHorizontalSpacing: number): object Sets the horizontal spacing value.
public	setSizingMode(newSizingMode: 'nodeSize' \| 'size'): object Sets the sizing mode.
public	setVerticalSpacing(newVerticalSpacing: number): object Sets the vertical spacing value.

Public Constructors

public constructor(ownerObject: object, options: object) source

Override:

NodeSettings#constructor

Params:

Name	Type	Attribute	Description
ownerObject	object		The owner object.
options	object		The options object.
options.bodyBoxWidth	number	optional default: 200	Body box width.
options.bodyBoxHeight	number	optional default: 75	Body box height.
options.bodyBoxPadding	object	optional	Body box padding object.
options.bodyBoxPadding.top	number	optional default: 5	Body box padding top.
options.bodyBoxPadding.right	number	optional default: 10	Body box padding right.
options.bodyBoxPadding.bottom	number	optional default: 5	Body box padding bottom.
options.bodyBoxPadding.left	number	optional default: 10	Body box padding left.
options.titleBoxWidth	number	optional	Title box width.
options.titleBoxHeight	number	optional default: 40	Title box height.
options.titleBoxPadding	object	optional	Title box padding object.
options.titleBoxPadding.top	number	optional default: 2	Title box padding top.
options.titleBoxPadding.right	number	optional default: 5	Title box padding right.
options.titleBoxPadding.bottom	number	optional default: 2	Title box padding bottom.
options.titleBoxPadding.left	number	optional default: 5	Title box padding left.

Private Members

private _bodyBoxHeight: * source

private _bodyBoxPadding: * source

private _bodyBoxWidth: * source

private _titleBoxHeight: * source

private _titleBoxPadding: * source

private _titleBoxWidth: * source

Public Methods

public getBodyBoxHeight(): number source

Gets the body box height value.

Return:

number

The body box height value.

public getBodyBoxPadding(): object source

Gets the body box padding values.

Return:

object

The body box padding object.

public getBodyBoxWidth(): number source

Gets the body box width value.

Return:

number

The body box width value.

public getTitleBoxHeight(): number source

Gets the title box height value.

Return:

number

The title box height value.

public getTitleBoxPadding(): object source

Gets the title box padding values.

Return:

object

The title box padding object.

public getTitleBoxWidth(): number source

Gets the title box width value.

Return:

number

The title box width value.

public setBodyBoxHeight(height: number): object source

Sets the body box height value.

Params:

Name	Type	Attribute	Description
height	number		The body box height value.

Return:

object

The node settings object.

public setBodyBoxPadding(newPadding: object): object source

Sets the body box padding values.

Params:

Name	Type	Attribute	Description
newPadding	object		The body box padding object value.
newPadding.top	number		The body box padding top value.
newPadding.right	number		The body box padding right value.
newPadding.bottom	number		The body box padding bottom value.
newPadding.left	number		The body box padding left value.

Return:

object

The node settings object.

public setBodyBoxWidth(width: number): object source

Sets the body box width value.

Params:

Name	Type	Attribute	Description
width	number		The body box width value.

Return:

object

The node settings object.

public setTitleBoxHeight(height: number): object source

Sets the title box height value.

Params:

Name	Type	Attribute	Description
height	number		The title box height value.

Return:

object

The node settings object.

public setTitleBoxPadding(newPadding: object): object source

Sets the title box padding values.

Params:

Name	Type	Attribute	Description
newPadding	object		The body box padding object value.
newPadding.top	number		The body box padding top value.
newPadding.right	number		The body box padding right value.
newPadding.bottom	number		The body box padding bottom value.
newPadding.left	number		The body box padding left value.

Return:

object

The node settings object.

public setTitleBoxWidth(width: number): object source

Sets the title box width value.

Params:

Name	Type	Attribute	Description
width	number		The title box width value.

Return:

object

The node settings object.