Package com.treemap

Interface TreeMapFieldSettings<Color,Font>

All Known Implementing Classes:
AbstractTreeMapFieldSettings, DefaultTreeMapFieldSettings, OverridingTreeMapFieldSettings

@JsType public interface TreeMapFieldSettings<Color,Font>
  • Field Details

  • Method Details

    • getProperties

    • getAlgorithmProperty

      @JsIgnore MutableProperty<Algorithm> getAlgorithmProperty()
      Returns the algorithm to use to lay out the treemap.
      Returns:
      the algorithm to use
      See Also:
    • getAlgorithm

      @JsIgnore Algorithm getAlgorithm()
      Returns the algorithm to use to lay out the treemap.
      Returns:
      the algorithm to use
      See Also:
    • setAlgorithm

      void setAlgorithm(Algorithm algorithm)
      Defines the algorithm to use to lay out the treemap.
      Parameters:
      algorithm - the algorithm to use
      See Also:
    • getAggregationProperty

      @JsIgnore MutableProperty<Aggregation> getAggregationProperty()
      Returns the aggregation scheme to use to aggregate values of the treemap.
      Returns:
      athe aggregation scheme to use
      See Also:
    • getAggregation

      @JsIgnore Aggregation getAggregation()
      Returns the aggregation scheme to use to aggregate values of the treemap.
      Returns:
      athe aggregation scheme to use
      See Also:
    • setAggregation

      @JsIgnore void setAggregation(Aggregation aggregation)
      Defines the aggregation scheme to use to aggregate values of the treemap.
      Parameters:
      aggregation - the aggregation scheme to use
      See Also:
    • getScaleProperty

      @JsIgnore MutableProperty<Scale> getScaleProperty()
      Returns the scaling scheme to use to project values the treemap.
      Returns:
      the scale scheme to use
      See Also:
    • getScale

      @JsIgnore Scale getScale()
      Returns the scaling scheme to use to project values the treemap.
      Returns:
      the scale scheme to use
      See Also:
    • setScale

      @JsIgnore void setScale(Scale scale)
      Defines the scaling scheme to use to project values the treemap.
      Parameters:
      scale - the scale scheme to use
      See Also:
    • getNestingProperty

      @JsIgnore MutableProperty<Nesting> getNestingProperty()
      Returns the nesting to use to lay out the treemap.
      Returns:
      the nesting scheme to use
      See Also:
    • getNesting

      @JsIgnore Nesting getNesting()
      Returns the nesting to use to lay out the treemap.
      Returns:
      the nesting scheme to use
      See Also:
    • setNesting

      @JsIgnore void setNesting(Nesting nesting)
      Defines the nesting to use to lay out the treemap.
      Parameters:
      nesting - the nesting scheme to use
      See Also:
    • getOrderingProperty

      MutableProperty<Ordering> getOrderingProperty()
      Returns the ordering to use to lay out the treemap.
      Returns:
      the ordering to use
      See Also:
    • getOrdering

      @JsIgnore Ordering getOrdering()
      Returns the ordering to use to lay out the treemap.
      Returns:
      the ordering to use
      See Also:
    • setOrdering

      @JsIgnore void setOrdering(Ordering ordering)
      Defines the ordering to use to lay out the treemap.
      Parameters:
      ordering - the ordering to use
      See Also:
    • getOrderingDirectionProperty

      @JsIgnore MutableProperty<Ordering.SortOrder> getOrderingDirectionProperty()
      Returns the ordering direction to use to lay out the treemap.
      Returns:
      the ordering to use
      See Also:
    • getOrderingDirection

      @JsIgnore Ordering.SortOrder getOrderingDirection()
      Returns the ordering direction to use to lay out the treemap.
      Returns:
      the ordering to use
      See Also:
    • setOrderingDirection

      @JsIgnore void setOrderingDirection(Ordering.SortOrder ordering)
      Defines the ordering direction to use to lay out the treemap.
      Parameters:
      ordering - the ordering direction to use
      See Also:
    • getOrderingVerticalVanishingPointProperty

      @JsIgnore MutableProperty<Integer> getOrderingVerticalVanishingPointProperty()
    • getOrderingVerticalVanishingPoint

      @JsIgnore Integer getOrderingVerticalVanishingPoint()
    • setOrderingVerticalVanishingPoint

      @JsIgnore void setOrderingVerticalVanishingPoint(Integer alignment)
    • getOrderingHorizontalVanishingPointProperty

      @JsIgnore MutableProperty<Integer> getOrderingHorizontalVanishingPointProperty()
    • getOrderingHorizontalVanishingPoint

      @JsIgnore Integer getOrderingHorizontalVanishingPoint()
    • setOrderingHorizontalVanishingPoint

      @JsIgnore void setOrderingHorizontalVanishingPoint(Integer alignment)
    • getLabelingProperty

      @JsIgnore MutableProperty<Labeling> getLabelingProperty()
      Returns the labeling scheme to use to draw the treemap.
      Returns:
      the labeling scheme to use
      See Also:
    • getLabeling

      @JsIgnore Labeling getLabeling()
      Returns the labeling scheme to use to draw the treemap.
      Returns:
      the labeling scheme to use
      See Also:
    • setLabeling

      void setLabeling(Labeling labeling)
      Defines the labeling scheme to use to draw the treemap.
      Parameters:
      labeling - the labeling scheme to use
      See Also:
    • getLabelingFontProperty

      MutableProperty<com.macrofocus.igraphics.CPFont<Font>> getLabelingFontProperty()
      Returns the font used for labeling.
      Returns:
      the font to be used
      See Also:
    • getLabelingFont

      com.macrofocus.igraphics.CPFont<Font> getLabelingFont()
      Returns the font used for labeling.
      Returns:
      the font to be used
      See Also:
    • setLabelingFont

      void setLabelingFont(com.macrofocus.igraphics.CPFont<Font> font)
      Sets the font used for labeling.
      Parameters:
      font - the font to be used
      See Also:
    • getLabelingForegroundProperty

      MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getLabelingForegroundProperty()
      Returns the foreground color to use for drawing the labels.
      Returns:
      the color to be used
      See Also:
    • getLabelingForeground

      com.macrofocus.igraphics.CPColor<Color> getLabelingForeground()
      Returns the foreground color to use for drawing the labels.
      Returns:
      the color to be used
      See Also:
    • setLabelingForeground

      void setLabelingForeground(com.macrofocus.igraphics.CPColor<Color> color)
      Sets the foreground color to use for drawing the labels.
      Parameters:
      color - the color to be used
      See Also:
    • getLabelingEffectColorProperty

      MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getLabelingEffectColorProperty()
      Returns the effect color to use for drawing the labels.
      Returns:
      the color to be used
      See Also:
    • getLabelingEffectColor

      com.macrofocus.igraphics.CPColor<Color> getLabelingEffectColor()
      Returns the effect color to use for drawing the labels.
      Returns:
      the color to be used
      See Also:
    • setLabelingEffectColor

      void setLabelingEffectColor(com.macrofocus.igraphics.CPColor<Color> color)
      Sets the effect color to use for drawing the labels.
      Parameters:
      color - the color to be used
      See Also:
    • getLabelingEffectProperty

      @JsIgnore MutableProperty<com.macrofocus.labeling.EnhancedLabel.Effect> getLabelingEffectProperty()
    • getLabelingEffect

      @JsIgnore com.macrofocus.labeling.EnhancedLabel.Effect getLabelingEffect()
    • setLabelingEffect

      @JsIgnore void setLabelingEffect(com.macrofocus.labeling.EnhancedLabel.Effect effect)
    • getLabelingHorizontalAlignmentProperty

      @JsIgnore MutableProperty<Integer> getLabelingHorizontalAlignmentProperty()
    • getLabelingHorizontalAlignment

      @JsIgnore int getLabelingHorizontalAlignment()
    • setLabelingHorizontalAlignment

      void setLabelingHorizontalAlignment(int alignment)
    • getLabelingVerticalAlignmentProperty

      @JsIgnore MutableProperty<Integer> getLabelingVerticalAlignmentProperty()
    • getLabelingVerticalAlignment

      @JsIgnore int getLabelingVerticalAlignment()
    • setLabelingVerticalAlignment

      void setLabelingVerticalAlignment(int alignment)
    • getLabelingRenderingProperty

      @JsIgnore MutableProperty<com.macrofocus.labeling.EnhancedLabel.Rendering> getLabelingRenderingProperty()
    • getLabelingRendering

      @JsIgnore com.macrofocus.labeling.EnhancedLabel.Rendering getLabelingRendering()
    • setLabelingRendering

      @JsIgnore void setLabelingRendering(com.macrofocus.labeling.EnhancedLabel.Rendering rendering)
    • getLabelingMinimumCharactersToDisplayProperty

      @JsIgnore MutableProperty<Integer> getLabelingMinimumCharactersToDisplayProperty()
    • getLabelingMinimumCharactersToDisplay

      @JsIgnore Integer getLabelingMinimumCharactersToDisplay()
    • setLabelingMinimumCharactersToDisplay

      void setLabelingMinimumCharactersToDisplay(int minimumCharactersToDisplay)
    • getLabelingEffectOpacityProperty

      @JsIgnore MutableProperty<Float> getLabelingEffectOpacityProperty()
    • getLabelingEffectOpacity

      @JsIgnore Float getLabelingEffectOpacity()
    • setLabelingEffectOpacity

      @JsIgnore void setLabelingEffectOpacity(Float opacity)
    • getLabelingShrinkTextToFitShapeProperty

      @JsIgnore MutableProperty<Boolean> getLabelingShrinkTextToFitShapeProperty()
    • getLabelingShrinkTextToFitShape

      Boolean getLabelingShrinkTextToFitShape()
    • setLabelingShrinkTextToFitShape

      void setLabelingShrinkTextToFitShape(Boolean labelingShrinkTextToFitShape)
    • getLabelingResizeTextToFitShapeProperty

      @JsIgnore MutableProperty<Boolean> getLabelingResizeTextToFitShapeProperty()
    • getLabelingResizeTextToFitShape

      Boolean getLabelingResizeTextToFitShape()
    • setLabelingResizeTextToFitShape

      void setLabelingResizeTextToFitShape(Boolean labelingResizeTextToFitShape)
    • getLabelingFloatProperty

      @JsIgnore MutableProperty<Boolean> getLabelingFloatProperty()
    • getLabelingFloat

      @JsIgnore Boolean getLabelingFloat()
    • setLabelingFloat

      @JsIgnore void setLabelingFloat(Boolean labelingFloat)
    • getLabelingContrastEnhancementProperty

      @JsIgnore MutableProperty<com.macrofocus.labeling.EnhancedLabel.ContrastEnhancement> getLabelingContrastEnhancementProperty()
    • getLabelingContrastEnhancement

      @JsIgnore com.macrofocus.labeling.EnhancedLabel.ContrastEnhancement getLabelingContrastEnhancement()
    • setLabelingContrastEnhancement

      @JsIgnore void setLabelingContrastEnhancement(com.macrofocus.labeling.EnhancedLabel.ContrastEnhancement contrastEnhancement)
    • getNestingAmountProperty

      @JsIgnore MutableProperty<Double> getNestingAmountProperty()
      Returns the size of the nested areas.
      Returns:
      the amount to be used
      See Also:
    • getNestingAmount

      @JsIgnore Double getNestingAmount()
      Returns the size of the nested areas.
      Returns:
      the amount to be used
      See Also:
    • setNestingAmount

      @JsIgnore void setNestingAmount(Double amount)
      Sets the size of nested areas.
      Parameters:
      amount - the amount to be used
      See Also:
    • getNestingBackgroundProperty

      MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getNestingBackgroundProperty()
      Returns the background color to use for drawing the nested areas.
      Returns:
      the color to be used
      See Also:
    • getNestingBackground

      com.macrofocus.igraphics.CPColor<Color> getNestingBackground()
      Returns the background color to use for drawing the nested areas.
      Returns:
      the color to be used
      See Also:
    • setNestingBackground

      void setNestingBackground(com.macrofocus.igraphics.CPColor<Color> color)
      Sets the background color to use for drawing the nested areas.
      Parameters:
      color - the color to be used
      See Also:
    • getHeaderFontProperty

      MutableProperty<com.macrofocus.igraphics.CPFont<Font>> getHeaderFontProperty()
      Returns the font used for labeling the headings.
      Returns:
      the font to be used
      See Also:
    • getHeaderFont

      com.macrofocus.igraphics.CPFont<Font> getHeaderFont()
      Returns the font used for labeling the headings.
      Returns:
      the font to be used
      See Also:
    • setHeaderFont

      void setHeaderFont(com.macrofocus.igraphics.CPFont<Font> font)
      Sets the font used for labeling the headings.
      Parameters:
      font - the font to be used
      See Also:
    • getHeaderForegroundProperty

      MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getHeaderForegroundProperty()
      Returns the foreground color to use for drawing the headers.
      Returns:
      the color to be used
      See Also:
    • getHeaderForeground

      com.macrofocus.igraphics.CPColor<Color> getHeaderForeground()
      Returns the foreground color to use for drawing the headers.
      Returns:
      the color to be used
      See Also:
    • setHeaderForeground

      void setHeaderForeground(com.macrofocus.igraphics.CPColor<Color> color)
      Sets the foreground color to use for drawing the headers.
      Parameters:
      color - the color to be used
      See Also:
    • getHeaderBackgroundProperty

      MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getHeaderBackgroundProperty()
      Returns the background color to use for drawing the headers.
      Returns:
      the color to be used
      See Also:
    • getHeaderBackground

      com.macrofocus.igraphics.CPColor<Color> getHeaderBackground()
      Returns the background color to use for drawing the headers.
      Returns:
      the color to be used
      See Also:
    • setHeaderBackground

      void setHeaderBackground(com.macrofocus.igraphics.CPColor<Color> color)
      Sets the background color to use for drawing the headers.
      Parameters:
      color - the color to be used
      See Also:
    • getHeaderEffectColorProperty

      MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getHeaderEffectColorProperty()
      Returns the effect color to use for drawing the headers.
      Returns:
      the color to be used
      See Also:
    • getHeaderEffectColor

      com.macrofocus.igraphics.CPColor<Color> getHeaderEffectColor()
      Returns the effect color to use for drawing the headers.
      Returns:
      the color to be used
      See Also:
    • setHeaderEffectColor

      void setHeaderEffectColor(com.macrofocus.igraphics.CPColor<Color> color)
      Sets the background color to use for drawing the headers.
      Parameters:
      color - the color to be used
      See Also:
    • getHeaderEffectProperty

      @JsIgnore MutableProperty<com.macrofocus.labeling.EnhancedLabel.Effect> getHeaderEffectProperty()
    • getHeaderEffect

      @JsIgnore com.macrofocus.labeling.EnhancedLabel.Effect getHeaderEffect()
    • setHeaderEffect

      @JsIgnore void setHeaderEffect(com.macrofocus.labeling.EnhancedLabel.Effect effect)
    • getHeaderHorizontalAlignmentProperty

      @JsIgnore MutableProperty<Integer> getHeaderHorizontalAlignmentProperty()
    • getHeaderHorizontalAlignment

      @JsIgnore Integer getHeaderHorizontalAlignment()
    • setHeaderHorizontalAlignment

      @JsIgnore void setHeaderHorizontalAlignment(Integer alignment)
    • getHeaderVerticalAlignmentProperty

      @JsIgnore MutableProperty<Integer> getHeaderVerticalAlignmentProperty()
    • getHeaderVerticalAlignment

      @JsIgnore Integer getHeaderVerticalAlignment()
    • setHeaderVerticalAlignment

      @JsIgnore void setHeaderVerticalAlignment(Integer alignment)
    • getHeaderRenderingProperty

      @JsIgnore MutableProperty<com.macrofocus.labeling.EnhancedLabel.Rendering> getHeaderRenderingProperty()
    • getHeaderRendering

      @JsIgnore com.macrofocus.labeling.EnhancedLabel.Rendering getHeaderRendering()
    • setHeaderRendering

      @JsIgnore void setHeaderRendering(com.macrofocus.labeling.EnhancedLabel.Rendering rendering)
    • getHeaderMinimumCharactersToDisplayProperty

      @JsIgnore MutableProperty<Integer> getHeaderMinimumCharactersToDisplayProperty()
    • getHeaderMinimumCharactersToDisplay

      @JsIgnore Integer getHeaderMinimumCharactersToDisplay()
    • setHeaderMinimumCharactersToDisplay

      @JsIgnore void setHeaderMinimumCharactersToDisplay(Integer minimumCharactersToDisplay)
    • getHeaderEffectOpacityProperty

      @JsIgnore MutableProperty<Float> getHeaderEffectOpacityProperty()
    • getHeaderEffectOpacity

      @JsIgnore Float getHeaderEffectOpacity()
    • setHeaderEffectOpacity

      @JsIgnore void setHeaderEffectOpacity(Float opacity)
    • getHeaderInsetsProperty

      @JsIgnore MutableProperty<com.macrofocus.igraphics.Insets> getHeaderInsetsProperty()
    • getHeaderInsets

      @JsIgnore com.macrofocus.igraphics.Insets getHeaderInsets()
    • setHeaderInsets

      @JsIgnore void setHeaderInsets(com.macrofocus.igraphics.Insets insets)
    • getTooltipFontProperty

      MutableProperty<com.macrofocus.igraphics.CPFont<Font>> getTooltipFontProperty()
      Returns the font used for labeling the tooltips.
      Returns:
      the font to be used
      See Also:
    • getTooltipFont

      com.macrofocus.igraphics.CPFont<Font> getTooltipFont()
      Returns the font used for labeling the tooltips.
      Returns:
      the font to be used
      See Also:
    • setTooltipFont

      void setTooltipFont(com.macrofocus.igraphics.CPFont<Font> font)
      Sets the font used for labeling the tooltips.
      Parameters:
      font - the font to be used
      See Also:
    • getTooltipForegroundProperty

      MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getTooltipForegroundProperty()
      Returns the foreground color to use for drawing the tooltips.
      Returns:
      the color to be used
      See Also:
    • getTooltipForeground

      com.macrofocus.igraphics.CPColor<Color> getTooltipForeground()
      Returns the foreground color to use for drawing the tooltips.
      Returns:
      the color to be used
      See Also:
    • setTooltipForeground

      void setTooltipForeground(com.macrofocus.igraphics.CPColor<Color> color)
      Sets the foreground color to use for drawing the tooltips.
      Parameters:
      color - the color to be used
      See Also:
    • getTooltipRenderingProperty

      @JsIgnore MutableProperty<com.macrofocus.labeling.EnhancedLabel.Rendering> getTooltipRenderingProperty()
    • getTooltipRendering

      @JsIgnore com.macrofocus.labeling.EnhancedLabel.Rendering getTooltipRendering()
    • setTooltipRendering

      @JsIgnore void setTooltipRendering(com.macrofocus.labeling.EnhancedLabel.Rendering rendering)
    • getBorderColorProperty

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

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

      void setBorderColor(com.macrofocus.igraphics.CPColor<Color> color)
      Sets the color to use for drawing the borders.
      Parameters:
      color - the color to be used
      See Also:
    • getBorderThicknessInterval

      MutableBoundedInterval getBorderThicknessInterval()
      Returns the thickness used for drawing the borders.
      Returns:
      the height
      See Also:
    • getBorderThickness

      double getBorderThickness()
      Returns the thickness used for drawing the borders.
      Returns:
      the height
      See Also:
    • setBorderThickness

      void setBorderThickness(double value)
      Sets the thickness used for drawing the borders.
      Parameters:
      value - the height
      See Also:
    • getFormatProperty

      @JsIgnore MutableProperty<com.macrofocus.format.CPFormat> getFormatProperty()
      Gets the format used to display values of the specified column.
      Returns:
      the format to be used.
    • getFormat

      @JsIgnore com.macrofocus.format.CPFormat getFormat()
      Gets the format used to display values of the specified column.
      Returns:
      the format to be used.
    • setFormat

      @JsIgnore void setFormat(com.macrofocus.format.CPFormat format)
      Sets the format used to display values of the specified column.
      Parameters:
      format - the format to be used.
    • getShowLabelProperty

      MutableProperty<Boolean> getShowLabelProperty()
      Tells whether the label of the specified field should be shown in the popup.
      Returns:
      true if it should be displayed, false otherwise.
    • getShowLabel

      boolean getShowLabel()
      Tells whether the label of the specified field should be shown in the popup.
      Returns:
      true if it should be displayed, false otherwise.
    • setShowLabel

      void setShowLabel(boolean show)
      Sets whether the label of the specified field should be displayed or no in the popup.
      Parameters:
      show - true if it should be displayed, false otherwise.
    • getColorMapProperty

      MutableProperty<com.macrofocus.colormap.MutableColorMap> getColorMapProperty()
      Gets the color map for the specified column.
      Returns:
      the color map to use.
    • getColorMap

      com.macrofocus.colormap.MutableColorMap getColorMap()
      Gets the color map for the specified column.
      Returns:
      the color map to use.
    • setColorMap

      void setColorMap(com.macrofocus.colormap.MutableColorMap colorMap)
      Sets the color map to use for the specified column.
      Parameters:
      colorMap - the colorMap to use.
    • getProperty

      Gets the value of the specified property.
      Parameters:
      key - the property name
      Returns:
      the value
    • setProperty

      void setProperty(TreeMapFieldSettings.PropertyType property, Object value)
      Sets the value of the specified property.
      Parameters:
      property - the property name
      value - the value
    • isDefaults

      boolean isDefaults()
      Gets whether the default settings can be overridden by these settings
      Returns:
      true if the settings can be overridden, false otherwise
    • isOverrideDefaults

      boolean isOverrideDefaults()
      Gets whether the default settings are overridden by these settings
      Returns:
      true if this override the default settings, false otherwise
    • getOverrideDefaultsProperty

      MutableProperty<Boolean> getOverrideDefaultsProperty()
    • setOverrideDefaults

      void setOverrideDefaults(boolean overrideDefaults)
      Sets whether the default settings should be overridden by these settings
      Parameters:
      overrideDefaults - true to override the default settings, false otherwise
    • getPropertyOverride

      Object getPropertyOverride(TreeMapFieldSettings.PropertyType key)
      Gets the value of the specified property. Only returns the overridden value, not the default value if it isn't overridden.
      Parameters:
      key - the property name
      Returns:
      the value
    • reset

      void reset()