# DefaultTreeMapSettings

class DefaultTreeMapSettings<N : MutableTreeMapNode<Column>, Column>(model: TreeMapModel<N, *, Column>, colorFactory: MkColorFactory, fontFactory: CPFontFactory, colorMapFactory: ColorMapFactory) : AbstractTreeMapSettings<Column>

Default implementation of the TreeMapSettings interface.

## Constructors

DefaultTreeMapSettings
Link copied to clipboard
constructor(model: TreeMapModel<N, *, Column>, colorFactory: MkColorFactory, fontFactory: CPFontFactory, colorMapFactory: ColorMapFactory)

## Properties

backgroundColumn
Link copied to clipboard
open override var backgroundColumn: Column?

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

colorColumn
Link copied to clipboard
open override var colorColumn: Column?

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

groupByColumns
Link copied to clipboard
open override var groupByColumns: List<Column>

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

heightColumn
Link copied to clipboard
open override var heightColumn: Column?

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

labelsColumns
Link copied to clipboard
open override var labelsColumns: List<Column>

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

lightSourceAmbientInterval
Link copied to clipboard
open override val lightSourceAmbientInterval: MutableBoundedInterval
lightSourceHeightInterval
Link copied to clipboard
open override var lightSourceHeightInterval: MutableBoundedInterval
lightSourceXInterval
Link copied to clipboard
open override val lightSourceXInterval: MutableBoundedInterval
lightSourceYInterval
Link copied to clipboard
open override val lightSourceYInterval: MutableBoundedInterval
lightSourceZInterval
Link copied to clipboard
open override val lightSourceZInterval: MutableBoundedInterval
maximumHeightInterval
Link copied to clipboard
open override val maximumHeightInterval: MutableBoundedInterval

Gets the model indicating the maximum height.

properties
Link copied to clipboard
open override val properties: MutableProperties<String?>
rendering
Link copied to clipboard
open override var rendering: Rendering?

Returns the rendering scheme to use to draw the treemap.

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

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

toolTipColumns
Link copied to clipboard
open override 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
open override fun getBackground(): MkColor?

{@inheritDoc}

getBackgroundColumnSelection
Link copied to clipboard
open override fun getBackgroundColumnSelection(): MutableSingleSelection<Column?>

{@inheritDoc}

getBackgroundProperty
Link copied to clipboard
open override fun getBackgroundProperty(): MutableProperty<MkColor?>

Returns the background color to use for drawing the treemap.

getColorColumnSelection
Link copied to clipboard
open override fun getColorColumnSelection(): MutableSingleSelection<Column?>

{@inheritDoc}

getColumnSettings
Link copied to clipboard
open override fun getColumnSettings(field: Column?): TreeMapColumnSettings
getDefaultColumnSettings
Link copied to clipboard
open override fun getDefaultColumnSettings(): TreeMapColumnSettings
getDepth
Link copied to clipboard
open override fun getDepth(): Depth?

{@inheritDoc}

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

Gets the size of the treemap.

getDimensionFixed
Link copied to clipboard
open override fun getDimensionFixed(): Boolean?
getGroupByColumnsSelection
Link copied to clipboard
open override fun getGroupByColumnsSelection(): MutableSelection<Column>

{@inheritDoc}

getHeightColumnSelection
Link copied to clipboard
open override fun getHeightColumnSelection(): MutableSingleSelection<Column?>

{@inheritDoc}

getHideFilterResultsSelection
Link copied to clipboard
open override fun getHideFilterResultsSelection(): MutableProperty<Boolean?>

{@inheritDoc}

getHideSearchResultsSelection
Link copied to clipboard
open override fun getHideSearchResultsSelection(): MutableProperty<Boolean?>

{@inheritDoc}

getLabelColumnsSelection
Link copied to clipboard
open override fun getLabelColumnsSelection(): MutableSelection<Column>

{@inheritDoc}

getLightSourceAmbient
Link copied to clipboard
open override fun getLightSourceAmbient(): Double

