# TagCloudAlgorithm

interface TagCloudAlgorithm : Algorithm

#### Inheritors

AbstractTagCloudAlgorithm

## Types

Companion
Link copied to clipboard
object Companion
OrientationMode
Link copied to clipboard
enum OrientationMode : Enum<TagCloudAlgorithm.OrientationMode>
Spiral
Link copied to clipboard
enum Spiral : Enum<TagCloudAlgorithm.Spiral>

## Properties

font
Link copied to clipboard
abstract val font: MutableProperty<MkFont?>
isChildContained
Link copied to clipboard
abstract val isChildContained: Boolean
isColorParent
Link copied to clipboard
abstract val isColorParent: Boolean
isRenderingLeafLabelsSupported
Link copied to clipboard
abstract val isRenderingLeafLabelsSupported: Boolean
isRenderingParentLabelSupported
Link copied to clipboard
abstract val isRenderingParentLabelSupported: Boolean
isSpaceFilling
Link copied to clipboard
abstract val isSpaceFilling: Boolean
maxTags
Link copied to clipboard
abstract var maxTags: Int
orientationMode
Link copied to clipboard
abstract val orientationMode: MutableProperty<TagCloudAlgorithm.OrientationMode>
properties
Link copied to clipboard
abstract val properties: MutableProperties<String?>?

Properties for storing layout algorithm specific options.

spiral
Link copied to clipboard
abstract val spiral: MutableProperty<TagCloudAlgorithm.Spiral>

## Functions

breadthFirstLayout
Link copied to clipboard
abstract fun <N, Row, Column> breadthFirstLayout(shape: Shape, parent: N, children: Array<N>, sumSizes: Double, horizontalVanishingPoint: Int, verticalVanishingPoint: Int, accessor: TreeMapAccessor<N>, worker: TreeMapWorker?): Boolean

Arrange the items in the given array to fill the given shape. This is called during the first pass, while traversing the tree top down.

depthFirstLayout
Link copied to clipboard
abstract fun <N, Row, Column> depthFirstLayout(shape: Shape?, parent: N, children: Array<N>, sumSizes: Double, horizontalVanishingPoint: Int, verticalVanishingPoint: Int, accessor: TreeMapAccessor<N>, worker: TreeMapWorker?): Boolean

Arrange the items in the given array to fill the given shape. This is called during the first pass, while traversing the tree from the bottom up.

finishLayout
Link copied to clipboard
abstract fun <N, Row, Column> finishLayout(bounds: Rectangle2D?, model: TreeMapModel<N, Row, Column>?, root: N)

Finish the layout after breadthFirstLayout has completed.

getnSubdivisions
Link copied to clipboard
abstract fun getnSubdivisions(): Int
isCompatible
Link copied to clipboard
abstract fun isCompatible(shape: Shape?): Boolean

Indicates whether the layout algorithm can handle the given geometry of its parent

iterator
Link copied to clipboard
abstract fun <N, Row, Column> iterator(model: TreeMapModel<N, Row, Column>, root: N): Iterable<N>

Controls the order by which the tree should be traversed.

setnSubdivisions
Link copied to clipboard
abstract fun setnSubdivisions(nSubdivisions: Int)
startLayout
Link copied to clipboard
abstract fun <N, Row, Column> startLayout(bounds: Rectangle2D?, model: TreeMapModel<N, Row, Column>, root: N, worker: TreeMapWorker?)

Start the layout before breadthFirstLayout is initiated.