Class TimeSeriesCollectionChartDefinition

    • Constructor Detail

      • TimeSeriesCollectionChartDefinition

        public TimeSeriesCollectionChartDefinition​(org.pentaho.platform.api.engine.IPentahoSession session)
      • TimeSeriesCollectionChartDefinition

        public TimeSeriesCollectionChartDefinition​(int chartType,
                                                   org.pentaho.commons.connection.IPentahoResultSet data,
                                                   boolean byRow,
                                                   org.dom4j.Node chartAttributes,
                                                   org.pentaho.platform.api.engine.IPentahoSession session)
      • TimeSeriesCollectionChartDefinition

        public TimeSeriesCollectionChartDefinition​(org.pentaho.commons.connection.IPentahoResultSet data,
                                                   boolean byRow,
                                                   org.dom4j.Node chartAttributes,
                                                   org.pentaho.platform.api.engine.IPentahoSession session)
    • Method Detail

      • getLogger

        public org.apache.commons.logging.Log getLogger()
      • getTimePeriodClass

        public static Class getTimePeriodClass​(String timePeriodStr)
      • setChartBackgroundPaint

        public void setChartBackgroundPaint​(Paint chartBackgroundPaint)
        Parameters:
        backgroundPaint - The backgroundPaint to set.
      • getTitleFont

        public Font getTitleFont()
        Return the java.awt.Font to be used to display the dial title
        Specified by:
        getTitleFont in interface ChartDefinition
        Returns:
        Font The Font for the title of this Pie
      • setTitleFont

        public void setTitleFont​(Font titleFont)
      • setTitleFont

        public void setTitleFont​(org.dom4j.Node titleFontNode)
      • getChartType

        public int getChartType()
        Returns:
        Returns the chartType.
      • getChartType

        public static int getChartType​(String typeStr)
      • setChartType

        public void setChartType​(org.dom4j.Node chartTypeNode)
      • setChartType

        public void setChartType​(int chartType)
        Parameters:
        chartType - The chartType to set.
      • isThreeD

        public boolean isThreeD()
        Specified by:
        isThreeD in interface ChartDefinition
        Returns:
        Returns the threeD.
      • setThreeD

        public void setThreeD​(org.dom4j.Node threeDNode)
      • setThreeD

        public void setThreeD​(boolean threeD)
        Parameters:
        threeD - The threeD to set.
      • isStacked

        public boolean isStacked()
        Returns:
        Returns the stacked.
      • setStacked

        public void setStacked​(org.dom4j.Node stackedNode)
      • setStacked

        public void setStacked​(boolean stacked)
        Parameters:
        stacked - The stacked to set.
      • isDomainVerticalTickLabels

        public boolean isDomainVerticalTickLabels()
        Returns:
        Returns the verticalTickLabels.
      • setDomainVerticalTickLabels

        public void setDomainVerticalTickLabels​(org.dom4j.Node domainVerticalTickLabelsNode)
      • setDomainVerticalTickLabels

        public void setDomainVerticalTickLabels​(boolean domainVerticalTickLabels)
        Parameters:
        domainVerticalTickLabels - The domainVerticalLabels to set.
      • getDomainPeriodType

        public String getDomainPeriodType()
        Returns:
        Returns the domainPeriodType.
      • setDomainPeriodType

        public void setDomainPeriodType​(org.dom4j.Node domainPeriodTypeNode)
      • setDomainPeriodType

        public void setDomainPeriodType​(String domainPeriodType)
        Parameters:
        domainPeriodType - The domainPeriodType to set.
      • getHeight

        public int getHeight()
        Specified by:
        getHeight in interface ChartDefinition
        Returns:
        Returns the height.
      • setHeight

        public void setHeight​(org.dom4j.Node heightNode)
      • setHeight

        public void setHeight​(int height)
        Parameters:
        height - The height to set.
      • getWidth

        public int getWidth()
        Specified by:
        getWidth in interface ChartDefinition
        Returns:
        Returns the width.
      • setWidth

        public void setWidth​(org.dom4j.Node widthNode)
      • setWidth

        public void setWidth​(int width)
        Parameters:
        width - The width to set.
      • setTitle

        public void setTitle​(org.dom4j.Node chartTitleNode)
      • setTitle

        public void setTitle​(String title)
        Parameters:
        title - The title to set.
      • setPaintSequence

        public void setPaintSequence​(org.dom4j.Node paletteNode)
      • setPaintSequence

        public void setPaintSequence​(Paint[] paintSequence)
        Parameters:
        paintSequence - The paintSequence to set.
      • addSubTitles

        public void addSubTitles​(List subTitleNodes)
      • addSubTitle

        public void addSubTitle​(String subTitle)
      • setChartBackgroundImage

        public void setChartBackgroundImage​(org.dom4j.Node chartBackgroundImageNode)
      • setChartBackgroundImage

        public void setChartBackgroundImage​(Image chartBackgroundImage)
        Parameters:
        chartBackgroundImage - The chartBackgroundImage to set.
      • setLegendIncluded

        public void setLegendIncluded​(org.dom4j.Node legendNode)
      • setLegendIncluded

        public void setLegendIncluded​(boolean legendIncluded)
        Parameters:
        legendIncluded - The legendIncluded to set.
      • setPlotBackgroundPaint

        public void setPlotBackgroundPaint​(Paint plotBackgroundPaint)
      • setPlotBackgroundImage

        public void setPlotBackgroundImage​(org.dom4j.Node plotBackgroundImageNode)
      • setPlotBackgroundImage

        public void setPlotBackgroundImage​(Image plotBackgroundImage)
        Parameters:
        plotBackgroundImage - The plotBackgroundImage to set.
      • getOrientation

        public org.jfree.chart.plot.PlotOrientation getOrientation()
        Returns:
        Returns the orientation.
      • setOrientation

        public void setOrientation​(org.dom4j.Node orientationNode)
      • setOrientation

        public void setOrientation​(org.jfree.chart.plot.PlotOrientation orientation)
        Parameters:
        orientation - The orientation to set.
      • setBorderVisible

        public void setBorderVisible​(org.dom4j.Node borderVisibleNode)
      • setBorderVisible

        public void setBorderVisible​(boolean borderVisible)
        Parameters:
        borderVisible - The borderVisible to set.
      • setBorderPaint

        public void setBorderPaint​(Paint borderPaint)
        Parameters:
        borderPaint - The borderPaint to set.
      • setTitlePosition

        public void setTitlePosition​(org.dom4j.Node titlePositionNode)
      • getTitlePosition

        public org.jfree.ui.RectangleEdge getTitlePosition()
        Specified by:
        getTitlePosition in interface ChartDefinition
        Returns:
        Returns the titlePosition.
      • setTitlePosition

        public void setTitlePosition​(org.jfree.ui.RectangleEdge titlePosition)
        Parameters:
        titlePosition - The titlePosition to set.
      • setLegendPosition

        public void setLegendPosition​(org.dom4j.Node legendPositionNode)
      • setLegendPosition

        public void setLegendPosition​(org.jfree.ui.RectangleEdge legendPosition)
      • setChartBackground

        public void setChartBackground​(org.dom4j.Node chartBackgroundNode)
      • setPlotBackground

        public void setPlotBackground​(org.dom4j.Node plotBackgroundNode)
      • setDomainTitle

        public void setDomainTitle​(org.dom4j.Node titleNode)
      • getDomainTitle

        public String getDomainTitle()
        Returns:
        Returns the domainTitle.
      • setDomainTitle

        public void setDomainTitle​(String domainTitle)
        Parameters:
        domainTitle - The domainTitle to set.
      • setRangeTitle

        public void setRangeTitle​(org.dom4j.Node titleNode)
      • getRangeTitle

        public String getRangeTitle()
        Returns:
        Returns the rangeTitle.
      • setRangeTitle

        public void setRangeTitle​(String rangeTitle)
        Parameters:
        rangeTitle - The rangeTitle to set.
      • setDomainTitleFont

        public void setDomainTitleFont​(org.dom4j.Node titleFontNode)
      • getDomainTitleFont

        public Font getDomainTitleFont()
        Returns:
        Returns the domainTitleFont.
      • setDomainTitleFont

        public void setDomainTitleFont​(Font domainTitleFont)
        Parameters:
        domainTitleFont - The domainTitleFont to set.
      • setRangeTitleFont

        public void setRangeTitleFont​(org.dom4j.Node titleFontNode)
      • getRangeTitleFont

        public Font getRangeTitleFont()
        Returns:
        Returns the rangeTitleFont.
      • setRangeTitleFont

        public void setRangeTitleFont​(Font rangeTitleFont)
        Parameters:
        rangeTitleFont - The rangeTitleFont to set.
      • getSession

        public org.pentaho.platform.api.engine.IPentahoSession getSession()
      • setSession

        public void setSession​(org.pentaho.platform.api.engine.IPentahoSession session)
      • getDotHeight

        public int getDotHeight()
        Returns:
        Returns the dot height.
      • setDotHeight

        public void setDotHeight​(org.dom4j.Node heightNode)
      • setDotHeight

        public void setDotHeight​(int height)
        Parameters:
        height - The dot height to set.
      • getDotWidth

        public int getDotWidth()
        Returns:
        Returns the dot width.
      • setDotWidth

        public void setDotWidth​(org.dom4j.Node widthNode)
      • setDotWidth

        public void setDotWidth​(int width)
        Parameters:
        width - The dot width to set.
      • getLineStyle

        public String getLineStyle()
        Returns:
        returns the style set for the lines
        See Also:
        ChartDefinition.LINE_STYLE_SOLID_STR, ChartDefinition.LINE_STYLE_DASH_STR, ChartDefinition.LINE_STYLE_DOT_STR, ChartDefinition.LINE_STYLE_DASHDOT_STR, ChartDefinition.LINE_STYLE_DASHDOTDOT_STR
      • setLineStyle

        public void setLineStyle​(String lineStyle)
        Parameters:
        lineStyle - set the style for all line series
        See Also:
        ChartDefinition.LINE_STYLE_SOLID_STR, ChartDefinition.LINE_STYLE_DASH_STR, ChartDefinition.LINE_STYLE_DOT_STR, ChartDefinition.LINE_STYLE_DASHDOT_STR, ChartDefinition.LINE_STYLE_DASHDOTDOT_STR
      • setLineStyle

        public void setLineStyle​(org.dom4j.Node lineStyleNode)
        Parameters:
        lineStyleNode - set the style from an XML node
      • getLineWidth

        public float getLineWidth()
        Returns:
        the width of all line series Valid values are float numbers zero or greater
      • setLineWidth

        public void setLineWidth​(float lineWidth)
        Parameters:
        lineWidth - set the width of all line series Valid values are float numbers zero or greater
      • setLineWidth

        public void setLineWidth​(org.dom4j.Node lineWidthNode)
        Parameters:
        lineWidthNode - set the line width from an XML node
      • isMarkersVisible

        public boolean isMarkersVisible()
        Returns:
        boolean whether the markers (data points) for all series are displayed
      • setMarkersVisible

        public void setMarkersVisible​(boolean markersVisible)
        Parameters:
        markersVisible - set whether the markers (data points) for all series should be displayed
      • setMarkersVisible

        public void setMarkersVisible​(org.dom4j.Node markersVisibleNode)
        Parameters:
        markersVisibleNode - set the markers visibility from an XML node
      • getLegendFont

        public Font getLegendFont()
        Return the java.awt.Font to be used to display the legend items
        Specified by:
        getLegendFont in interface ChartDefinition
        Returns:
        Font The font for the legend items
      • setLegendFont

        public void setLegendFont​(Font legendFont)
        Set java.awt.Font to be used to display the legend items
        Parameters:
        Font - The java.awt.Font for the legend items
      • setLegendFont

        public void setLegendFont​(org.dom4j.Node legendFontNode)
      • setLegendBorderVisible

        public void setLegendBorderVisible​(org.dom4j.Node legendBorderVisibleNode)
      • setLegendBorderVisible

        public void setLegendBorderVisible​(boolean legendBorderVisible)
        Parameters:
        boolean - legendBorderVisible Set the visibility of the legend border.
      • isLegendBorderVisible

        public boolean isLegendBorderVisible()
        Return the boolen that states if the legend border is visible
        Specified by:
        isLegendBorderVisible in interface ChartDefinition
        Returns:
        boolean Is the legend border visible
      • getRangeMinimum

        public double getRangeMinimum()
        Return the range axis' minimum value
        Returns:
        double Range axis' minimum value
      • setRangeMinimum

        public void setRangeMinimum​(org.dom4j.Node rangeMinimumNode)
      • setRangeMinimum

        public void setRangeMinimum​(double rangeMinimum)
        Parameters:
        double - rangeMinimum Set the minimum value of the range axis.
      • getRangeMaximum

        public double getRangeMaximum()
        Return the range axis' maximum value
        Returns:
        double Range axis' maximum value
      • setRangeMaximum

        public void setRangeMaximum​(org.dom4j.Node rangeMaximumNode)
      • setDateMaximum

        public void setDateMaximum​(Date dateMaximum)
      • getDateMaximum

        public Date getDateMaximum()
      • setDateMaximum

        public void setDateMaximum​(org.dom4j.Node dateMaximumNode)
      • setDateMinimum

        public void setDateMinimum​(Date dateMinimum)
      • getDateMinimum

        public Date getDateMinimum()
      • setDateMinimum

        public void setDateMinimum​(org.dom4j.Node dateMinimumNode)
      • setRangeMaximum

        public void setRangeMaximum​(double rangeMaximum)
        Parameters:
        double - rangeMaximum Set the maximum value of the range axis.
      • getTooltipContent

        public String getTooltipContent()
      • setTooltipContent

        public void setTooltipContent​(String tooltipContent)
      • getTooltipXFormat

        public String getTooltipXFormat()
      • setTooltipXFormat

        public void setTooltipXFormat​(String tooltipXFormat)
      • getTooltipYFormat

        public String getTooltipYFormat()
      • setTooltipYFormat

        public void setTooltipYFormat​(String tooltipYFormat)
      • setTooltipContent

        public void setTooltipContent​(org.dom4j.Node node)
      • setTooltipXFormat

        public void setTooltipXFormat​(org.dom4j.Node node)
      • setTooltipYFormat

        public void setTooltipYFormat​(org.dom4j.Node node)
      • setBackgroundAlpha

        public void setBackgroundAlpha​(org.dom4j.Node backgroundAlphaNode)
      • setForegroundAlpha

        public void setForegroundAlpha​(org.dom4j.Node foregroundAlphaNode)