CDTreeMapNodeMBS.addExtraField(numbers() as double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Adds an array of numbers/dates to be used as an extra field in various places.

This method merely stores the data inside the node object. The Parameter Substitution and Formatting mechanism will determine how the data are to be used.

A common use for extra fields is to specify extra information (such as a custom serial number for the data points) to be displayed on data labels or on tool tips, or to supply extra query parameters in clickable charts. All these are achieved by specifying the extra field on the data label template or image map templates during parameter substitution.

Argument	Default	Description
numbers	(Mandatory)	An array of numbers/dates an extra field of the child nodes.

See also:

• addExtraField(texts() as string)

CDTreeMapNodeMBS.addExtraField(texts() as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Adds an array of text to be used as an extra field of the child nodes.

This method merely stores the data inside the node object. The Parameter Substitution and Formatting mechanism will determine how the data are to be used.

A common use for extra fields is to specify extra information (such as a custom serial number for the data points) to be displayed on data labels or on tool tips, or to supply extra query parameters in clickable charts. All these are achieved by specifying the extra field on the data label template or image map templates during parameter substitution.

Argument	Default	Description
texts	(Mandatory)	An array of text to be an extra field of the child nodes.

See also:

• addExtraField(numbers() as double)

CDTreeMapNodeMBS.Constructor   Private

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The private constructor.

CDTreeMapNodeMBS.Node(Index as Integer) as CDTreeMapNodeMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets the child node at the specified index.

Argument	Default	Description
i	(Mandatory)	The index of the child node.

Returns the TreeMapNode object representing the child node at the specified index.

CDTreeMapNodeMBS.setColors(fillColor as color, edgeColor as color, raisedEffect as integer = -2147483647)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the fill and border colors and 3D border effect of the node.

Argument	Default	Description
fillColor	(Mandatory)	The fill color of the node.
edgeColor	(Optional)	The border color of the node.
raisedEffect	(Optional)	The 3D border width. For positive values, the border ill appear raised. For negative values, the border will appear depressed. A zero value means the border will appear flat. This argument can also be used to specify CDBaseChartMBS.glassEffect, CDBaseChartMBS.softLighting, CDBaseChartMBS.cylinderEffect or CDBaseChartMBS.flatBorder effects.

See also:

• setColors(fillColor as integer, edgeColor as integer = -1, raisedEffect as integer = -2147483647)

CDTreeMapNodeMBS.setColors(fillColor as integer, edgeColor as integer = -1, raisedEffect as integer = -2147483647)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the fill and border colors and 3D border effect of the node.

Argument	Default	Description
fillColor	(Mandatory)	The fill color of the node.
edgeColor	(Optional)	The border color of the node.
raisedEffect	(Optional)	The 3D border width. For positive values, the border ill appear raised. For negative values, the border will appear depressed. A zero value means the border will appear flat. This argument can also be used to specify CDBaseChartMBS.glassEffect, CDBaseChartMBS.softLighting, CDBaseChartMBS.cylinderEffect or CDBaseChartMBS.flatBorder effects.

See also:

• setColors(fillColor as color, edgeColor as color, raisedEffect as integer = -2147483647)

CDTreeMapNodeMBS.setData(data() as double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the data for the child nodes.

Argument	Default	Description
data	(Mandatory)	An array of numbers for the values of the child node. This array can be empty if the child nodes contains other child nodes. In this case, the value of a node will be determined as the sum of the values of its child nodes.

See also:

• setData(data() as double, labels() as string)
• setData(data() as double, labels() as string, colors() as Color)
• setData(data() as double, labels() as string, colors() as Integer)

CDTreeMapNodeMBS.setData(data() as double, labels() as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the data for the child nodes.

Argument	Default	Description
data	(Mandatory)	An array of numbers for the values of the child node. This array can be empty if the child nodes contains other child nodes. In this case, the value of a node will be determined as the sum of the values of its child nodes.
labels	[Empty_Array]	An array of text strings for the node labels.

See also:

• setData(data() as double)
• setData(data() as double, labels() as string, colors() as Color)
• setData(data() as double, labels() as string, colors() as Integer)

CDTreeMapNodeMBS.setData(data() as double, labels() as string, colors() as Color)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the data for the child nodes.

Argument	Default	Description
data	(Mandatory)	An array of numbers for the values of the child node. This array can be empty if the child nodes contains other child nodes. In this case, the value of a node will be determined as the sum of the values of its child nodes.
labels	[Empty_Array]	An array of text strings for the node labels.
colors	[Empty_Array]	An array of colors to be used as the fill colors of the child nodes. An empty array means the colors are determined by the prototype node (See CDTreeMapChartMBS.getLevelPrototype).

See also:

• setData(data() as double)
• setData(data() as double, labels() as string)
• setData(data() as double, labels() as string, colors() as Integer)

CDTreeMapNodeMBS.setData(data() as double, labels() as string, colors() as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the data for the child nodes.

Argument	Default	Description
data	(Mandatory)	An array of numbers for the values of the child node. This array can be empty if the child nodes contains other child nodes. In this case, the value of a node will be determined as the sum of the values of its child nodes.
labels	[Empty_Array]	An array of text strings for the node labels.
colors	[Empty_Array]	An array of colors to be used as the fill colors of the child nodes. An empty array means the colors are determined by the prototype node (See CDTreeMapChartMBS.getLevelPrototype).

See also:

• setData(data() as double)
• setData(data() as double, labels() as string)
• setData(data() as double, labels() as string, colors() as Color)

CDTreeMapNodeMBS.setLabelFormat(formatString as string = "{label}", font as string = "normal", fontSize as Integer = 10, fontColor as Integer = &hffff0002, alignment as Integer = 7)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the node label format and font style.

Please refer to Parameter Substitution and Formatting in FAQ on all available format parameters.

Argument	Default	Description
format	(Mandatory)	The format string.
font	"normal"	The font used to draw the label.
fontSize	10	The font size used to draw the labels in points.
fontColor	TextColor	The color used to draw the labels.
alignment	TopLeft	The alignment of the label inside the node. See Alignment Specification for supported alignment types.

See also:

• setLabelFormat(formatString as string, font as string, fontSize as Integer, fontColor as Color, alignment as Integer = 7)

CDTreeMapNodeMBS.setLabelFormat(formatString as string, font as string, fontSize as Integer, fontColor as Color, alignment as Integer = 7)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the node label format and font style.

Please refer to Parameter Substitution and Formatting in FAQ on all available format parameters.

Argument	Default	Description
format	(Mandatory)	The format string.
font	"normal"	The font used to draw the label.
fontSize	10	The font size used to draw the labels in points.
fontColor	TextColor	The color used to draw the labels.
alignment	TopLeft	The alignment of the label inside the node. See Alignment Specification for supported alignment types.

See also:

• setLabelFormat(formatString as string = "{label}", font as string = "normal", fontSize as Integer = 10, fontColor as Integer = &hffff0002, alignment as Integer = 7)

CDTreeMapNodeMBS.setLayoutAspectMultiplier(multiplier as Double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets layout aspect multiplier.

CDTreeMapNodeMBS.setLayoutAspectRatio(ratio as Double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Set the layout aspect ratio.

CDTreeMapNodeMBS.setLayoutMethod(layoutMethod as Integer, layoutDirection as Integer = -1)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the layout method used to layout the child nodes.

The layout method is specified by using the following predefined constants as the layoutMethod argument.

If a layout method argument is not specified, it will be obtained from the prototype node (see TreeMapChart.getLevelPrototype). If it is still not specified, the parent node will be used. If the node is the root node with no parent, the default is to use TreeMapSquarify with kTopLeft layout direction and without swapXY.

Argument	Default	Description
layoutMethod	(Mandatory)	The layout method used to layout the child nodes. A value of 0 means the layout method is not specified.
layoutDirection	(Optional)	The layout direction. Must be one of kTopLeft, kTopRight, kBottomLeft and kBottomRight. By default, the horizontal direction will be applied first, followed by the vertical direction.
swapXY	(Optional)	If set to true, the vertical direction will be applied first, followed by the horizontal direction. A false value means the opposite.

See also:

• setLayoutMethod(layoutMethod as Integer, layoutDirection as Integer, swapXY as Boolean)

Some examples using this method:

• /ChartDirector/multileveltreemaplayout
• /ChartDirector/treemaplayout

CDTreeMapNodeMBS.setLayoutMethod(layoutMethod as Integer, layoutDirection as Integer, swapXY as Boolean)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the layout method used to layout the child nodes.

The layout method is specified by using the following predefined constants as the layoutMethod argument.

If a layout method argument is not specified, it will be obtained from the prototype node (see TreeMapChart.getLevelPrototype). If it is still not specified, the parent node will be used. If the node is the root node with no parent, the default is to use TreeMapSquarify with kTopLeft layout direction and without swapXY.

Argument	Default	Description
layoutMethod	(Mandatory)	The layout method used to layout the child nodes. A value of 0 means the layout method is not specified.
layoutDirection	(Optional)	The layout direction. Must be one of kTopLeft, kTopRight, kBottomLeft and kBottomRight. By default, the horizontal direction will be applied first, followed by the vertical direction.
swapXY	(Optional)	If set to true, the vertical direction will be applied first, followed by the horizontal direction. A false value means the opposite.

See also:

• setLayoutMethod(layoutMethod as Integer, layoutDirection as Integer = -1)

CDTreeMapNodeMBS.setPos(x as Integer, y as Integer, w as Integer, h as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the position of the node.

CDTreeMapNodeMBS.setSorting(Mode as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	21.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Layout the nodes in sorted order.

ChartDirector supports a number of layout methods (see TreeMapNode.setLayoutMethod), most them will layout the nodes in the order they appear in the data array. The setSorting can be used to layout the nodes in sorted order instead.

Argument	Default	Description
mode	(Mandatory)	The values -1, 0, 1 refer to descending, no sorting and ascending order.

Some examples using this method:

• /ChartDirector/treemaplayout