# AbstractTreeMapModel

abstract class AbstractTreeMapModel<Row, Column> : TreeMapModel<AbstractTreeMapNode<Row, Column>, Row, Column>

This class provides a skeletal implementation of the TreeMapModel interface to minimize the effort required to implement this interface.

#### Parameters

the type of nodes

#### Inheritors

DefaultTreeMapModel

## Constructors

AbstractTreeMapModel
Link copied to clipboard
constructor()

## Types

Companion
Link copied to clipboard
object Companion
Worker
Link copied to clipboard
inner class Worker : Callable<Unit> , TreeMapWorker

## Properties

colorColumns
Link copied to clipboard
open override val colorColumns: Iterable<Column?>
colorFactory
Link copied to clipboard
open override val colorFactory: MkColorFactory
colorProvider
Link copied to clipboard
open override var colorProvider: ColorProvider<AbstractTreeMapNode<Row, Column>>
columnCount
Link copied to clipboard
abstract val columnCount: Int

Returns the number of columns in the model.

currentRoot
Link copied to clipboard
open override var currentRoot: AbstractTreeMapNode<Row, Column>?

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

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

Obtains the model used for filtering nodes in the treemap.

groupByColumns
Link copied to clipboard
open override val groupByColumns: Iterable<Column?>
heightColumns
Link copied to clipboard
open override val heightColumns: Iterable<Column?>
highlighting
Link copied to clipboard
open override val highlighting: MutableSelection<AbstractTreeMapNode<Row, Column>>

Obtains the model used to highlight nodes in the treemap.

isDirty
Link copied to clipboard
open override val isDirty: Boolean

Tells whether the current layout need to be reprocessed.

labelsColumns
Link copied to clipboard
open override val labelsColumns: Iterable<Column?>
maximumSize
Link copied to clipboard
open override var maximumSize: Double

Corresponds to area in map.

normalizedLightSourceX
Link copied to clipboard
open override var normalizedLightSourceX: Double

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

normalizedLightSourceY
Link copied to clipboard
open override var normalizedLightSourceY: Double

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

normalizedLightSourceZ
Link copied to clipboard
open override var normalizedLightSourceZ: Double

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

probing
Link copied to clipboard
open override val probing: MutableSingleSelection<AbstractTreeMapNode<Row, Column>?>

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

properties
Link copied to clipboard
open override val properties: MutableProperties<String?>
root
Link copied to clipboard
open override var root: AbstractTreeMapNode<Row, Column>?

Returns the root node of the treemap.

rowCount
Link copied to clipboard
abstract val rowCount: Int

Returns the number of columns in the model.

search
Link copied to clipboard
open override val search: MutableFilter<AbstractTreeMapNode<Row, Column>>

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

selection
Link copied to clipboard
open override val selection: MutableSelection<AbstractTreeMapNode<Row, Column>>

Obtains the model used for selecting nodes in the treemap.

settings
Link copied to clipboard
open override val settings: TreeMapSettings<Column>

Gets the settings currently selected.

sizeColumns
Link copied to clipboard
open override val sizeColumns: Iterable<Column?>
tooltipColumns
Link copied to clipboard
open override val tooltipColumns: Iterable<Column?>
worker
Link copied to clipboard
open override var worker: AbstractTreeMapModel.Worker<Row, Column>?

Gets the worker task updating the layout.

workerFuture
Link copied to clipboard
open override var workerFuture: Future<Unit>?

Gets the worker task updating the layout.

## Functions

addListener
Link copied to clipboard
open override fun addListener(treeMapListener: TreeMapListener)

{@inheritDoc}

breadthFirstIterator
Link copied to clipboard
open override fun breadthFirstIterator(parent: AbstractTreeMapNode<Row, Column>): Iterable<AbstractTreeMapNode<Row, Column>>

{@inheritDoc}

columns
Link copied to clipboard
abstract fun columns(): Iterable<Column>?
createDefaultColorMap
Link copied to clipboard
abstract fun createDefaultColorMap(column: Column): MutableColorMap?
depthFirstIterator
Link copied to clipboard
open override fun depthFirstIterator(parent: AbstractTreeMapNode<Row, Column>): Iterable<AbstractTreeMapNode<Row, Column>>

{@inheritDoc}

fireTreeMapChanged
Link copied to clipboard
fun fireTreeMapChanged(event: TreeMapEvent)
getAggregateValue
Link copied to clipboard
open override fun getAggregateValue(node: AbstractTreeMapNode<Row, Column>, column: Column?): Any?

{@inheritDoc}

getBounds
Link copied to clipboard
open override fun getBounds(node: AbstractTreeMapNode<Row, Column>): Rectangle2D

{@inheritDoc}

getCategoricalColorMap
Link copied to clipboard
open override fun getCategoricalColorMap(column: Column): MutableColorMap
getChildCount
Link copied to clipboard
abstract fun getChildCount(node: AbstractTreeMapNode<Row, Column>): Int

Returns the number of children of a given node.

getChildren
Link copied to clipboard
abstract fun getChildren(parent: AbstractTreeMapNode<Row, Column>): Iterable<AbstractTreeMapNode<Row, Column>>

Returns an iterator of the children of the given node.

getChildrenGroupByColumn
Link copied to clipboard
open override fun getChildrenGroupByColumn(node: AbstractTreeMapNode<Row, Column>): Column?

Gets the depth in hierarchy.

