TreeMapModel

Main interface for the model part of TreeMap.

Parameters

the type of columns

Inheritors

Properties

Link copied to clipboard
abstract val colorColumns: Iterable<Column?>
Link copied to clipboard
abstract val colorFactory: MkColorFactory
Link copied to clipboard
abstract var colorProvider: ColorProvider<N>
Link copied to clipboard
abstract val columnCount: Int

Returns the number of columns in the model.

Link copied to clipboard
abstract var currentRoot: N?

Sets the currently selected root node from which the treemap should be displayed.

Link copied to clipboard
abstract val dataFrame: DataFrame<Row, Column, *>?
Link copied to clipboard
abstract val filter: MutableFilter<N>

Obtains the model used for filtering nodes in the treemap.

Link copied to clipboard
Link copied to clipboard
abstract val heightColumns: Iterable<Column?>
Link copied to clipboard
abstract val highlighting: MutableSelection<N>

Obtains the model used to highlight nodes in the treemap.

Link copied to clipboard
abstract val isDirty: Boolean

Tells whether the current layout need to be reprocessed.

Link copied to clipboard
abstract val labelsColumns: Iterable<Column?>
Link copied to clipboard
abstract val maximumSize: Double

Corresponds to area in map.

Link copied to clipboard

Gets the position of the light source along the X axis.

Link copied to clipboard

Gets the position of the light source along the Y axis.

Link copied to clipboard

Gets the position of the light source along the Z axis.

Link copied to clipboard
abstract val probing: MutableSingleSelection<N?>

Obtains the model used for probing (aka mouse over).

Link copied to clipboard
abstract val properties: MutableProperties<String?>
Link copied to clipboard
abstract val root: N?

Returns the root node of the treemap.

Link copied to clipboard
abstract val rowCount: Int

Returns the number of columns in the model.

Link copied to clipboard
abstract val search: MutableFilter<N>

Obtains the model used to carry out search in the treemap.

Link copied to clipboard
abstract val selection: MutableSelection<N>

Obtains the model used for selecting nodes in the treemap.

Link copied to clipboard

Gets the settings currently selected.

Link copied to clipboard
abstract val sizeColumns: Iterable<Column?>
Link copied to clipboard
Link copied to clipboard
abstract val worker: TreeMapWorker?

Gets the worker task updating the layout.

Link copied to clipboard
abstract val workerFuture: Future<*>?

Gets the worker task updating the layout.

Functions

Link copied to clipboard
abstract fun addListener(treeMapListener: TreeMapListener)

Add a listener for receiving interesting events about changes in the model.

Link copied to clipboard
abstract fun breadthFirstIterator(parent: N): Iterable<N>

Creates and returns an iterable that traverses the subhierarchy rooted at the give node in breadth-first order. The first node returned by the iterator's next() method is the given node.

Link copied to clipboard
abstract fun columns(): Iterable<Column>?
Link copied to clipboard
abstract fun createDefaultColorMap(column: Column): MutableColorMap?
Link copied to clipboard
abstract fun depthFirstIterator(parent: N): Iterable<N>

Creates and returns an iterable that traverses the subhierarchy rooted at the give node in depth-first order. The first node returned by the iterator's next() method is the leftmost leaf.

Link copied to clipboard
abstract fun getAggregateValue(node: N, column: Column?): Any?

Returns the aggregated value of a variable for a given node.

Link copied to clipboard
expect abstract fun getBounds(node: N): Rectangle2D

Gets the bounding rectangle of the item in the map.

Link copied to clipboard
abstract fun getCategoricalColorMap(column: Column): MutableColorMap
Link copied to clipboard
abstract fun getChildCount(node: N): Int

Returns the number of children of a given node.

Link copied to clipboard
abstract fun getChildren(parent: N): Iterable<N>

Returns an iterator of the children of the given node.

Link copied to clipboard
abstract fun getChildrenGroupByColumn(node: N): Column?

Gets the depth in hierarchy.

Link copied to clipboard
abstract fun getChildrenOfTypeParent(parent: N): Iterable<N>

Returns an iterator of the children of the given node.

Link copied to clipboard
abstract fun getColor(node: N): MkColor?

Gets the color of the given node.

Link copied to clipboard
abstract fun getColorMap(column: Column?): MutableColorMap?
Link copied to clipboard
abstract fun getColumnClass(columnIndex: Column): KClass<*>?

Returns the most specific superclass for all the cell values in the column.

Link copied to clipboard
abstract fun getColumnName(columnIndex: Column): String?

Returns the name of the column at columnIndex. Note: this name does not need to be unique; two columns in a table can have the same name.

Link copied to clipboard
abstract fun getCushionColor(node: N): MkColor?

Returns the color of the cushion.

Link copied to clipboard
abstract fun getCushionImage(node: N): CPImage?

