# AbstractTreeMapColumnSettings

abstract class AbstractTreeMapColumnSettings : TreeMapColumnSettings

#### Inheritors

DefaultTreeMapColumnSettings
OverridingTreeMapColumnSettings

## Constructors

AbstractTreeMapColumnSettings
Link copied to clipboard
constructor()

## Types

Companion
Link copied to clipboard
object Companion

## Properties

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

## Functions

getAggregation
Link copied to clipboard
abstract fun getAggregation(): Aggregation?

Returns the aggregation scheme to use to aggregate values of the treemap.

getAggregationProperty
Link copied to clipboard
abstract fun getAggregationProperty(): MutableProperty<Aggregation?>

Returns the aggregation scheme to use to aggregate values of the treemap.

getAlgorithm
Link copied to clipboard
abstract fun getAlgorithm(): Algorithm

Returns the algorithm to use to lay out the treemap.

getAlgorithmProperty
Link copied to clipboard
abstract fun getAlgorithmProperty(): MutableProperty<Algorithm?>

Returns the algorithm to use to lay out the treemap.

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

Returns the color to use for drawing the borders.

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

Returns the color to use for drawing the borders.

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

Returns the thickness used for drawing the borders.

getBorderThicknessInterval
Link copied to clipboard
abstract fun getBorderThicknessInterval(): MutableBoundedInterval?

Returns the thickness used for drawing the borders.

getColorMap
Link copied to clipboard
abstract fun getColorMap(): MutableColorMap?

Gets the color map for the specified column.

getColorMapProperty
Link copied to clipboard
abstract fun getColorMapProperty(): MutableProperty<MutableColorMap?>?

Gets the color map for the specified column.

getFormat
Link copied to clipboard
abstract fun getFormat(): CPFormat<Any?>?

Gets the format used to display values of the specified column.

getFormatProperty
Link copied to clipboard
abstract fun getFormatProperty(): MutableProperty<CPFormat<Any?>?>

Gets the format used to display values of the specified column.

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

Returns the background color to use for drawing the headers.

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

Returns the background color to use for drawing the headers.

getHeaderEffect
Link copied to clipboard
abstract fun getHeaderEffect(): EnhancedLabel.Effect?
getHeaderEffectColor
Link copied to clipboard
abstract fun getHeaderEffectColor(): MkColor?

Returns the effect color to use for drawing the headers.

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

Returns the effect color to use for drawing the headers.

getHeaderEffectOpacity
Link copied to clipboard
abstract fun getHeaderEffectOpacity(): Float?
getHeaderEffectOpacityProperty
Link copied to clipboard
abstract fun getHeaderEffectOpacityProperty(): MutableProperty<Float?>
getHeaderEffectProperty
Link copied to clipboard
abstract fun getHeaderEffectProperty(): MutableProperty<EnhancedLabel.Effect?>
getHeaderFont
Link copied to clipboard
abstract fun getHeaderFont(): MkFont?

Returns the font used for labeling the headings.

getHeaderFontProperty
Link copied to clipboard
abstract fun getHeaderFontProperty(): MutableProperty<MkFont?>

Returns the font used for labeling the headings.

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

Returns the foreground color to use for drawing the headers.

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

Returns the foreground color to use for drawing the headers.

getHeaderHorizontalAlignment
Link copied to clipboard
abstract fun getHeaderHorizontalAlignment(): Int
getHeaderHorizontalAlignmentProperty
Link copied to clipboard
abstract fun getHeaderHorizontalAlignmentProperty(): MutableProperty<Int>
getHeaderInsets
Link copied to clipboard
abstract fun getHeaderInsets(): Insets?
getHeaderInsetsProperty
Link copied to clipboard
abstract fun getHeaderInsetsProperty(): MutableProperty<Insets?>
getHeaderMinimumCharactersToDisplay
Link copied to clipboard
abstract fun getHeaderMinimumCharactersToDisplay(): Int?
getHeaderMinimumCharactersToDisplayProperty
Link copied to clipboard
abstract fun getHeaderMinimumCharactersToDisplayProperty(): MutableProperty<Int?>
getHeaderRendering
Link copied to clipboard
abstract fun getHeaderRendering(): EnhancedLabel.Rendering?
getHeaderRenderingProperty
Link copied to clipboard
abstract fun getHeaderRenderingProperty(): MutableProperty<EnhancedLabel.Rendering?>
getHeaderVerticalAlignment
Link copied to clipboard
abstract fun getHeaderVerticalAlignment(): Int
getHeaderVerticalAlignmentProperty
Link copied to clipboard
abstract fun getHeaderVerticalAlignmentProperty(): MutableProperty<Int>
getLabeling
Link copied to clipboard
abstract fun getLabeling(): Labeling?

