Package com.treemap

# Interface TreeMapSettings<N,Column,Color,Font>

All Known Implementing Classes:
  `AbstractTreeMapSettings`, `DefaultTreeMapSettings`

@JsType public interface TreeMapSettings<N,Column,Color,Font>
Keep track of all the settings that can be applied to a treemap.

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Interface
  Description
  `static enum`
  `TreeMapSettings.PropertyType`

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final String`
  `PROPERTY_BACKGROUND`
  `static final String`
  `PROPERTY_BACKGROUND_FIELD`
  `static final String`
  `PROPERTY_COLOR_FIELD`
  `static final String`
  `PROPERTY_DEPTH`
  `static final String`
  `PROPERTY_DIMENSION`
  `static final String`
  `PROPERTY_DIMENSION_FIXED`
  `static final String`
  `PROPERTY_GROUP_BY_FIELD`
  `static final String`
  `PROPERTY_HEIGHT_FIELD`
  `static final String`
  `PROPERTY_HIDE_FILTER_RESULTS`
  `static final String`
  `PROPERTY_HIDE_SEARCH_RESULTS`
  `static final String`
  `PROPERTY_LABELS_FIELD`
  `static final String`
  `PROPERTY_LIGHT_SOURCE_AMBIENT`
  `static final String`
  `PROPERTY_LIGHT_SOURCE_HEIGHT`
  `static final String`
  `PROPERTY_LIGHT_SOURCE_X`
  `static final String`
  `PROPERTY_LIGHT_SOURCE_Y`
  `static final String`
  `PROPERTY_LIGHT_SOURCE_Z`
  `static final String`
  `PROPERTY_MAXIMUM_HEIGHT`
  `static final String`
  `PROPERTY_PROBING_COLOR`
  `static final String`
  `PROPERTY_RENDERING`
  `static final String`
  `PROPERTY_SELECTION_COLOR`
  `static final String`
  `PROPERTY_SIZE_FIELD`
  `static final String`
  `PROPERTY_TOOLTIP_BACKGROUND`
  `static final String`
  `PROPERTY_TOOLTIP_FIELD`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addTreeMapSettingsListener(TreeMapSettingsListener listener)`
  Add a listener for receiving interesting events about changes in the settings.
  `com.macrofocus.igraphics.CPColor<Color>`
  `getBackground()`
  Returns the background color to use for drawing the treemap.
  `MutableProperty<com.macrofocus.igraphics.CPColor<Color>>`
  `getBackgroundProperty()`
  Returns the background color to use for drawing the treemap.
  `TreeMapField<N,Column>`
  `getBackgroundTreeMapField()`
  Gets the model used to hold the field used to display the background label.
  `MutableSingleSelection<TreeMapField>`
  `getBackgroundVariableSelection()`
  `TreeMapField<N,Column>`
  `getColorTreeMapField()`
  Gets the model used to hold the field used to represent the color.
  `MutableSingleSelection<TreeMapField>`
  `getColorVariableSelection()`
  `TreeMapFieldSettings<Color,Font>`
  `getDefaultFieldSettings()`
  `Depth`
  `getDepth()`
  Returns the depth to use to lay out the treemap.
  `MutableSingleSelection<Depth>`
  `getDepthSelection()`
  `Dimension`
  `getDimension()`
  Gets the size of the treemap.
  `Boolean`
  `getDimensionFixed()`
  `TreeMapFieldSettings<Color,Font>`
  `getFieldSettings(TreeMapField field)`
  `TreeMapField<N,Column>[]`
  `getGroupByTreeMapFields()`
  Gets the model used to hold the list of fields to be use for grouping.
  `MutableSelection<TreeMapField>`
  `getGroupByVariablesSelection()`
  `TreeMapField<N,Column>`
  `getHeightTreeMapField()`
  Gets the model used to hold the field used to represent the height.
  `MutableSingleSelection<TreeMapField>`
  `getHeightVariableSelection()`
  `MutableProperty<Boolean>`
  `getHideFilterResultsSelection()`
  `MutableProperty<Boolean>`
  `getHideSearchResultsSelection()`
  `TreeMapField<N,Column>[]`
  `getLabelTreeMapFields()`
  Gets the model used to hold the list of fields to be use for labeling.
  `MutableSelection<TreeMapField>`
  `getLabelVariablesSelection()`
  `double`
  `getLightSourceAmbient()`
  Returns the light source ambient intensity used for drawing the cushions.
  `MutableBoundedInterval`
  `getLightSourceAmbientInterval()`
  `double`
  `getLightSourceHeight()`
  Returns the light source height used for drawing the cushions.
  `MutableBoundedInterval`
  `getLightSourceHeightInterval()`
  `double`
  `getLightSourceX()`
  Returns the light source X position used for drawing the cushions.
  `MutableBoundedInterval`
  `getLightSourceXInterval()`
  `double`
  `getLightSourceY()`
  Returns the light source Y position used for drawing the cushions.
  `MutableBoundedInterval`
  `getLightSourceYInterval()`
  `double`
  `getLightSourceZ()`
  Returns the light source Z position used for drawing the cushions.
  `MutableBoundedInterval`
  `getLightSourceZInterval()`
  `double`
  `getMaximumHeight()`
  Gets the maximum height.
  `MutableBoundedInterval`
  `getMaximumHeightInterval()`
  Gets the model indicating the maximum height.
  `com.macrofocus.igraphics.CPColor<Color>`
  `getProbingColor()`
  Returns the color to use for drawing the borders.
  `MutableProperty<com.macrofocus.igraphics.CPColor<Color>>`
  `getProbingColorProperty()`
  Returns the color to use for drawing the borders.
  `TreeMapView.Progressive`
  `getProgressive()`
  `MutableSingleSelection<TreeMapView.Progressive>`
  `getProgressiveSelection()`
  `MutableProperties<String>`
  `getProperties()`
  `Rendering`
  `getRendering()`
  Returns the rendering scheme to use to draw the treemap.
  `MutableSingleSelection<Rendering>`
  `getRenderingSelection()`
  `com.macrofocus.igraphics.CPColor<Color>`
  `getSelectionColor()`
  Returns the color to use for drawing the borders.
  `MutableProperty<com.macrofocus.igraphics.CPColor<Color>>`
  `getSelectionColorProperty()`
  Returns the color to use for drawing the borders.
  `boolean`
  `getShowPopup(TreeMapField field)`
  Tells whether the specified field should be shown in the popup.
  `TreeMapField<N,Column>`
  `getSizeTreeMapField()`
  Gets the model used to hold the field used to represent the size.
  `MutableSingleSelection<TreeMapField>`
  `getSizeVariableSelection()`
  `com.macrofocus.igraphics.CPColor<Color>`
  `getTooltipBackground()`
  Returns the background color to use for drawing the tooltips.
  `MutableProperty<com.macrofocus.igraphics.CPColor<Color>>`
  `getTooltipBackgroundProperty()`
  Returns the background color to use for drawing the tooltips.
  `TreeMapField<N,Column>[]`
  `getToolTipTreeMapFields()`
  Gets the model used to hold the list of fields to be use by the tooltip.
  `MutableSelection<TreeMapField>`
  `getTooltipVariablesSelection()`
  `Object`
  `getValue(String key)`
  Gets the value of the specified property.
  `Boolean`
  `isHideFilterResults()`
  Gets the model used to indicate whether filtered nodes should be hidden.
  `Boolean`
  `isHideSearchResults()`
  Gets the model used to indicate whether nodes that do not match the search criteria should be hidden.
  `void`
  `removeTreeMapSettingsListener(TreeMapSettingsListener listener)`
  Remove a listener from the list of listeners that should be notified about changes in the settings.
  `void`
  `removeTreeMapSettingsListeners()`
  Remove all the listener from the list of listeners that should be notified about changes in the settings.
  `void`
  `resetToDefaults()`
  `void`
  `save(com.macrofocus.molap.dataframe.DataFrame dataFrame, ElementFactory elementFactory, Element root)`
  `void`
  `setBackground(int column)`
  Defines the field to use for background labeling.
  `void`
  `setBackground(com.macrofocus.igraphics.CPColor<Color> color)`
  Sets the background color to use for drawing the treemap.
  `void`
  `setBackgroundByName(String columnName)`
  Defines the field to use for background labeling.
  `void`
  `setBackgroundTreeMapField(TreeMapField field)`
  `void`
  `setColor(int column)`
  Defines the field to use for coloring.
  `void`
  `setColorByName(String columnName)`
  Defines the field to use for coloring.
  `void`
  `setColorTreeMapField(TreeMapField field)`
  `void`
  `setDepth(Depth depth)`
  Defines the depth to use to lay out the treemap.
  `void`
  `setDimension(Dimension dimension)`
  Sets the size of the treemap.
  `void`
  `setDimensionFixed(Boolean fixed)`
  `void`
  `setGroupBy(int... columns)`
  Defines the fields to be use for grouping.
  `void`
  `setGroupByByNames(String... columnNames)`
  Defines the fields to be use for grouping.
  `void`
  `setGroupByTreeMapFields(TreeMapField<N,Column>[] fields)`
  `void`
  `setHeight(int column)`
  Defines the field to use for mapping the height.
  `void`
  `setHeightByName(String columnName)`
  Defines the field to use for mapping the height.
  `void`
  `setHeightTreeMapField(TreeMapField field)`
  `void`
  `setHideFilterResults(Boolean hideFilterResults)`
  `void`
  `setHideSearchResults(Boolean hideSearchResults)`
  `void`
  `setLabels(int... columns)`
  Defines the fields to be use for labeling.
  `void`
  `setLabelsByNames(String... columnNames)`
  Defines the fields to be use for labeling.
  `void`
  `setLabelTreeMapFields(TreeMapField<N,Column>[] fields)`
  `void`
  `setLightSourceAmbient(double value)`
  Sets the light source ambient intensity used for drawing the cushions.
  `void`
  `setLightSourceHeight(double value)`
  Sets the light source height used for drawing the cushions.
  `void`
  `setLightSourceX(double value)`
  Sets the light source X position used for drawing the cushions.
  `void`
  `setLightSourceY(double value)`
  Sets the light source Y position used for drawing the cushions.
  `void`
  `setLightSourceZ(double value)`
  Sets the light source Z position used for drawing the cushions.
  `void`
  `setMaximumHeight(double height)`
  Sets the maximum height.
  `void`
  `setProbingColor(com.macrofocus.igraphics.CPColor<Color> color)`
  Sets the color to use for drawing the borders.
  `void`
  `setProgressive(TreeMapView.Progressive progressive)`
  `void`
  `setRendering(Rendering rendering)`
  Defines the rendering scheme to use to draw the treemap.
  `void`
  `setSelectionColor(com.macrofocus.igraphics.CPColor<Color> color)`
  Sets the color to use for drawing the borders.
  `void`
  `setShowPopup(TreeMapField field, boolean show)`
  Sets whether the specified field should be displayed or no in the popup.
  `void`
  `setSize(int column)`
  Defines the field to use to represent the size.
  `void`
  `setSizeByName(String columnName)`
  Defines the field to use to represent the size.
  `void`
  `setSizeTreeMapField(TreeMapField field)`
  `void`
  `setToolTip(int... columns)`
  Defines the fields to be use for the tooltip.
  `void`
  `setTooltipBackground(com.macrofocus.igraphics.CPColor<Color> color)`
  Sets the background color to use for drawing the tooltips.
  `void`
  `setToolTipByNames(String... columnNames)`
  Defines the fields to be use for the tooltip.
  `void`
  `setToolTipTreeMapFields(TreeMapField<N,Column>[] fields)`