Returns the image used for painting the cushion.

Link copied to clipboard
abstract fun getCustomColorMap(column: Column): MutableColorMap
Link copied to clipboard
abstract fun getFormatPattern(columnIndex: Int): String?
Link copied to clipboard
abstract fun getGroupByColumn(node: N): Column?

Gets the depth in hierarchy.

Link copied to clipboard
abstract fun getLabelName(node: N): String?

Gets the label of the given node.

Link copied to clipboard
expect abstract fun getLevel(node: N): Int

Gets the depth in hierarchy.

Link copied to clipboard
abstract fun getNestedShape(node: N): Shape?

Gets the shape after nesting of the item in the map.

Link copied to clipboard
abstract fun getNode(row: Row): N

abstract fun getNode(position: Point?): N?

/ ** Gets the node at the specified position

Link copied to clipboard
abstract fun getNumericMax(columnIndex: Column?): Double?

Gets the maximum value contained in the specified column.

Link copied to clipboard
abstract fun getNumericMin(columnIndex: Column?): Double?

Gets the minimum value contained in the specified column.

Link copied to clipboard
abstract fun getParent(node: N): N?

Gets the parent node of the given node.

Link copied to clipboard
abstract fun getPredefinedColorMap(column: Column): MutableColorMap
Link copied to clipboard
expect abstract fun getShape(node: N): Shape?

Gets the shape of the item in the map.

Link copied to clipboard
expect abstract fun getSize(node: N): Double

Corresponds to area in map.

Link copied to clipboard
abstract fun getStringValue(node: N, column: Column): String?

Returns the string value for the cell at columnIndex and of node.

Link copied to clipboard
abstract fun getSumSize(node: N): Double
Link copied to clipboard
abstract fun getTreeMapColumn(columnIndex: Int): Column?

Gets the field corresponding to the specified column index.

Link copied to clipboard
abstract fun getTreeMapColumnByName(columnName: String?): Column?

Gets the field corresponding to the specified column name.

Link copied to clipboard
abstract fun getTreeMapColumns(vararg columns: Column): List<Column>
abstract fun getTreeMapColumns(vararg columnNames: String?): List<Column>
abstract fun getTreeMapColumns(includeNone: Boolean): Iterable<Column?>
abstract fun getTreeMapColumns(vararg columns: Int): List<Column>
Link copied to clipboard
abstract fun getValueAt(node: N, columnIndex: Column): Any?

Returns the value for the cell at columnIndex and of node.

Link copied to clipboard
expect abstract fun hasNoChildren(node: N): Boolean

Tells whether the given node is a leaf node or not.

Link copied to clipboard
abstract fun isEveryValueUnique(column: Column?): Boolean

Indicates whether all the values in the given field are unique.

Link copied to clipboard
abstract fun isLeaf(node: N): Boolean

Tells whether the given node is a leaf node or not.

Link copied to clipboard
abstract fun isNumericType(column: Column): Boolean
Link copied to clipboard
abstract fun isRoot(node: N): Boolean

Tells whether the given node is the root node or not.

Link copied to clipboard
abstract fun isTemporalType(column: Column): Boolean
Link copied to clipboard
abstract fun isVisualType(column: Column): Boolean
Link copied to clipboard
abstract fun parentPreorderEnumeration(parent: N): Iterable<N>

Creates and returns an iterable that traverses the subhierarchy rooted at the give node in preorder. Only non-leaf nodes are included. The first node returned by the iterator's next() method is the given node.

Link copied to clipboard
abstract fun preorderEnumeration(parent: N): Iterable<N>

Creates and returns an iterable that traverses the subhierarchy rooted at the give node in preorder. The first node returned by the iterator's next() method is the given node.

Link copied to clipboard
abstract fun progressProperty(): MutableProperty<Int>
Link copied to clipboard
abstract fun removeListener(treeMapListener: TreeMapListener)

Remove a listener from the list of listeners that should be notified about changes in the model.

Link copied to clipboard
abstract fun setColor(node: N, color: MkColor?)

Sets the color of the given node.

Link copied to clipboard
abstract fun setFormatPattern(columnIndex: Int, pattern: String?)
Link copied to clipboard
abstract fun setNestedShape(node: N, shape: Shape?)

Sets the shape after nesting of the item in the map.

Link copied to clipboard
abstract fun setNumericMax(columnIndex: Column?, max: Double)

Sets the maximum value contained in the specified column.

Link copied to clipboard
abstract fun setNumericMin(columnIndex: Column?, min: Double)

Sets the minimum value contained in the specified column.

Link copied to clipboard
expect abstract fun setShape(node: N, shape: Shape?)

Sets the shape of the item in the map.

Link copied to clipboard
abstract fun waitUntilReady()

Wait until all processing are completed.