Returns the labeling scheme to use to draw the treemap.

getLabelingContrastEnhancement
Link copied to clipboard
abstract fun getLabelingContrastEnhancement(): ContrastEnhancement?
getLabelingContrastEnhancementProperty
Link copied to clipboard
abstract fun getLabelingContrastEnhancementProperty(): MutableProperty<ContrastEnhancement?>
getLabelingEffect
Link copied to clipboard
abstract fun getLabelingEffect(): EnhancedLabel.Effect?
getLabelingEffectColor
Link copied to clipboard
abstract fun getLabelingEffectColor(): MkColor?

Returns the effect color to use for drawing the labels.

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

Returns the effect color to use for drawing the labels.

getLabelingEffectOpacity
Link copied to clipboard
abstract fun getLabelingEffectOpacity(): Float?
getLabelingEffectOpacityProperty
Link copied to clipboard
abstract fun getLabelingEffectOpacityProperty(): MutableProperty<Float?>
getLabelingEffectProperty
Link copied to clipboard
abstract fun getLabelingEffectProperty(): MutableProperty<EnhancedLabel.Effect?>
getLabelingFloat
Link copied to clipboard
abstract fun getLabelingFloat(): Boolean?
getLabelingFloatProperty
Link copied to clipboard
abstract fun getLabelingFloatProperty(): MutableProperty<Boolean?>
getLabelingFont
Link copied to clipboard
abstract fun getLabelingFont(): MkFont?

Returns the font used for labeling.

getLabelingFontProperty
Link copied to clipboard
abstract fun getLabelingFontProperty(): MutableProperty<MkFont?>

Returns the font used for labeling.

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

Returns the foreground color to use for drawing the labels.

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

Returns the foreground color to use for drawing the labels.

getLabelingHorizontalAlignment
Link copied to clipboard
abstract fun getLabelingHorizontalAlignment(): Int
getLabelingHorizontalAlignmentProperty
Link copied to clipboard
abstract fun getLabelingHorizontalAlignmentProperty(): MutableProperty<Int>
getLabelingMinimumCharactersToDisplay
Link copied to clipboard
abstract fun getLabelingMinimumCharactersToDisplay(): Int?
getLabelingMinimumCharactersToDisplayProperty
Link copied to clipboard
abstract fun getLabelingMinimumCharactersToDisplayProperty(): MutableProperty<Int?>
getLabelingProperty
Link copied to clipboard
abstract fun getLabelingProperty(): MutableProperty<Labeling?>

Returns the labeling scheme to use to draw the treemap.

getLabelingRendering
Link copied to clipboard
abstract fun getLabelingRendering(): EnhancedLabel.Rendering?
getLabelingRenderingProperty
Link copied to clipboard
abstract fun getLabelingRenderingProperty(): MutableProperty<EnhancedLabel.Rendering?>
getLabelingResizeTextToFitShape
Link copied to clipboard
abstract fun getLabelingResizeTextToFitShape(): Boolean?
getLabelingResizeTextToFitShapeProperty
Link copied to clipboard
abstract fun getLabelingResizeTextToFitShapeProperty(): MutableProperty<Boolean>
getLabelingShrinkTextToFitShape
Link copied to clipboard
abstract fun getLabelingShrinkTextToFitShape(): Boolean?
getLabelingShrinkTextToFitShapeProperty
Link copied to clipboard
abstract fun getLabelingShrinkTextToFitShapeProperty(): MutableProperty<Boolean>
getLabelingVerticalAlignment
Link copied to clipboard
abstract fun getLabelingVerticalAlignment(): Int
getLabelingVerticalAlignmentProperty
Link copied to clipboard
abstract fun getLabelingVerticalAlignmentProperty(): MutableProperty<Int>
getNesting
Link copied to clipboard
abstract fun getNesting(): Nesting?

Returns the nesting to use to lay out the treemap.

getNestingAmount
Link copied to clipboard
abstract fun getNestingAmount(): Double?

Returns the size of the nested areas.

getNestingAmountProperty
Link copied to clipboard
abstract fun getNestingAmountProperty(): MutableProperty<Double?>

Returns the size of the nested areas.

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

Returns the background color to use for drawing the nested areas.

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

Returns the background color to use for drawing the nested areas.

getNestingProperty
Link copied to clipboard
abstract fun getNestingProperty(): MutableProperty<Nesting?>

