# Package-level declarations

## Types

AbstractAlgorithm
Link copied to clipboard
abstract class AbstractAlgorithm : Algorithm

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

AbstractLabeling
Link copied to clipboard
abstract class AbstractLabeling : Labeling

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

AbstractNesting
Link copied to clipboard
abstract class AbstractNesting : Nesting

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

AbstractRendering
Link copied to clipboard
abstract class AbstractRendering : Rendering

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

AbstractTreeMap
Link copied to clipboard
abstract class AbstractTreeMap<Row, Column> : TreeMap<AbstractTreeMapNode<Row, Column>, Row, Column>

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

AbstractTreeMapColumnSettings
Link copied to clipboard
abstract class AbstractTreeMapColumnSettings : TreeMapColumnSettings
AbstractTreeMapController
Link copied to clipboard
abstract class AbstractTreeMapController<N, Row, Column>(view: TreeMapView<N, Row, Column>) : TreeMapController<N, Row, Column>

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

AbstractTreeMapModel
Link copied to clipboard
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.

AbstractTreeMapNode
Link copied to clipboard
abstract class AbstractTreeMapNode<Row, Column> : MutableTreeMapNode<Column>

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

AbstractTreeMapSettings
Link copied to clipboard
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.

AbstractTreeMapToolTip
Link copied to clipboard
abstract class AbstractTreeMapToolTip<N, Row, Column>(view: TreeMapView<N, Row, Column>) : TreeMapToolTip<N, Row, Column>

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

AbstractTreeMapView
Link copied to clipboard
abstract class AbstractTreeMapView<N, Row, Column>(val headless: Headless) : TreeMapView<N, Row, Column>

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

Aggregation
Link copied to clipboard
interface Aggregation

This interface defines an aggregation scheme.

AggregationFactory
Link copied to clipboard
class AggregationFactory(entries: Aggregation)

Factory class for accessing predefined aggregation schemes.

Algorithm
Link copied to clipboard
interface Algorithm

The interface for all treemap layout algorithms. If you write your own algorithm, it should conform to this interface.

AlgorithmFactory
Link copied to clipboard
open class AlgorithmFactory

Factory class for accessing predefined layout algorithms.

BarAlgorithm
Link copied to clipboard
class BarAlgorithm(marginProportion: Double = 0.0, orientation: BarAlgorithm.Orientation = Orientation.Horizontal) : AbstractAlgorithm
CircularAlgorithm
Link copied to clipboard
class CircularAlgorithm : AbstractAlgorithm

Implementation of the Circular algorithm.

ColoredSurroundLabeling
Link copied to clipboard
class ColoredSurroundLabeling : SurroundLabeling
CombinationGenerator
Link copied to clipboard
object CombinationGenerator
Cushion
Link copied to clipboard
class Cushion

Manage the data and the painting methods for the cushion effect.

CushionRendering
Link copied to clipboard
class CushionRendering : AbstractRendering

Paint leaf nodes with a cushion effect.

DefaultAlgorithmFactory
Link copied to clipboard
object DefaultAlgorithmFactory
DefaultTreeMap
Link copied to clipboard
open class DefaultTreeMap<Row, Column> : AbstractTreeMap<Row, Column>
DefaultTreeMapColumnSettings
Link copied to clipboard
class DefaultTreeMapColumnSettings(colorFactory: MkColorFactory, fontFactory: CPFontFactory, colorMapFactory: ColorMapFactory?) : AbstractTreeMapColumnSettings
DefaultTreeMapController
Link copied to clipboard
class DefaultTreeMapController<Row, Column>(view: TreeMapView<AbstractTreeMapNode<Row, Column>, Row, Column>) : AbstractTreeMapController<AbstractTreeMapNode<Row, Column>, Row, Column>

Default implementation of a TreeMapController.

DefaultTreeMapHeaderRenderer
Link copied to clipboard
class DefaultTreeMapHeaderRenderer<N, Row, Column> : EnhancedLabel, TreeMapHeaderRenderer<N, Row, Column>

The standard class for rendering (displaying) headers in a TreeMapView.

