# AbstractTreeMapSettings

abstract class AbstractTreeMapSettings<Column> : TreeMapSettings<Column>

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

#### Inheritors

DefaultTreeMapSettings

## Types

Companion
Link copied to clipboard
object Companion

## Properties

backgroundColumn
Link copied to clipboard
abstract var backgroundColumn: Column?

Gets the model used to hold the field used to display the background label.

colorColumn
Link copied to clipboard
abstract var colorColumn: Column?

Gets the model used to hold the field used to represent the color.

groupByColumns
Link copied to clipboard
abstract var groupByColumns: List<Column>

Gets the model used to hold the list of fields to be use for grouping.

heightColumn
Link copied to clipboard
abstract var heightColumn: Column?

Gets the model used to hold the field used to represent the height.

labelsColumns
Link copied to clipboard
abstract var labelsColumns: List<Column>

Gets the model used to hold the list of fields to be use for labeling.

lightSourceAmbientInterval
Link copied to clipboard
abstract val lightSourceAmbientInterval: MutableBoundedInterval
lightSourceHeightInterval
Link copied to clipboard
abstract val lightSourceHeightInterval: MutableBoundedInterval
lightSourceXInterval
Link copied to clipboard
abstract val lightSourceXInterval: MutableBoundedInterval
lightSourceYInterval
Link copied to clipboard
abstract val lightSourceYInterval: MutableBoundedInterval
lightSourceZInterval
Link copied to clipboard
abstract val lightSourceZInterval: MutableBoundedInterval
maximumHeightInterval
Link copied to clipboard
abstract val maximumHeightInterval: MutableBoundedInterval
properties
Link copied to clipboard
abstract val properties: MutableProperties<String?>
rendering
Link copied to clipboard
abstract var rendering: Rendering?

Returns the rendering scheme to use to draw the treemap.

renderingSelection
Link copied to clipboard
abstract val renderingSelection: MutableSingleSelection<Rendering?>
sizeColumn
Link copied to clipboard
abstract var sizeColumn: Column?

Gets the model used to hold the field used to represent the size.

toolTipColumns
Link copied to clipboard
abstract var toolTipColumns: List<Column>

Gets the model used to hold the list of fields to be use by the tooltip.

## Functions

addTreeMapSettingsListener
Link copied to clipboard
open override fun addTreeMapSettingsListener(listener: TreeMapSettingsListener)

{@inheritDoc}

getBackground
Link copied to clipboard
abstract fun getBackground(): MkColor?

Returns the background color to use for drawing the treemap.

getBackgroundColumnSelection
Link copied to clipboard
abstract fun getBackgroundColumnSelection(): MutableSingleSelection<Column?>
getBackgroundProperty
Link copied to clipboard
abstract fun getBackgroundProperty(): MutableProperty<MkColor?>

Returns the background color to use for drawing the treemap.

getColorColumnSelection
Link copied to clipboard
abstract fun getColorColumnSelection(): MutableSingleSelection<Column?>
getColumnSettings
Link copied to clipboard
abstract fun getColumnSettings(field: Column?): TreeMapColumnSettings
getDefaultColumnSettings
Link copied to clipboard
abstract fun getDefaultColumnSettings(): TreeMapColumnSettings
getDepth
Link copied to clipboard
abstract fun getDepth(): Depth?

Returns the depth to use to lay out the treemap.

getDepthSelection
Link copied to clipboard
abstract fun getDepthSelection(): MutableSingleSelection<Depth?>
getDimension
Link copied to clipboard
abstract fun getDimension(): Dimension?

Gets the size of the treemap.

getDimensionFixed
Link copied to clipboard
abstract fun getDimensionFixed(): Boolean?
getGroupByColumnsSelection
Link copied to clipboard
abstract fun getGroupByColumnsSelection(): MutableSelection<Column>
getHeightColumnSelection
Link copied to clipboard
abstract fun getHeightColumnSelection(): MutableSingleSelection<Column?>
getHideFilterResultsSelection
Link copied to clipboard
abstract fun getHideFilterResultsSelection(): MutableProperty<Boolean?>
getHideSearchResultsSelection
Link copied to clipboard
abstract fun getHideSearchResultsSelection(): MutableProperty<Boolean?>
getLabelColumnsSelection
Link copied to clipboard
abstract fun getLabelColumnsSelection(): MutableSelection<Column>
getLightSourceAmbient
Link copied to clipboard
abstract fun getLightSourceAmbient(): Double

Returns the light source ambient intensity used for drawing the cushions.

getLightSourceHeight
Link copied to clipboard
abstract fun getLightSourceHeight(): Double

Returns the light source height used for drawing the cushions.

getLightSourceX
Link copied to clipboard
abstract fun getLightSourceX(): Double

Returns the light source X position used for drawing the cushions.

getLightSourceY
Link copied to clipboard
abstract fun getLightSourceY(): Double

Returns the light source Y position used for drawing the cushions.

getLightSourceZ
Link copied to clipboard
abstract fun getLightSourceZ(): Double

Returns the light source Z position used for drawing the cushions.

getMaximumHeight
Link copied to clipboard
abstract fun getMaximumHeight(): Double

Gets the maximum height.

getProbingColor
Link copied to clipboard
abstract fun getProbingColor(): MkColor?

Returns the color to use for drawing the borders.

getProbingColorProperty
Link copied to clipboard
abstract fun getProbingColorProperty(): MutableProperty<MkColor?>

Returns the color to use for drawing the borders.

getProgressive
Link copied to clipboard
abstract fun getProgressive(): Progressive?
getProgressiveSelection
Link copied to clipboard
abstract fun getProgressiveSelection(): MutableSingleSelection<Progressive?>
getSelectionColor
Link copied to clipboard
abstract fun getSelectionColor(): MkColor?