- ## Field Details

  - ### PROPERTY_SIZE_FIELD

    static final String PROPERTY_SIZE_FIELD
    See Also:
      - Constant Field Values

  - ### PROPERTY_COLOR_FIELD

    static final String PROPERTY_COLOR_FIELD
    See Also:
      - Constant Field Values

  - ### PROPERTY_LABELS_FIELD

    static final String PROPERTY_LABELS_FIELD
    See Also:
      - Constant Field Values

  - ### PROPERTY_TOOLTIP_FIELD

    static final String PROPERTY_TOOLTIP_FIELD
    See Also:
      - Constant Field Values

  - ### PROPERTY_BACKGROUND_FIELD

    static final String PROPERTY_BACKGROUND_FIELD
    See Also:
      - Constant Field Values

  - ### PROPERTY_HEIGHT_FIELD

    static final String PROPERTY_HEIGHT_FIELD
    See Also:
      - Constant Field Values

  - ### PROPERTY_GROUP_BY_FIELD

    static final String PROPERTY_GROUP_BY_FIELD
    See Also:
      - Constant Field Values

  - ### PROPERTY_DEPTH

    static final String PROPERTY_DEPTH
    See Also:
      - Constant Field Values

  - ### PROPERTY_RENDERING

    static final String PROPERTY_RENDERING
    See Also:
      - Constant Field Values

  - ### PROPERTY_BACKGROUND

    static final String PROPERTY_BACKGROUND
    See Also:
      - Constant Field Values

  - ### PROPERTY_TOOLTIP_BACKGROUND

    static final String PROPERTY_TOOLTIP_BACKGROUND
    See Also:
      - Constant Field Values

  - ### PROPERTY_PROBING_COLOR

    static final String PROPERTY_PROBING_COLOR
    See Also:
      - Constant Field Values

  - ### PROPERTY_SELECTION_COLOR

    static final String PROPERTY_SELECTION_COLOR
    See Also:
      - Constant Field Values

  - ### PROPERTY_HIDE_SEARCH_RESULTS

    static final String PROPERTY_HIDE_SEARCH_RESULTS
    See Also:
      - Constant Field Values

  - ### PROPERTY_HIDE_FILTER_RESULTS

    static final String PROPERTY_HIDE_FILTER_RESULTS
    See Also:
      - Constant Field Values

  - ### PROPERTY_DIMENSION

    static final String PROPERTY_DIMENSION
    See Also:
      - Constant Field Values

  - ### PROPERTY_DIMENSION_FIXED

    static final String PROPERTY_DIMENSION_FIXED
    See Also:
      - Constant Field Values

  - ### PROPERTY_MAXIMUM_HEIGHT

    static final String PROPERTY_MAXIMUM_HEIGHT
    See Also:
      - Constant Field Values

  - ### PROPERTY_LIGHT_SOURCE_HEIGHT

    static final String PROPERTY_LIGHT_SOURCE_HEIGHT
    See Also:
      - Constant Field Values

  - ### PROPERTY_LIGHT_SOURCE_AMBIENT

    static final String PROPERTY_LIGHT_SOURCE_AMBIENT
    See Also:
      - Constant Field Values

  - ### PROPERTY_LIGHT_SOURCE_X

    static final String PROPERTY_LIGHT_SOURCE_X
    See Also:
      - Constant Field Values

  - ### PROPERTY_LIGHT_SOURCE_Y

    static final String PROPERTY_LIGHT_SOURCE_Y
    See Also:
      - Constant Field Values

  - ### PROPERTY_LIGHT_SOURCE_Z

    static final String PROPERTY_LIGHT_SOURCE_Z
    See Also:
      - Constant Field Values