DefaultTreeMapLabelRenderer
Link copied to clipboard
class DefaultTreeMapLabelRenderer<N, Row, Column> : EnhancedLabel, TreeMapLabelRenderer<N, Row, Column>

The standard class for rendering (displaying) labels in a TreeMapView.

DefaultTreeMapModel
Link copied to clipboard
class DefaultTreeMapModel<Row, Column>(dataFrame: DataFrame<Row, Column, Any?>) : AbstractTreeMapModel<Row, Column>

Default implementation of a TreeMapModel. This class provides an easy way to integration with Swing's TableModel.

DefaultTreeMapPopup
Link copied to clipboard
class DefaultTreeMapPopup(view: TreeMapView<*, *, *>) : TreeMapPopup

An implementation of a popup window using straight painting.

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

Default implementation of the TreeMapSettings interface.

DefaultTreeMapToolTip
Link copied to clipboard
class DefaultTreeMapToolTip<N, Row, Column>(view: TreeMapView<N, Row, Column>) : AbstractTreeMapToolTip<N, Row, Column>

Created by luc on 06.05.17.

DefaultTreeMapTooltipRenderer
Link copied to clipboard
class DefaultTreeMapTooltipRenderer<N, Row, Column> : EnhancedLabel, TreeMapTooltipRenderer<N, Row, Column>

The standard class for rendering (displaying) tooltips in a TreeMapView.

DefaultTreeMapView
Link copied to clipboard
class DefaultTreeMapView<N, Row, Column> : AbstractTreeMapView<N, Row, Column>

Default implementation of a TreeMapView.

Depth
Link copied to clipboard
interface Depth

Indicates whether a given depth should be displayed or not.

DepthFactory
Link copied to clipboard
class DepthFactory

Factory class for accessing predefined depth schemes.

EqualCirclesInCircle
Link copied to clipboard
object EqualCirclesInCircle
ExpandLabeling
Link copied to clipboard
class ExpandLabeling : AbstractLabeling

Display the label of the parent nodes in the center of its children (overlaid).

FlatNoBorderRendering
Link copied to clipboard
class FlatNoBorderRendering : FlatRendering

Paint leaf nodes with their color and without border.

FlatRendering
Link copied to clipboard
open class FlatRendering : AbstractRendering

Paint leaf nodes according to their color and with a border around them.

Function
Link copied to clipboard
interface Function<T, U>
IcicleAlgorithm
Link copied to clipboard
class IcicleAlgorithm : AbstractAlgorithm
Itertools
Link copied to clipboard
object Itertools
JsTreeMap
Link copied to clipboard
class JsTreeMap(elementId: String, model: DefaultTreeMapModel<Int, String>?) : DefaultTreeMap<Int, String>
Labeling
Link copied to clipboard
interface Labeling

Defines how parent and leaf nodes should be labeled.

LabelingFactory
Link copied to clipboard
class LabelingFactory

Factory class for accessing predefined labeling schemes.

LeafTreeMapNode
Link copied to clipboard
class LeafTreeMapNode<Row, Column>(row: Row, model: TreeMapModel<AbstractTreeMapNode<Row, Column>, Row, Column>) : AbstractTreeMapNode<Row, Column> , Comparable<AbstractTreeMapNode<Row, Column>>

A leaf node.

MutableAlgorithmOverrideProperty
Link copied to clipboard
class MutableAlgorithmOverrideProperty(overrideDefaults: MutableProperty<Boolean>, defaultProperty: MutableProperty<Algorithm?>) : OverrideProperty<Algorithm?>
MutableAlgorithmProperty
Link copied to clipboard
class MutableAlgorithmProperty(algorithm: Algorithm?) : AbstractMutableProperty<Algorithm?>
MutableTreeMapNode
Link copied to clipboard
interface MutableTreeMapNode<out Column> : TreeMapNode<Column>

Defines the requirements for a TreeMapNode that can change.

Nesting
Link copied to clipboard
interface Nesting

Defines extra spacing between levels of the hierarchy.

NestingFactory
Link copied to clipboard
class NestingFactory

Factory class for accessing predefined nesting schemes.