{@inheritDoc}

getLightSourceHeight
Link copied to clipboard
open override fun getLightSourceHeight(): Double

{@inheritDoc}

getLightSourceX
Link copied to clipboard
open override fun getLightSourceX(): Double

{@inheritDoc}

getLightSourceY
Link copied to clipboard
open override fun getLightSourceY(): Double

{@inheritDoc}

getLightSourceZ
Link copied to clipboard
open override fun getLightSourceZ(): Double

{@inheritDoc}

getMaximumHeight
Link copied to clipboard
open override fun getMaximumHeight(): Double

{@inheritDoc}

getProbingColor
Link copied to clipboard
open override fun getProbingColor(): MkColor?

{@inheritDoc}

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

Returns the color to use for drawing the borders.

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

{@inheritDoc}

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

Returns the color to use for drawing the borders.

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

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

getSizeColumnSelection
Link copied to clipboard
open override fun getSizeColumnSelection(): MutableSingleSelection<Column?>

{@inheritDoc}

getTooltipBackground
Link copied to clipboard
open override fun getTooltipBackground(): MkColor?

{@inheritDoc}

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

Returns the background color to use for drawing the tooltips.

getTooltipColumnsSelection
Link copied to clipboard
open override fun getTooltipColumnsSelection(): MutableSelection<Column>

{@inheritDoc}

getValue
Link copied to clipboard
open override fun getValue(key: String?): Any?

Gets the value of the specified property.

isHideFilterResults
Link copied to clipboard
open override fun isHideFilterResults(): Boolean?

{@inheritDoc}

isHideSearchResults
Link copied to clipboard
open override fun isHideSearchResults(): Boolean?

{@inheritDoc}

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
open override fun resetToDefaults()
save
Link copied to clipboard
open override fun save(dataFrame: DataFrame<Any?, Column, Any?>, elementFactory: ElementFactory, root: Element)
setBackground
Link copied to clipboard
open override fun setBackground(column: Int)
open override fun setBackground(color: MkColor?)

{@inheritDoc}

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

{@inheritDoc}

setColor
Link copied to clipboard
open override fun setColor(column: Int)

{@inheritDoc}

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

{@inheritDoc}

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

{@inheritDoc}

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

Sets the size of the treemap.

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

{@inheritDoc}

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

{@inheritDoc}

setHeight
Link copied to clipboard
open override fun setHeight(column: Int)

{@inheritDoc}

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

{@inheritDoc}

setHideFilterResults
Link copied to clipboard
open override fun setHideFilterResults(hideFilterResults: Boolean?)

{@inheritDoc}

setHideSearchResults
Link copied to clipboard
open override fun setHideSearchResults(hideSearchResults: Boolean?)

{@inheritDoc}

setLabels
Link copied to clipboard
open override fun setLabels(vararg columns: Int)

{@inheritDoc}

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

{@inheritDoc}

setLightSourceAmbient
Link copied to clipboard
open override fun setLightSourceAmbient(value: Double)

{@inheritDoc}

setLightSourceHeight
Link copied to clipboard
open override fun setLightSourceHeight(value: Double)

{@inheritDoc}

setLightSourceX
Link copied to clipboard
open override fun setLightSourceX(value: Double)

{@inheritDoc}

setLightSourceY
Link copied to clipboard
open override fun setLightSourceY(value: Double)

{@inheritDoc}

setLightSourceZ
Link copied to clipboard
open override fun setLightSourceZ(value: Double)

{@inheritDoc}

setMaximumHeight
Link copied to clipboard
open override fun setMaximumHeight(height: Double)

{@inheritDoc}

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

{@inheritDoc}

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

{@inheritDoc}

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

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

setSize
Link copied to clipboard
open override fun setSize(column: Int)

{@inheritDoc}

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

{@inheritDoc}

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

{@inheritDoc}

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

{@inheritDoc}

setToolTipByNames
Link copied to clipboard
open override fun setToolTipByNames(vararg columns: String?)

{@inheritDoc}