getChildrenOfTypeParent
Link copied to clipboard
abstract fun getChildrenOfTypeParent(parent: AbstractTreeMapNode<Row, Column>): Iterable<AbstractTreeMapNode<Row, Column>>

Returns an iterator of the children of the given node.

getColor
Link copied to clipboard
open override fun getColor(node: AbstractTreeMapNode<Row, Column>): MkColor

Gets the color of the given node.

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

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

getColumnName
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.

getCushionColor
Link copied to clipboard
abstract fun getCushionColor(node: AbstractTreeMapNode<Row, Column>): MkColor?

Returns the color of the cushion.

getCushionImage
Link copied to clipboard
abstract fun getCushionImage(node: AbstractTreeMapNode<Row, Column>): CPImage?

Returns the image used for painting the cushion.

getCustomColorMap
Link copied to clipboard
open override fun getCustomColorMap(column: Column): MutableColorMap
getFormatPattern
Link copied to clipboard
open override fun getFormatPattern(columnIndex: Int): String?
getGroupByColumn
Link copied to clipboard
open override fun getGroupByColumn(node: AbstractTreeMapNode<Row, Column>): Column?

Gets the depth in hierarchy.

getLabelName
Link copied to clipboard
abstract fun getLabelName(node: AbstractTreeMapNode<Row, Column>): String?

Gets the label of the given node.

getLevel
Link copied to clipboard
open override fun getLevel(node: AbstractTreeMapNode<Row, Column>): Int

{@inheritDoc}

getNestedShape
Link copied to clipboard
open override fun getNestedShape(node: AbstractTreeMapNode<Row, Column>): Shape

{@inheritDoc}

getNode
Link copied to clipboard
open override fun getNode(position: Point?): AbstractTreeMapNode<Row, Column>?

{@inheritDoc}

abstract fun getNode(row: Row): AbstractTreeMapNode<Row, Column>
getNumericMax
Link copied to clipboard
abstract fun getNumericMax(columnIndex: Column?): Double?

Gets the maximum value contained in the specified column.

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

Gets the minimum value contained in the specified column.

getParent
Link copied to clipboard
abstract fun getParent(node: AbstractTreeMapNode<Row, Column>): AbstractTreeMapNode<Row, Column>?

Gets the parent node of the given node.

getPredefinedColorMap
Link copied to clipboard
open override fun getPredefinedColorMap(column: Column): MutableColorMap
getShape
Link copied to clipboard
open override fun getShape(node: AbstractTreeMapNode<Row, Column>): Shape?

{@inheritDoc}

getSize
Link copied to clipboard
open override fun getSize(node: AbstractTreeMapNode<Row, Column>): Double

{@inheritDoc}

getStringValue
Link copied to clipboard
open override fun getStringValue(node: AbstractTreeMapNode<Row, Column>, column: Column): String?

{@inheritDoc}

getSumSize
Link copied to clipboard
open override fun getSumSize(node: AbstractTreeMapNode<Row, Column>): Double
getTreeMapColumn
Link copied to clipboard
abstract fun getTreeMapColumn(columnIndex: Int): Column?

Gets the field corresponding to the specified column index.

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

Gets the field corresponding to the specified column name.

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

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

hasNoChildren
Link copied to clipboard
open override fun hasNoChildren(node: AbstractTreeMapNode<Row, Column>): Boolean

{@inheritDoc}

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

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

isLeaf
Link copied to clipboard
open override fun isLeaf(node: AbstractTreeMapNode<Row, Column>): Boolean

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

isNumericType
Link copied to clipboard
open override fun isNumericType(column: Column): Boolean
isRoot
Link copied to clipboard
abstract fun isRoot(node: AbstractTreeMapNode<Row, Column>): Boolean

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

isTemporalType
Link copied to clipboard
open override fun isTemporalType(column: Column): Boolean
isVisualType
Link copied to clipboard
open override fun isVisualType(column: Column): Boolean
normalizeLightSource
Link copied to clipboard
fun normalizeLightSource()

Derive normalized vector here for performance.

parentPreorderEnumeration
Link copied to clipboard
open override fun parentPreorderEnumeration(parent: AbstractTreeMapNode<Row, Column>): Iterable<AbstractTreeMapNode<Row, Column>>

{@inheritDoc}

preorderEnumeration
Link copied to clipboard
open override fun preorderEnumeration(parent: AbstractTreeMapNode<Row, Column>): Iterable<AbstractTreeMapNode<Row, Column>>

{@inheritDoc}

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

{@inheritDoc}

scheduleUpdateWorker
Link copied to clipboard
fun scheduleUpdateWorker()
setColor
Link copied to clipboard
open override fun setColor(node: AbstractTreeMapNode<Row, Column>, color: MkColor?)

{@inheritDoc}

setFormatPattern
Link copied to clipboard
open override fun setFormatPattern(columnIndex: Int, pattern: String?)
setNestedShape
Link copied to clipboard
open override fun setNestedShape(node: AbstractTreeMapNode<Row, Column>, shape: Shape?)

{@inheritDoc}

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

Sets the maximum value contained in the specified column.

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

Sets the minimum value contained in the specified column.

setProgress
Link copied to clipboard
fun setProgress(progress: Int)
setShape
Link copied to clipboard
open override fun setShape(node: AbstractTreeMapNode<Row, Column>, shape: Shape?)

{@inheritDoc}

waitUntilReady
Link copied to clipboard
open override fun waitUntilReady()

{@inheritDoc}