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

    • Field Detail

      • PROPERTY_COLOR_FIELD

        static final java.lang.String PROPERTY_COLOR_FIELD
        See Also:
        Constant Field Values
      • PROPERTY_LABELS_FIELD

        static final java.lang.String PROPERTY_LABELS_FIELD
        See Also:
        Constant Field Values
      • PROPERTY_TOOLTIP_FIELD

        static final java.lang.String PROPERTY_TOOLTIP_FIELD
        See Also:
        Constant Field Values
      • PROPERTY_BACKGROUND_FIELD

        static final java.lang.String PROPERTY_BACKGROUND_FIELD
        See Also:
        Constant Field Values
      • PROPERTY_HEIGHT_FIELD

        static final java.lang.String PROPERTY_HEIGHT_FIELD
        See Also:
        Constant Field Values
      • PROPERTY_GROUP_BY_FIELD

        static final java.lang.String PROPERTY_GROUP_BY_FIELD
        See Also:
        Constant Field Values
      • PROPERTY_TOOLTIP_BACKGROUND

        static final java.lang.String PROPERTY_TOOLTIP_BACKGROUND
        See Also:
        Constant Field Values
      • PROPERTY_PROBING_COLOR

        static final java.lang.String PROPERTY_PROBING_COLOR
        See Also:
        Constant Field Values
      • PROPERTY_SELECTION_COLOR

        static final java.lang.String PROPERTY_SELECTION_COLOR
        See Also:
        Constant Field Values
      • PROPERTY_HIDE_SEARCH_RESULTS

        static final java.lang.String PROPERTY_HIDE_SEARCH_RESULTS
        See Also:
        Constant Field Values
      • PROPERTY_HIDE_FILTER_RESULTS

        static final java.lang.String PROPERTY_HIDE_FILTER_RESULTS
        See Also:
        Constant Field Values
      • PROPERTY_DIMENSION_FIXED

        static final java.lang.String PROPERTY_DIMENSION_FIXED
        See Also:
        Constant Field Values
      • PROPERTY_MAXIMUM_HEIGHT

        static final java.lang.String PROPERTY_MAXIMUM_HEIGHT
        See Also:
        Constant Field Values
      • PROPERTY_LIGHT_SOURCE_HEIGHT

        static final java.lang.String PROPERTY_LIGHT_SOURCE_HEIGHT
        See Also:
        Constant Field Values
      • PROPERTY_LIGHT_SOURCE_AMBIENT

        static final java.lang.String PROPERTY_LIGHT_SOURCE_AMBIENT
        See Also:
        Constant Field Values
      • PROPERTY_LIGHT_SOURCE_X

        static final java.lang.String PROPERTY_LIGHT_SOURCE_X
        See Also:
        Constant Field Values
      • PROPERTY_LIGHT_SOURCE_Y

        static final java.lang.String PROPERTY_LIGHT_SOURCE_Y
        See Also:
        Constant Field Values
      • PROPERTY_LIGHT_SOURCE_Z

        static final java.lang.String PROPERTY_LIGHT_SOURCE_Z
        See Also:
        Constant Field Values
    • Method Detail

      • getDimensionFixed

        java.lang.Boolean getDimensionFixed()
      • setDimensionFixed

        void setDimensionFixed​(java.lang.Boolean fixed)
      • getDimension

        @JsIgnore
        java.awt.Dimension getDimension()
        Gets the size of the treemap.
        Returns:
        the size of the treemap.
      • setDimension

        @JsIgnore
        void setDimension​(java.awt.Dimension dimension)
        Sets the size of the treemap.
        Parameters:
        dimension - the size of the treemap.
      • 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.
      • 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

        java.lang.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​(java.lang.Boolean hideFilterResults)
      • isHideSearchResults

        java.lang.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​(java.lang.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.
      • setGroupByByNames

        void setGroupByByNames​(java.lang.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()
      • setLabelsByNames

        void setLabelsByNames​(java.lang.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()
      • setToolTipByNames

        void setToolTipByNames​(java.lang.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()
      • setBackgroundByName

        void setBackgroundByName​(java.lang.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​(java.lang.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()
      • setColorByName

        void setColorByName​(java.lang.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()
      • setHeightByName

        void setHeightByName​(java.lang.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)
      • 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()
      • 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()
      • 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()
      • 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()
      • 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()
      • 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()
      • 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

        java.lang.Object getValue​(java.lang.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.
      • getHideFilterResultsSelection

        MutableProperty<java.lang.Boolean> getHideFilterResultsSelection()
      • getHideSearchResultsSelection

        MutableProperty<java.lang.Boolean> getHideSearchResultsSelection()
      • resetToDefaults

        void resetToDefaults()
      • save

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