Returns the color to use for drawing the borders.

getSelectionColorProperty
Link copied to clipboard
abstract fun getSelectionColorProperty(): MutableProperty<MkColor?>

Returns the color to use for drawing the borders.

getShowPopup
Link copied to clipboard
abstract fun getShowPopup(field: Column?): Boolean

Tells whether the specified field should be shown in the popup.

getSizeColumnSelection
Link copied to clipboard
abstract fun getSizeColumnSelection(): MutableSingleSelection<Column?>
getTooltipBackground
Link copied to clipboard
abstract fun getTooltipBackground(): MkColor?

Returns the background color to use for drawing the tooltips.

getTooltipBackgroundProperty
Link copied to clipboard
abstract fun getTooltipBackgroundProperty(): MutableProperty<MkColor?>

Returns the background color to use for drawing the tooltips.

getTooltipColumnsSelection
Link copied to clipboard
abstract fun getTooltipColumnsSelection(): MutableSelection<Column>
getValue
Link copied to clipboard
abstract fun getValue(key: String?): Any?

Gets the value of the specified property.

isHideFilterResults
Link copied to clipboard
abstract fun isHideFilterResults(): Boolean?

Gets the model used to indicate whether filtered nodes should be hidden.

isHideSearchResults
Link copied to clipboard
abstract fun isHideSearchResults(): Boolean?

Gets the model used to indicate whether nodes that do not match the search criteria should be hidden.

removeTreeMapSettingsListener
Link copied to clipboard
open override fun removeTreeMapSettingsListener(listener: TreeMapSettingsListener)

{@inheritDoc}

removeTreeMapSettingsListeners
Link copied to clipboard
open override fun removeTreeMapSettingsListeners()

{@inheritDoc}

resetToDefaults
Link copied to clipboard
abstract fun resetToDefaults()
save
Link copied to clipboard
abstract fun save(dataFrame: DataFrame<Any?, Column, Any?>, elementFactory: ElementFactory, root: Element)
setBackground
Link copied to clipboard
abstract fun setBackground(column: Int)

Defines the field to use for background labeling.

abstract fun setBackground(color: MkColor?)

Sets the background color to use for drawing the treemap.

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

Defines the field to use for background labeling.

setColor
Link copied to clipboard
abstract fun setColor(column: Int)

Defines the field to use for coloring.

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

Defines the field to use for coloring.

setDepth
Link copied to clipboard
abstract fun setDepth(depth: Depth?)

Defines the depth to use to lay out the treemap.

setDimension
Link copied to clipboard
abstract fun setDimension(dimension: Dimension?)

Sets the size of the treemap.

setDimensionFixed
Link copied to clipboard
abstract fun setDimensionFixed(fixed: Boolean?)
setGroupBy
Link copied to clipboard
abstract fun setGroupBy(vararg columns: Int)

Defines the fields to be use for grouping.

setGroupByByNames
Link copied to clipboard
abstract fun setGroupByByNames(vararg columnNames: String?)

Defines the fields to be use for grouping.

setHeight
Link copied to clipboard
abstract fun setHeight(column: Int)

Defines the field to use for mapping the height.

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

Defines the field to use for mapping the height.

setHideFilterResults
Link copied to clipboard
abstract fun setHideFilterResults(hideFilterResults: Boolean?)
setHideSearchResults
Link copied to clipboard
abstract fun setHideSearchResults(hideSearchResults: Boolean?)
setLabels
Link copied to clipboard
abstract fun setLabels(vararg columns: Int)

Defines the fields to be use for labeling.

setLabelsByNames
Link copied to clipboard
abstract fun setLabelsByNames(vararg columnNames: String?)

Defines the fields to be use for labeling.

setLightSourceAmbient
Link copied to clipboard
abstract fun setLightSourceAmbient(value: Double)

Sets the light source ambient intensity used for drawing the cushions.

setLightSourceHeight
Link copied to clipboard
abstract fun setLightSourceHeight(value: Double)

Sets the light source height used for drawing the cushions.

setLightSourceX
Link copied to clipboard
abstract fun setLightSourceX(value: Double)

Sets the light source X position used for drawing the cushions.

setLightSourceY
Link copied to clipboard
abstract fun setLightSourceY(value: Double)

Sets the light source Y position used for drawing the cushions.

setLightSourceZ
Link copied to clipboard
abstract fun setLightSourceZ(value: Double)

Sets the light source Z position used for drawing the cushions.

setMaximumHeight
Link copied to clipboard
abstract fun setMaximumHeight(height: Double)

Sets the maximum height.

setProbingColor
Link copied to clipboard
abstract fun setProbingColor(color: MkColor?)

Sets the color to use for drawing the borders.

setProgressive
Link copied to clipboard
abstract fun setProgressive(progressive: Progressive?)
setSelectionColor
Link copied to clipboard
abstract fun setSelectionColor(color: MkColor?)

Sets the color to use for drawing the borders.

setShowPopup
Link copied to clipboard
abstract fun setShowPopup(field: Column?, show: Boolean)

Sets whether the specified field should be displayed or no in the popup.

setSize
Link copied to clipboard
abstract fun setSize(column: Int)

Defines the field to use to represent the size.

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

Defines the field to use to represent the size.

setToolTip
Link copied to clipboard
abstract fun setToolTip(vararg columns: Int)

Defines the fields to be use for the tooltip.

setTooltipBackground
Link copied to clipboard
abstract fun setTooltipBackground(color: MkColor?)

Sets the background color to use for drawing the tooltips.

setToolTipByNames
Link copied to clipboard
abstract fun setToolTipByNames(vararg columnNames: String?)

Defines the fields to be use for the tooltip.