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.

  • Field Details

  • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • setDepth

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

    • getRendering

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

    • setRendering

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

    • getLightSourceHeight

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

    • setLightSourceHeight

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

    • getLightSourceAmbient

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

    • setLightSourceAmbient

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

    • getLightSourceX

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

    • setLightSourceX

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

    • getLightSourceY

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

    • setLightSourceY

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

    • getLightSourceZ

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

    • setLightSourceZ

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

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • getProbingColor

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

    • 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:

    • 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:

    • getSelectionColor

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

    • 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:

    • 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)