Returns the nesting to use to lay out the treemap.

getOrdering
Link copied to clipboard
abstract fun getOrdering(): Ordering

Returns the ordering to use to lay out the treemap.

getOrderingDirection
Link copied to clipboard
abstract fun getOrderingDirection(): Ordering.SortOrder?

Returns the ordering direction to use to lay out the treemap.

getOrderingDirectionProperty
Link copied to clipboard
abstract fun getOrderingDirectionProperty(): MutableProperty<Ordering.SortOrder?>

Returns the ordering direction to use to lay out the treemap.

getOrderingHorizontalVanishingPoint
Link copied to clipboard
abstract fun getOrderingHorizontalVanishingPoint(): Int
getOrderingHorizontalVanishingPointProperty
Link copied to clipboard
abstract fun getOrderingHorizontalVanishingPointProperty(): MutableProperty<Int>
getOrderingProperty
Link copied to clipboard
abstract fun getOrderingProperty(): MutableProperty<Ordering?>

Returns the ordering to use to lay out the treemap.

getOrderingVerticalVanishingPoint
Link copied to clipboard
abstract fun getOrderingVerticalVanishingPoint(): Int
getOrderingVerticalVanishingPointProperty
Link copied to clipboard
abstract fun getOrderingVerticalVanishingPointProperty(): MutableProperty<Int>
getOverrideDefaultsProperty
Link copied to clipboard
abstract fun getOverrideDefaultsProperty(): MutableProperty<Boolean>?
getProperty
Link copied to clipboard
abstract fun getProperty(key: String?): Any?

Gets the value of the specified property.

getPropertyOverride
Link copied to clipboard
abstract fun getPropertyOverride(key: String?): Any?

Gets the value of the specified property. Only returns the overridden value, not the default value if it isn't overridden.

getScale
Link copied to clipboard
abstract fun getScale(): Scale?

Returns the scaling scheme to use to project values the treemap.

getScaleProperty
Link copied to clipboard
abstract fun getScaleProperty(): MutableProperty<Scale?>

Returns the scaling scheme to use to project values the treemap.

getShowLabel
Link copied to clipboard
abstract fun getShowLabel(): Boolean

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

getShowLabelProperty
Link copied to clipboard
abstract fun getShowLabelProperty(): MutableProperty<Boolean>

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

getTooltipFont
Link copied to clipboard
abstract fun getTooltipFont(): MkFont?

Returns the font used for labeling the tooltips.

getTooltipFontProperty
Link copied to clipboard
abstract fun getTooltipFontProperty(): MutableProperty<MkFont?>

Returns the font used for labeling the tooltips.

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

Returns the foreground color to use for drawing the tooltips.

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

Returns the foreground color to use for drawing the tooltips.

getTooltipRendering
Link copied to clipboard
abstract fun getTooltipRendering(): EnhancedLabel.Rendering?
getTooltipRenderingProperty
Link copied to clipboard
abstract fun getTooltipRenderingProperty(): MutableProperty<EnhancedLabel.Rendering?>?
isDefaults
Link copied to clipboard
abstract fun isDefaults(): Boolean

Gets whether the default settings can be overridden by these settings

isOverrideDefaults
Link copied to clipboard
abstract fun isOverrideDefaults(): Boolean

Gets whether the default settings are overridden by these settings

reset
Link copied to clipboard
abstract fun reset()
setAggregation
Link copied to clipboard
abstract fun setAggregation(aggregation: Aggregation?)

Defines the aggregation scheme to use to aggregate values of the treemap.

setAlgorithm
Link copied to clipboard
abstract fun setAlgorithm(algorithm: Algorithm?)

Defines the algorithm to use to lay out the treemap.

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

Sets the color to use for drawing the borders.

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

Sets the thickness used for drawing the borders.

setColorMap
Link copied to clipboard
abstract fun setColorMap(colorMap: MutableColorMap?)

Sets the color map to use for the specified column.

setFormat
Link copied to clipboard
abstract fun setFormat(format: CPFormat<Any?>?)

Sets the format used to display values of the specified column.

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

Sets the background color to use for drawing the headers.

setHeaderEffect
Link copied to clipboard
abstract fun setHeaderEffect(effect: EnhancedLabel.Effect?)
setHeaderEffectColor
Link copied to clipboard
abstract fun setHeaderEffectColor(color: MkColor?)

Sets the background color to use for drawing the headers.

setHeaderEffectOpacity
Link copied to clipboard
abstract fun setHeaderEffectOpacity(opacity: Float?)
setHeaderFont
Link copied to clipboard
abstract fun setHeaderFont(font: MkFont?)