NumericTransformScale
Link copied to clipboard
class NumericTransformScale(transform: NumericTransform) : Scale
Ordering
Link copied to clipboard
interface Ordering

Defines the order of the nodes to be laid out by the treemap algorithm.

OrderingFactory
Link copied to clipboard
class OrderingFactory

Factory class for accessing predefined ordering schemes.

OverlayLabeling
Link copied to clipboard
class OverlayLabeling : AbstractLabeling

Display the labels right on top of its children.

OverridingTreeMapColumnSettings
Link copied to clipboard
class OverridingTreeMapColumnSettings(defaultSettings: TreeMapColumnSettings) : AbstractTreeMapColumnSettings
Pair
Link copied to clipboard
class Pair<L, R>(left: L, right: R)
ParentTreeMapNode
Link copied to clipboard
class ParentTreeMapNode<Row, Column>(name: Any, model: TreeMapModel<AbstractTreeMapNode<Row, Column>, Row, Column>, groupByColumn: Column?, childrenGroupByColumn: Column?) : AbstractTreeMapNode<Row, Column>

A parent node.

PermutationGenerator
Link copied to clipboard
object PermutationGenerator
PieAlgorithm
Link copied to clipboard
class PieAlgorithm : AbstractAlgorithm
PivotByAlgorithm
Link copied to clipboard
class PivotByAlgorithm(type: PivotByAlgorithm.Type = SplitSize()) : AbstractAlgorithm

Implementation of the Pivot By algorithm. It is described in:

Predicate
Link copied to clipboard
interface Predicate<T>
Progressive
Link copied to clipboard
enum Progressive : Enum<Progressive>
RectangularTransform
Link copied to clipboard
class RectangularTransform

This is a transform that only scales and translates. It is a subset of an `AffineTransform`, except with no rotation/shearing.

Rendering
Link copied to clipboard
interface Rendering

Defines how nodes should be rendered on the display.

RenderingFactory
Link copied to clipboard
class RenderingFactory

Factory class for accessing predefined rendering schemes.

Scale
Link copied to clipboard
interface Scale

Defines how values should be transformed to determine their proportional size.

ScaleFactory
Link copied to clipboard
class ScaleFactory

Factory class for accessing predefined scaling schemes.

SizeOrColorOrdering
Link copied to clipboard
class SizeOrColorOrdering : Ordering

Order nodes according to their size.

SliceAndDiceAlgorithm
Link copied to clipboard
class SliceAndDiceAlgorithm(orientationStrategy: SliceAndDiceAlgorithm.OrientationStragegy = AlternateOrientationStrategy()) : AbstractAlgorithm

Implementation of the Slice-and-dice algorithm described in the original treemap paper. It is described in:

SquarifiedAlgorithm
Link copied to clipboard
class SquarifiedAlgorithm : AbstractAlgorithm

Implementation of the Squarified algorithm. It is described in:

SquarifiedPlusAlgorithm
Link copied to clipboard
class SquarifiedPlusAlgorithm : AbstractAlgorithm

Implementation of the Squarified+ algorithm. It is described in:

SunburstAlgorithm
Link copied to clipboard
class SunburstAlgorithm : AbstractAlgorithm
SurroundLabeling
Link copied to clipboard
open class SurroundLabeling : AbstractLabeling

Display the label of the parent node above its children.

ThreeDTreeMapView
Link copied to clipboard
interface ThreeDTreeMapView<N, Row, Column, C> : CPComponent
ToolTipTreeMapRenderer
Link copied to clipboard
class ToolTipTreeMapRenderer<N, Row, Column>

Renderer for displaying information about the node under the mouse (tooltip).

TreeMap
Link copied to clipboard
interface TreeMap<N, Row, Column>

Created by luc on 03/02/16.

TreeMapAccessor
Link copied to clipboard
actual interface TreeMapAccessor<in N>
expect interface TreeMapAccessor<in N>
actual interface TreeMapAccessor<in N>
actual external interface TreeMapAccessor<in N>
TreeMapColorMapPanelModel
Link copied to clipboard
class TreeMapColorMapPanelModel<C>(model: TreeMapModel<*, *, C>) : ColorMapPanelModel<C>
TreeMapColumnSettings
Link copied to clipboard
interface TreeMapColumnSettings
TreeMapController
Link copied to clipboard
interface TreeMapController<N, Row, Column>