- ## Method Details

  - ### getProperties

    MutableProperties<String> getProperties()

  - ### getDimensionFixed

    Boolean getDimensionFixed()

  - ### setDimensionFixed

    void setDimensionFixed(Boolean fixed)

  - ### getDimension

    @JsIgnore Dimension getDimension()
    Gets the size of the treemap.
    Returns:
      the size of the treemap.

  - ### setDimension

    @JsIgnore void setDimension(Dimension dimension)
    Sets the size of the treemap.
    Parameters:
      `dimension` - the size of the treemap.

  - ### getProgressive

    @JsIgnore TreeMapView.Progressive getProgressive()

  - ### setProgressive

    @JsIgnore void setProgressive(TreeMapView.Progressive progressive)

  - ### getGroupByTreeMapFields

    TreeMapField<N,Column>[] getGroupByTreeMapFields()
    Gets the model used to hold the list of fields to be use for grouping.
    Returns:
      the model of fields to be use for grouping

  - ### setGroupByTreeMapFields

    void setGroupByTreeMapFields(TreeMapField<N,Column>[] fields)

  - ### getSizeTreeMapField

    TreeMapField<N,Column> getSizeTreeMapField()
    Gets the model used to hold the field used to represent the size.
    Returns:
      the model holding the field that represent the size.

  - ### getColorTreeMapField

    TreeMapField<N,Column> getColorTreeMapField()
    Gets the model used to hold the field used to represent the color.
    Returns:
      the model holding the field that represent the color.

  - ### getLabelTreeMapFields

    TreeMapField<N,Column>[] getLabelTreeMapFields()
    Gets the model used to hold the list of fields to be use for labeling.
    Returns:
      the model of fields to be use for labeling.

  - ### setLabelTreeMapFields

    void setLabelTreeMapFields(TreeMapField<N,Column>[] fields)

  - ### getToolTipTreeMapFields

    TreeMapField<N,Column>[] getToolTipTreeMapFields()
    Gets the model used to hold the list of fields to be use by the tooltip.
    Returns:
      the model of fields to be use by the tooltip.

  - ### setToolTipTreeMapFields

    void setToolTipTreeMapFields(TreeMapField<N,Column>[] fields)

  - ### getBackgroundTreeMapField

    TreeMapField<N,Column> getBackgroundTreeMapField()
    Gets the model used to hold the field used to display the background label.
    Returns:
      the model holding the field of the the background label.

  - ### getHeightTreeMapField

    TreeMapField<N,Column> getHeightTreeMapField()
    Gets the model used to hold the field used to represent the height.
    Returns:
      the model holding the field that represent the height.

  - ### isHideFilterResults

    Boolean isHideFilterResults()
    Gets the model used to indicate whether filtered nodes should be hidden.
    Returns:
      the model indicating whether filtered nodes should be hidden.

  - ### setHideFilterResults

    void setHideFilterResults(Boolean hideFilterResults)

  - ### isHideSearchResults

    Boolean isHideSearchResults()
    Gets the model used to indicate whether nodes that do not match the search criteria should be hidden.
    Returns:
      the model indicating whether nodes that do not match the search criteria should be hidden.

  - ### setHideSearchResults

    void setHideSearchResults(Boolean hideSearchResults)

  - ### getMaximumHeightInterval

    MutableBoundedInterval getMaximumHeightInterval()
    Gets the model indicating the maximum height.
    Returns:
      the model holding the maximum height.

  - ### getMaximumHeight

    double getMaximumHeight()
    Gets the maximum height.
    Returns:
      the maximum height.

  - ### setMaximumHeight

    void setMaximumHeight(double height)
    Sets the maximum height.
    Parameters:
      `height` - the maximum height.

  - ### setGroupBy

    void setGroupBy(int... columns)
    Defines the fields to be use for grouping.
    Parameters:
      `columns` - the indexes of the columns to be used for grouping
    See Also:
      - `DefaultTreeMapSettings.getGroupByTreeMapFields()`

  - ### setGroupByByNames

    void setGroupByByNames(String... columnNames)
    Defines the fields to be use for grouping.
    Parameters:
      `columnNames` - the names of the columns to be used for grouping
    See Also:
      - `DefaultTreeMapSettings.getGroupByTreeMapFields()`

  - ### setLabels

    void setLabels(int... columns)
    Defines the fields to be use for labeling.
    Parameters:
      `columns` - the indexes of the columns to be used for labeling
    See Also:
      - `DefaultTreeMapSettings.getLabelTreeMapFields()`

  - ### setLabelsByNames

    void setLabelsByNames(String... columnNames)
    Defines the fields to be use for labeling.
    Parameters:
      `columnNames` - the names of the columns to be used for labeling
    See Also:
      - `DefaultTreeMapSettings.getLabelTreeMapFields()`

  - ### setToolTip

    void setToolTip(int... columns)
    Defines the fields to be use for the tooltip.
    Parameters:
      `columns` - the indexes of the columns to be used for labeling
    See Also:
      - `DefaultTreeMapSettings.getLabelTreeMapFields()`

  - ### setToolTipByNames

    void setToolTipByNames(String... columnNames)
    Defines the fields to be use for the tooltip.
    Parameters:
      `columnNames` - the names of the columns to be used for labeling
    See Also:
      - `DefaultTreeMapSettings.getLabelTreeMapFields()`

  - ### setBackground

    void setBackground(int column)
    Defines the field to use for background labeling.
    Parameters:
      `column` - the index of the column to be used for background labeling
    See Also:
      - `DefaultTreeMapSettings.getBackgroundTreeMapField()`

  - ### setBackgroundByName

    void setBackgroundByName(String columnName)
    Defines the field to use for background labeling.
    Parameters:
      `columnName` - the name of the column to be used for background labeling
    See Also:
      - `DefaultTreeMapSettings.getBackgroundTreeMapField()`

  - ### setSize

    void setSize(int column)
    Defines the field to use to represent the size.
    Parameters:
      `column` - the index of the column to be used for representing the size
    See Also:
      - `DefaultTreeMapSettings.getSizeTreeMapField()`

  - ### setSizeByName

    void setSizeByName(String columnName)
    Defines the field to use to represent the size.
    Parameters:
      `columnName` - the name of the column to be used for representing the size
    See Also:
      - `DefaultTreeMapSettings.getSizeTreeMapField()`

  - ### setColor

    void setColor(int column)
    Defines the field to use for coloring.
    Parameters:
      `column` - the index of the column to be used for coloring
    See Also:
      - `DefaultTreeMapSettings.getColorTreeMapField()`

  - ### setColorByName

    void setColorByName(String columnName)
    Defines the field to use for coloring.
    Parameters:
      `columnName` - the name of the column to be used for coloring
    See Also:
      - `DefaultTreeMapSettings.getColorTreeMapField()`

  - ### setHeight

    void setHeight(int column)
    Defines the field to use for mapping the height.
    Parameters:
      `column` - the index of the column to be used for mapping the height
    See Also:
      - `DefaultTreeMapSettings.getHeightTreeMapField()`

  - ### setHeightByName

    void setHeightByName(String columnName)
    Defines the field to use for mapping the height.
    Parameters:
      `columnName` - the name of the column to be used for mapping the height
    See Also:
      - `DefaultTreeMapSettings.getHeightTreeMapField()`

  - ### setHeightTreeMapField

    void setHeightTreeMapField(TreeMapField field)

  - ### setColorTreeMapField

    void setColorTreeMapField(TreeMapField field)

  - ### setSizeTreeMapField

    void setSizeTreeMapField(TreeMapField field)

  - ### setBackgroundTreeMapField

    void setBackgroundTreeMapField(TreeMapField field)

  - ### getDepth

    @JsIgnore Depth getDepth()
    Returns the depth to use to lay out the treemap.
    Returns:
      the depth to use
    See Also:
      - `DefaultTreeMapSettings.getDepth()`
      - `DepthFactory`

  - ### setDepth

    @JsIgnore void setDepth(Depth depth)
    Defines the depth to use to lay out the treemap.
    Parameters:
      `depth` - the depth to use
    See Also:
      - `DefaultTreeMapSettings.getDepth()`
      - `DepthFactory`

  - ### getRendering

    @JsIgnore Rendering getRendering()
    Returns the rendering scheme to use to draw the treemap.
    Returns:
      the rendering scheme to use
    See Also:
      - `DefaultTreeMapSettings.getRendering()`
      - `RenderingFactory`

  - ### setRendering

    void setRendering(Rendering rendering)
    Defines the rendering scheme to use to draw the treemap.
    Parameters:
      `rendering` - the rendering scheme to use
    See Also:
      - `DefaultTreeMapSettings.getRendering()`
      - `RenderingFactory`

  - ### getLightSourceHeight

    double getLightSourceHeight()
    Returns the light source height used for drawing the cushions.
    Returns:
      the height
    See Also:
      - `DefaultTreeMapSettings.getLightSourceHeight()`

  - ### setLightSourceHeight

    void setLightSourceHeight(double value)
    Sets the light source height used for drawing the cushions.
    Parameters:
      `value` - the height
    See Also:
      - `DefaultTreeMapSettings.getLightSourceHeight()`

  - ### getLightSourceAmbient

    double getLightSourceAmbient()
    Returns the light source ambient intensity used for drawing the cushions.
    Returns:
      the ambient intensity
    See Also:
      - `DefaultTreeMapSettings.getLightSourceAmbient()`

  - ### setLightSourceAmbient

    void setLightSourceAmbient(double value)
    Sets the light source ambient intensity used for drawing the cushions.
    Parameters:
      `value` - the ambient intensity
    See Also:
      - `DefaultTreeMapSettings.getLightSourceAmbient()`

  - ### getLightSourceX

    double getLightSourceX()
    Returns the light source X position used for drawing the cushions.
    Returns:
      the X position
    See Also:
      - `DefaultTreeMapSettings.getLightSourceX()`

  - ### setLightSourceX

    void setLightSourceX(double value)
    Sets the light source X position used for drawing the cushions.
    Parameters:
      `value` - the X position
    See Also:
      - `DefaultTreeMapSettings.getLightSourceX()`

  - ### getLightSourceY

    double getLightSourceY()
    Returns the light source Y position used for drawing the cushions.
    Returns:
      the Y position
    See Also:
      - `DefaultTreeMapSettings.getLightSourceY()`

  - ### setLightSourceY

    void setLightSourceY(double value)
    Sets the light source Y position used for drawing the cushions.
    Parameters:
      `value` - the Y position
    See Also:
      - `DefaultTreeMapSettings.getLightSourceY()`

  - ### getLightSourceZ

    double getLightSourceZ()
    Returns the light source Z position used for drawing the cushions.
    Returns:
      the Z position
    See Also:
      - `DefaultTreeMapSettings.getLightSourceZ()`

  - ### setLightSourceZ

    void setLightSourceZ(double value)
    Sets the light source Z position used for drawing the cushions.
    Parameters:
      `value` - the Z position
    See Also:
      - `DefaultTreeMapSettings.getLightSourceZ()`

  - ### getBackgroundProperty

    @JsIgnore MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getBackgroundProperty()
    Returns the background color to use for drawing the treemap.
    Returns:
      the color to be used

  - ### getBackground

    @JsIgnore com.macrofocus.igraphics.CPColor<Color> getBackground()
    Returns the background color to use for drawing the treemap.
    Returns:
      the color to be used

  - ### setBackground

    @JsIgnore void setBackground(com.macrofocus.igraphics.CPColor<Color> color)
    Sets the background color to use for drawing the treemap.
    Parameters:
      `color` - the color to be used
    See Also:
      - `DefaultTreeMapSettings.getBackground()`

  - ### getTooltipBackgroundProperty

    MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getTooltipBackgroundProperty()
    Returns the background color to use for drawing the tooltips.
    Returns:
      the color to be used
    See Also:
      - `DefaultTreeMapSettings.getTooltipBackground()`

  - ### getTooltipBackground

    com.macrofocus.igraphics.CPColor<Color> getTooltipBackground()
    Returns the background color to use for drawing the tooltips.
    Returns:
      the color to be used
    See Also:
      - `DefaultTreeMapSettings.getTooltipBackground()`

  - ### setTooltipBackground

    void setTooltipBackground(com.macrofocus.igraphics.CPColor<Color> color)
    Sets the background color to use for drawing the tooltips.
    Parameters:
      `color` - the color to be used
    See Also:
      - `DefaultTreeMapSettings.getTooltipBackground()`

  - ### getProbingColorProperty

    MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getProbingColorProperty()
    Returns the color to use for drawing the borders.
    Returns:
      the color to be used
    See Also:
      - `DefaultTreeMapSettings.getProbingColor()`

  - ### getProbingColor

    com.macrofocus.igraphics.CPColor<Color> getProbingColor()
    Returns the color to use for drawing the borders.
    Returns:
      the color to be used
    See Also:
      - `DefaultTreeMapSettings.getProbingColor()`

  - ### setProbingColor

    void setProbingColor(com.macrofocus.igraphics.CPColor<Color> color)
    Sets the color to use for drawing the borders.
    Parameters:
      `color` - the color to be used
    See Also:
      - `DefaultTreeMapSettings.getProbingColor()`

  - ### getSelectionColorProperty

    MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getSelectionColorProperty()
    Returns the color to use for drawing the borders.
    Returns:
      the color to be used
    See Also:
      - `DefaultTreeMapSettings.getSelectionColor()`

  - ### getSelectionColor

    com.macrofocus.igraphics.CPColor<Color> getSelectionColor()
    Returns the color to use for drawing the borders.
    Returns:
      the color to be used
    See Also:
      - `DefaultTreeMapSettings.getSelectionColor()`

  - ### setSelectionColor

    void setSelectionColor(com.macrofocus.igraphics.CPColor<Color> color)
    Sets the color to use for drawing the borders.
    Parameters:
      `color` - the color to be used
    See Also:
      - `DefaultTreeMapSettings.getSelectionColor()`

  - ### getShowPopup

    boolean getShowPopup(TreeMapField field)
    Tells whether the specified field should be shown in the popup.
    Parameters:
      `field` - the field.
    Returns:
      true if it should be displayed, false otherwise.

  - ### setShowPopup

    void setShowPopup(TreeMapField field, boolean show)
    Sets whether the specified field should be displayed or no in the popup.
    Parameters:
      `field` - the field.
      `show` - true if it should be displayed, false otherwise.

  - ### getValue

    Object getValue(String key)
    Gets the value of the specified property.
    Parameters:
      `key` - the property name
    Returns:
      the value

  - ### addTreeMapSettingsListener

    @JsIgnore void addTreeMapSettingsListener(TreeMapSettingsListener listener)
    Add a listener for receiving interesting events about changes in the settings.
    Parameters:
      `listener` - the listener to add.

  - ### removeTreeMapSettingsListener

    @JsIgnore void removeTreeMapSettingsListener(TreeMapSettingsListener listener)
    Remove a listener from the list of listeners that should be notified about changes in the settings.
    Parameters:
      `listener` - the listener to remove.

  - ### removeTreeMapSettingsListeners

    @JsIgnore void removeTreeMapSettingsListeners()
    Remove all the listener from the list of listeners that should be notified about changes in the settings.

  - ### getGroupByVariablesSelection

    MutableSelection<TreeMapField> getGroupByVariablesSelection()

  - ### getSizeVariableSelection

    MutableSingleSelection<TreeMapField> getSizeVariableSelection()

  - ### getColorVariableSelection

    MutableSingleSelection<TreeMapField> getColorVariableSelection()

  - ### getLabelVariablesSelection

    MutableSelection<TreeMapField> getLabelVariablesSelection()

  - ### getTooltipVariablesSelection

    MutableSelection<TreeMapField> getTooltipVariablesSelection()

  - ### getBackgroundVariableSelection

    MutableSingleSelection<TreeMapField> getBackgroundVariableSelection()

  - ### getHeightVariableSelection

    MutableSingleSelection<TreeMapField> getHeightVariableSelection()

  - ### getDepthSelection

    MutableSingleSelection<Depth> getDepthSelection()

  - ### getRenderingSelection

    MutableSingleSelection<Rendering> getRenderingSelection()

  - ### getProgressiveSelection

    MutableSingleSelection<TreeMapView.Progressive> getProgressiveSelection()

  - ### getHideFilterResultsSelection

    MutableProperty<Boolean> getHideFilterResultsSelection()

  - ### getHideSearchResultsSelection

    MutableProperty<Boolean> getHideSearchResultsSelection()

  - ### getDefaultFieldSettings

    TreeMapFieldSettings<Color,Font> getDefaultFieldSettings()

  - ### getFieldSettings

    TreeMapFieldSettings<Color,Font> getFieldSettings(TreeMapField field)

  - ### getLightSourceHeightInterval

    MutableBoundedInterval getLightSourceHeightInterval()

  - ### getLightSourceAmbientInterval

    MutableBoundedInterval getLightSourceAmbientInterval()

  - ### getLightSourceXInterval

    MutableBoundedInterval getLightSourceXInterval()

  - ### getLightSourceYInterval

    MutableBoundedInterval getLightSourceYInterval()

  - ### getLightSourceZInterval

    MutableBoundedInterval getLightSourceZInterval()

  - ### resetToDefaults

    void resetToDefaults()

  - ### save

    void save(com.macrofocus.molap.dataframe.DataFrame dataFrame, ElementFactory elementFactory, Element root)