Sets the font used for labeling the headings.

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

Sets the foreground color to use for drawing the headers.

setHeaderHorizontalAlignment
Link copied to clipboard
abstract fun setHeaderHorizontalAlignment(alignment: Int)
setHeaderInsets
Link copied to clipboard
abstract fun setHeaderInsets(insets: Insets?)
setHeaderMinimumCharactersToDisplay
Link copied to clipboard
abstract fun setHeaderMinimumCharactersToDisplay(minimumCharactersToDisplay: Int?)
setHeaderRendering
Link copied to clipboard
abstract fun setHeaderRendering(rendering: EnhancedLabel.Rendering?)
setHeaderVerticalAlignment
Link copied to clipboard
abstract fun setHeaderVerticalAlignment(alignment: Int)
setLabeling
Link copied to clipboard
abstract fun setLabeling(labeling: Labeling?)

Defines the labeling scheme to use to draw the treemap.

setLabelingContrastEnhancement
Link copied to clipboard
abstract fun setLabelingContrastEnhancement(contrastEnhancement: ContrastEnhancement?)
setLabelingEffect
Link copied to clipboard
abstract fun setLabelingEffect(effect: EnhancedLabel.Effect?)
setLabelingEffectColor
Link copied to clipboard
abstract fun setLabelingEffectColor(color: MkColor?)

Sets the effect color to use for drawing the labels.

setLabelingEffectOpacity
Link copied to clipboard
abstract fun setLabelingEffectOpacity(opacity: Float?)
setLabelingFloat
Link copied to clipboard
abstract fun setLabelingFloat(labelingFloat: Boolean?)
setLabelingFont
Link copied to clipboard
abstract fun setLabelingFont(font: MkFont?)

Sets the font used for labeling.

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

Sets the foreground color to use for drawing the labels.

setLabelingHorizontalAlignment
Link copied to clipboard
abstract fun setLabelingHorizontalAlignment(alignment: Int)
setLabelingMinimumCharactersToDisplay
Link copied to clipboard
abstract fun setLabelingMinimumCharactersToDisplay(minimumCharactersToDisplay: Int?)
setLabelingRendering
Link copied to clipboard
abstract fun setLabelingRendering(rendering: EnhancedLabel.Rendering?)
setLabelingResizeTextToFitShape
Link copied to clipboard
abstract fun setLabelingResizeTextToFitShape(labelingResizeTextToFitShape: Boolean)
setLabelingShrinkTextToFitShape
Link copied to clipboard
abstract fun setLabelingShrinkTextToFitShape(labelingShrinkTextToFitShape: Boolean)
setLabelingVerticalAlignment
Link copied to clipboard
abstract fun setLabelingVerticalAlignment(alignment: Int)
setNesting
Link copied to clipboard
abstract fun setNesting(nesting: Nesting?)

Defines the nesting to use to lay out the treemap.

setNestingAmount
Link copied to clipboard
abstract fun setNestingAmount(amount: Double?)

Sets the size of nested areas.

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

Sets the background color to use for drawing the nested areas.

setOrdering
Link copied to clipboard
abstract fun setOrdering(ordering: Ordering?)

Defines the ordering to use to lay out the treemap.

setOrderingDirection
Link copied to clipboard
abstract fun setOrderingDirection(ordering: Ordering.SortOrder?)

Defines the ordering direction to use to lay out the treemap.

setOrderingHorizontalVanishingPoint
Link copied to clipboard
abstract fun setOrderingHorizontalVanishingPoint(alignment: Int)
setOrderingVerticalVanishingPoint
Link copied to clipboard
abstract fun setOrderingVerticalVanishingPoint(verticalVanishingPoint: Int)
setOverrideDefaults
Link copied to clipboard
abstract fun setOverrideDefaults(overrideDefaults: Boolean)

Sets whether the default settings should be overridden by these settings

setProperty
Link copied to clipboard
open override fun setProperty(property: String?, value: Any?)

Sets the value of the specified property.

setScale
Link copied to clipboard
abstract fun setScale(scale: Scale?)

Defines the scaling scheme to use to project values the treemap.

setShowLabel
Link copied to clipboard
abstract fun setShowLabel(show: Boolean)

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

setTooltipFont
Link copied to clipboard
abstract fun setTooltipFont(font: MkFont?)

Sets the font used for labeling the tooltips.

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

Sets the foreground color to use for drawing the tooltips.

setTooltipRendering
Link copied to clipboard
abstract fun setTooltipRendering(rendering: EnhancedLabel.Rendering?)