Control the user interactions with the view.

TreeMapEvent
Link copied to clipboard
class TreeMapEvent(val isGroupByChanged: Boolean, val isLayoutChanged: Boolean, val isColorsChanged: Boolean)

An event that characterizes a change in the treemap model.

TreeMapFilterCoordinator
Link copied to clipboard
class TreeMapFilterCoordinator<Row, N>(filter: MutableFilter<Row>, model: TreeMapModel<N, Row, *>, val getRow: (N) -> Row) : AbstractFilterCoordinator<Row, N>
TreeMapHeaderRenderer
Link copied to clipboard
interface TreeMapHeaderRenderer<N, Row, Column>

This interface defines the method required to render headers in a TreeMapView.

TreeMapLabelRenderer
Link copied to clipboard
interface TreeMapLabelRenderer<N, Row, Column>

This interface defines the method required to render labels in a TreeMapView.

TreeMapListener
Link copied to clipboard
interface TreeMapListener

The listener that's notified when the treemap model changes.

TreeMapModel
Link copied to clipboard
interface TreeMapModel<N, Row, Column> : TreeMapAccessor<N>

Main interface for the model part of TreeMap.

TreeMapNode
Link copied to clipboard
interface TreeMapNode<out Column>

Interface representing an object that can be placed in a treemap layout.

TreeMapPanel
Link copied to clipboard
interface TreeMapPanel : CPComponent
TreeMapPopup
Link copied to clipboard
interface TreeMapPopup

A popup window (typically to display tooltips)

TreeMapProbingCoordinator
Link copied to clipboard
class TreeMapProbingCoordinator<Row, N>(probing: MutableSingleSelection<Row>, model: TreeMapModel<N, Row, *>, val getRow: (N) -> Row) : AbstractSingleSelectionCoordinator<Row, N?>
TreeMapProps
Link copied to clipboard
external interface TreeMapProps : Props
TreeMapRenderer
Link copied to clipboard
interface TreeMapRenderer<N, Row, Column>

Interface for stepwise rendering of a TreeMapView.

TreeMapSelectionCoordinator
Link copied to clipboard
class TreeMapSelectionCoordinator<Row, N>(selection: MutableSelection<Row>, model: TreeMapModel<N, Row, *>, val getRow: (N) -> Row) : AbstractSelectionCoordinator<Row, N>
TreeMapSettings
Link copied to clipboard
interface TreeMapSettings<Column>

Keep track of all the settings that can be applied to a treemap.

TreeMapSettingsEvent
Link copied to clipboard
class TreeMapSettingsEvent(updateGroupBy: Boolean, updateLayout: Boolean, updateColors: Boolean)

An event that characterizes a change in the settings.

TreeMapSettingsListener
Link copied to clipboard
interface TreeMapSettingsListener

The listener interface for receiving "interesting" events about changes in the settings.

TreeMapToolTip
Link copied to clipboard
interface TreeMapToolTip<N, Row, Column>

This abstract class defines the method required to display tooltips in a TreeMapView.

TreeMapTooltipRenderer
Link copied to clipboard
interface TreeMapTooltipRenderer<N, Row, Column>

This interface defines the method required to render tooltip values in a TreeMapView.

TreeMapView
Link copied to clipboard
interface TreeMapView<N, Row, Column>

Main interface for the view part of TreeMap.

TreeMapWorker
Link copied to clipboard
interface TreeMapWorker

Interface used when performing treemap updates.

## Properties

TreeMapComponent
Link copied to clipboard
val TreeMapComponent: ComponentType<TreeMapProps>

## Functions

copyFromSize
Link copied to clipboard
fun <T> Array<T>.copyFromSize(from: Int, size: Int): Array<T>
getTreeMapComponent
Link copied to clipboard
fun getTreeMapComponent(): dynamic