Package com.stimulsoft.report.chart.view.series

Class StiSeries

java.lang.Object
com.stimulsoft.base.serializing.StiSerializedObject
com.stimulsoft.base.services.StiService
com.stimulsoft.report.chart.view.series.StiSeries
All Implemented Interfaces:
IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiSeries, IStiSeriesParent, Cloneable
Direct Known Subclasses:
StiBaseLineSeries, StiCandlestickSeries, StiClusteredColumnSeries, StiFunnelSeries, StiPieSeries, StiRadarSeries, StiStackedBarSeries, StiStackedBaseLineSeries, StiStackedColumnSeries
public abstract class StiSeries extends StiService implements IStiSeriesParent, IStiSeries, IStiJsonReportObject

  • Field Details

    • isTotalLabel

      public boolean isTotalLabel

  • Constructor Details

    • StiSeries

      public StiSeries()

  • Method Details

    • clone

      public IStiSeries clone()
      Creates a new object that is a copy of the current instance.
      Specified by:
      clone in interface IStiSeries
      Overrides:
      clone in class StiService
      Returns:
      A new object that is a copy of this instance.

    • BaseTransform

      protected void BaseTransform(Object context, float x, float y, float angle, float dx, float dy)

    • getOriginalArguments

      public Object[] getOriginalArguments()
      Specified by:
      getOriginalArguments in interface IStiSeries

    • setOriginalArguments

      public void setOriginalArguments(Object[] originalArguments)
      Specified by:
      setOriginalArguments in interface IStiSeries

    • getOriginalTopNValues

      public Object[] getOriginalTopNValues()
      Specified by:
      getOriginalTopNValues in interface IStiSeries

    • setOriginalTopNValues

      public void setOriginalTopNValues(Object[] originalTopNValues)
      Specified by:
      setOriginalTopNValues in interface IStiSeries

    • getParent

      public final StiComponent getParent()
      Specified by:
      getParent in interface IStiSeriesParent

    • getServiceName

      public String getServiceName()
      Gets a service name.
      Overrides:
      getServiceName in class StiService

    • getServiceCategory

      public final String getServiceCategory()
      Gets a service category.
      Overrides:
      getServiceCategory in class StiService

    • getServiceType

      public final Class getServiceType()
      Gets a service type.
      Specified by:
      getServiceType in class StiService

    • getCore

      public final StiSeriesCoreXF getCore()
      Specified by:
      getCore in interface IStiSeries

    • setCore

      public final void setCore(StiSeriesCoreXF value)
      Specified by:
      setCore in interface IStiSeries

    • getAllowApplyStyle

      public final boolean getAllowApplyStyle()
      Gets or sets value which indicates that chart style will be used.
      Specified by:
      getAllowApplyStyle in interface IStiSeries

    • setAllowApplyStyle

      public final void setAllowApplyStyle(boolean value)
      Specified by:
      setAllowApplyStyle in interface IStiSeries

    • getFormat

      public final String getFormat()
      Gets or sets string that is used to format series values.
      Specified by:
      getFormat in interface IStiSeries

    • setFormat

      public final void setFormat(String value)
      Specified by:
      setFormat in interface IStiSeries

    • getSortBy

      public final StiSeriesSortType getSortBy()
      Gets or sets mode of series values sorting.
      Specified by:
      getSortBy in interface IStiSeries

    • setSortBy

      public final void setSortBy(StiSeriesSortType value)
      Specified by:
      setSortBy in interface IStiSeries

    • getSortDirection

      public final StiSeriesSortDirection getSortDirection()
      Gets or sets sort direction.
      Specified by:
      getSortDirection in interface IStiSeries

    • setSortDirection

      public final void setSortDirection(StiSeriesSortDirection value)
      Specified by:
      setSortDirection in interface IStiSeries

    • getShowInLegend

      public final boolean getShowInLegend()
      Gets or sets value which indicates that series must be shown in legend.
      Specified by:
      getShowInLegend in interface IStiSeries

    • setShowInLegend

      public final void setShowInLegend(boolean value)
      Specified by:
      setShowInLegend in interface IStiSeries

    • getShowLabels

      @Deprecated public final boolean getShowLabels()
      Deprecated.

    • setShowLabels

      @Deprecated public final void setShowLabels(boolean value)
      Deprecated.

    • getShowSeriesLabels

      public final StiShowSeriesLabels getShowSeriesLabels()
      Gets or sets series labels output mode.
      Specified by:
      getShowSeriesLabels in interface IStiSeries

    • setShowSeriesLabels

      public final void setShowSeriesLabels(StiShowSeriesLabels value)
      Specified by:
      setShowSeriesLabels in interface IStiSeries

    • getShowShadow

      public final boolean getShowShadow()
      Gets or sets value which indicates draw shadow or no.
      Specified by:
      getShowShadow in interface IStiSeries

    • setShowShadow

      public final void setShowShadow(boolean value)
      Specified by:
      setShowShadow in interface IStiSeries

    • getFilterMode

      public final StiFilterMode getFilterMode()
      Gets or sets filter mode of series.

    • setFilterMode

      public final void setFilterMode(StiFilterMode value)

    • getFilters

      public final StiChartFiltersCollection getFilters()
      Gets or sets filters which used to filter series values.
      Specified by:
      getFilters in interface IStiSeries

    • setFilters

      public final void setFilters(StiChartFiltersCollection value)
      Specified by:
      setFilters in interface IStiSeries

    • getTrendLines

      public StiTrendLinesCollection getTrendLines()

    • setTrendLines

      public void setTrendLines(StiTrendLinesCollection trendLines)

    • getConditions

      public StiChartConditionsCollection getConditions()
      Gets or sets collection of conditions which can be used to change behavior of series.
      Specified by:
      getConditions in interface IStiSeries

    • setConditions

      public void setConditions(StiChartConditionsCollection value)
      Specified by:
      setConditions in interface IStiSeries

    • getTopN

      public IStiSeriesTopN getTopN()
      Gets or sets parameters of displaying top results.
      Specified by:
      getTopN in interface IStiSeries

    • setTopN

      public void setTopN(IStiSeriesTopN value)
      Specified by:
      setTopN in interface IStiSeries

    • getYAxis

      public final StiSeriesYAxis getYAxis()
      Gets or sets Y Axis for series on which will output string representation of arguments.
      Specified by:
      getYAxis in interface IStiSeries

    • setYAxis

      public final void setYAxis(StiSeriesYAxis value)
      Specified by:
      setYAxis in interface IStiSeries

    • getSeriesLabels

      public final IStiSeriesLabels getSeriesLabels()
      Gets or sets series labels settings.
      Specified by:
      getSeriesLabels in interface IStiSeries

    • setSeriesLabels

      public final void setSeriesLabels(IStiSeriesLabels value)
      Specified by:
      setSeriesLabels in interface IStiSeries

    • getTrendLine

      @Deprecated public IStiTrendLine getTrendLine()
      Deprecated.
      Use TrendLines

    • setTrendLine

      public void setTrendLine(IStiTrendLine value)

    • getChart

      public final IStiChart getChart()
      Specified by:
      getChart in interface IStiSeries

    • setChart

      public final void setChart(IStiChart value)
      Specified by:
      setChart in interface IStiSeries

    • getValues

      public final Double[] getValues()
      Specified by:
      getValues in interface IStiSeries

    • setValues

      public final void setValues(Double[] value)
      Specified by:
      setValues in interface IStiSeries

    • getValueDataColumn

      public String getValueDataColumn()
      Gets or sets a name of the column that contains the point value.

    • setValueDataColumn

      public void setValueDataColumn(String value)

    • getValuesString

      public final String getValuesString()

    • setValuesString

      public final void setValuesString(String value)

    • getArguments

      public Object[] getArguments()
      Specified by:
      getArguments in interface IStiSeries

    • setArguments

      public void setArguments(Object[] value)
      Specified by:
      setArguments in interface IStiSeries

    • getArgumentDataColumn

      public final String getArgumentDataColumn()
      Gets or sets a name of the column that contains the argument value.

    • setArgumentDataColumn

      public final void setArgumentDataColumn(String value)

    • getArgumentsString

      public final String getArgumentsString()

    • setArgumentsString

      public final void setArgumentsString(String value)

    • getAutoSeriesTitleDataColumn

      public final String getAutoSeriesTitleDataColumn()
      Gets or sets a name of the column that contains the title of auto created series.

    • setAutoSeriesTitleDataColumn

      public final void setAutoSeriesTitleDataColumn(String value)

    • getAutoSeriesKeyDataColumn

      public final String getAutoSeriesKeyDataColumn()
      Gets or sets a name of the column that contains the key of auto created series.

    • setAutoSeriesKeyDataColumn

      public final void setAutoSeriesKeyDataColumn(String value)

    • getAutoSeriesColorDataColumn

      public final String getAutoSeriesColorDataColumn()
      Gets or sets a name of the column that contains the color of auto created series. Color must be presented as string.

    • setAutoSeriesColorDataColumn

      public final void setAutoSeriesColorDataColumn(String value)

    • getToolTips

      public String[] getToolTips()
      Specified by:
      getToolTips in interface IStiSeries

    • setToolTips

      public void setToolTips(String[] value)
      Specified by:
      setToolTips in interface IStiSeries

    • getToolTipDataColumn

      public final String getToolTipDataColumn()
      Gets or sets a name of the column that contains the tool tip value.

    • setToolTipDataColumn

      public final void setToolTipDataColumn(String value)

    • getToolTipsString

      public final String getToolTipsString()

    • setToolTipsString

      public final void setToolTipsString(String value)

    • getTags

      public Object[] getTags()
      Specified by:
      getTags in interface IStiSeries

    • setTags

      public void setTags(Object[] value)
      Specified by:
      setTags in interface IStiSeries

    • getTagDataColumn

      public final String getTagDataColumn()
      Gets or sets a name of the column that contains the tag value.

    • setTagDataColumn

      public final void setTagDataColumn(String value)

    • getTagString

      public final String getTagString()

    • setTagString

      public final void setTagString(String value)

    • getHyperlinks

      public String[] getHyperlinks()
      Specified by:
      getHyperlinks in interface IStiSeries

    • setHyperlinks

      public void setHyperlinks(String[] value)
      Specified by:
      setHyperlinks in interface IStiSeries

    • getHyperlinkDataColumn

      public final String getHyperlinkDataColumn()
      Gets or sets a name of the column that contains the hyperlink value.

    • setHyperlinkDataColumn

      public final void setHyperlinkDataColumn(String value)

    • getHyperlinkString

      public final String getHyperlinkString()

    • setHyperlinkString

      public final void setHyperlinkString(String value)

    • getDrillDownEnabled

      public boolean getDrillDownEnabled()
      Gets or sets value which indicates whether the Drill-Down operation can be executed.

    • setDrillDownEnabled

      public void setDrillDownEnabled(boolean value)

    • getDrillDownReport

      public String getDrillDownReport()
      Gets or sets a path to a report for the Drill-Down operation.

    • setDrillDownReport

      public void setDrillDownReport(String value)

    • getDrillDownPage

      public StiPage getDrillDownPage()
      Gets or sets a page for the Drill-Down operation.

    • setDrillDownPage

      public void setDrillDownPage(StiPage value)

    • getDrillDownPageGuid

      public final String getDrillDownPageGuid()

    • setDrillDownPageGuid

      public final void setDrillDownPageGuid(String value)

    • getAllowSeries

      public final boolean getAllowSeries()

    • setAllowSeries

      public final void setAllowSeries(boolean value)

    • getAllowSeriesElements

      public final boolean getAllowSeriesElements()

    • setAllowSeriesElements

      public final void setAllowSeriesElements(boolean value)

    • getCoreTitle

      public final String getCoreTitle()
      Specified by:
      getCoreTitle in interface IStiSeries

    • setCoreTitle

      public final void setCoreTitle(String value)
      Specified by:
      setCoreTitle in interface IStiSeries

    • getInteraction

      public IStiSeriesInteraction getInteraction()
      Gets interaction options of this series.
      Specified by:
      getInteraction in interface IStiSeries

    • setInteraction

      public void setInteraction(IStiSeriesInteraction value)
      Specified by:
      setInteraction in interface IStiSeries

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • GetNullableValuesFromString

      public static Double[] GetNullableValuesFromString(String list)

    • GetValuesFromString

      public static ArrayList<Double> GetValuesFromString(String list)

    • GetStringsFromString

      public static String[] GetStringsFromString(String list)

    • GetArgumentsFromString

      public static Object[] GetArgumentsFromString(String list)

    • GetDefaultAreaType

      public abstract Class GetDefaultAreaType()
      Specified by:
      GetDefaultAreaType in interface IStiSeries

    • InvokeNewAutoSeries

      public final void InvokeNewAutoSeries(StiNewAutoSeriesEventArgs e)
      Occurs when new auto series is created.

    • getNewAutoSeriesEvent

      public final StiNewAutoSeriesEvent getNewAutoSeriesEvent()
      Occurs when new auto series is created.

    • setNewAutoSeriesEvent

      public final void setNewAutoSeriesEvent(StiNewAutoSeriesEvent value)

    • OnGetValue

      protected void OnGetValue(StiGetValueEventArgs e)
      Raises the GetValue event.

    • InvokeGetValue

      public void InvokeGetValue(StiComponent sender, StiGetValueEventArgs e)
      Raises the GetValue event.

    • getGetValueEvent

      public final StiGetValueEvent getGetValueEvent()
      Occurs when getting the property Value.

    • setGetValueEvent

      public final void setGetValueEvent(StiGetValueEvent value)

    • OnGetListOfValues

      protected void OnGetListOfValues(StiGetValueEventArgs e)
      Raises the values event.

    • InvokeGetListOfValues

      public final void InvokeGetListOfValues(StiComponent sender, StiGetValueEventArgs e)
      Raises the GetListOfValues event.

    • getGetListOfValuesEvent

      public final StiGetListOfValuesEvent getGetListOfValuesEvent()
      Occurs when getting the list of values.

    • setGetListOfValuesEvent

      public final void setGetListOfValuesEvent(StiGetListOfValuesEvent value)

    • OnGetArgument

      protected void OnGetArgument(StiValueEventArgs e)
      Raises the GetArgument event.

    • InvokeGetArgument

      public void InvokeGetArgument(StiComponent sender, StiValueEventArgs e)
      Raises the GetArgument event.

    • getGetArgumentEvent

      public final StiGetArgumentEvent getGetArgumentEvent()
      Occurs when getting the property Argument.

    • setGetArgumentEvent

      public final void setGetArgumentEvent(StiGetArgumentEvent value)

    • OnGetListOfArguments

      protected void OnGetListOfArguments(StiGetValueEventArgs e)
      Raises the Arguments event.

    • InvokeGetListOfArguments

      public final void InvokeGetListOfArguments(StiComponent sender, StiGetValueEventArgs e)
      Raises the GetListOfArguments event.

    • getGetListOfArgumentsEvent

      public final StiGetListOfArgumentsEvent getGetListOfArgumentsEvent()
      Occurs when getting the list of arguments.

    • setGetListOfArgumentsEvent

      public final void setGetListOfArgumentsEvent(StiGetListOfArgumentsEvent value)

    • OnGetTitle

      protected void OnGetTitle(StiGetTitleEventArgs e)
      Raises the GetTitle event.

    • InvokeGetTitle

      public void InvokeGetTitle(StiComponent sender, StiGetTitleEventArgs e)
      Raises the GetTitle event.

    • getGetTitleEvent

      public final StiGetTitleEvent getGetTitleEvent()
      Occurs when getting the property Title.

    • setGetTitleEvent

      public final void setGetTitleEvent(StiGetTitleEvent value)

    • OnGetToolTip

      protected void OnGetToolTip(StiValueEventArgs e)
      Raises the GetToolTip event.
      Parameters:
      e - A parameter which contains event data.

    • InvokeGetToolTip

      public final void InvokeGetToolTip(StiComponent sender, StiValueEventArgs e)
      Raises the GetToolTip event.
      Parameters:
      sender - A sender which invokes an event.
      e - A parameter which contains event data.

    • getGetToolTipEvent

      public StiGetToolTipEvent getGetToolTipEvent()
      Occurs when getting the ToolTip for the series.

    • setGetToolTipEvent

      public void setGetToolTipEvent(StiGetToolTipEvent value)

    • OnGetListOfToolTips

      protected void OnGetListOfToolTips(StiGetValueEventArgs e)
      Raises the GetListOfToolTips event.

    • InvokeGetListOfToolTips

      public final void InvokeGetListOfToolTips(StiComponent sender, StiGetValueEventArgs e)
      Raises the GetListOfToolTips event.

    • getGetListOfToolTipsEvent

      public final StiGetListOfToolTipsEvent getGetListOfToolTipsEvent()
      Occurs when getting the list of ToolTips.

    • setGetListOfToolTipsEvent

      public final void setGetListOfToolTipsEvent(StiGetListOfToolTipsEvent value)

    • OnGetTag

      protected void OnGetTag(StiValueEventArgs e)
      Raises the GetTag event.
      Parameters:
      e - A parameter which contains event data.

    • InvokeGetTag

      public final void InvokeGetTag(StiComponent sender, StiValueEventArgs e)
      Raises the GetTag event.
      Parameters:
      sender - A sender which invokes an event.
      e - A parameter which contains event data.

    • getGetTagEvent

      public StiGetTagEvent getGetTagEvent()
      Occurs when getting the Tag for the series.

    • setGetTagEvent

      public void setGetTagEvent(StiGetTagEvent value)

    • OnGetListOfTags

      protected void OnGetListOfTags(StiGetValueEventArgs e)
      Raises the GetListOfTags event.

    • InvokeGetListOfTags

      public final void InvokeGetListOfTags(StiComponent sender, StiGetValueEventArgs e)
      Raises the GetListOfTags event.

    • getGetListOfTagsEvent

      public final StiGetListOfTagsEvent getGetListOfTagsEvent()
      Occurs when getting the list of Tags.

    • setGetListOfTagsEvent

      public final void setGetListOfTagsEvent(StiGetListOfTagsEvent value)

    • OnGetHyperlink

      protected void OnGetHyperlink(StiValueEventArgs e)
      Raises the GetHyperlink event.
      Parameters:
      e - A parameter which contains event data.

    • InvokeGetHyperlink

      public final void InvokeGetHyperlink(StiComponent sender, StiValueEventArgs e)
      Raises the GetHyperlink event.
      Parameters:
      sender - A sender which invokes an event.
      e - A parameter which contains event data.

    • getGetHyperlinkEvent

      public StiGetHyperlinkEvent getGetHyperlinkEvent()
      Occurs when getting the Hyperlink for the series.

    • setGetHyperlinkEvent

      public void setGetHyperlinkEvent(StiGetHyperlinkEvent value)

    • OnGetListOfHyperlinks

      protected void OnGetListOfHyperlinks(StiGetValueEventArgs e)
      Raises the Hyperlinks event.

    • InvokeGetListOfHyperlinks

      public final void InvokeGetListOfHyperlinks(StiComponent sender, StiGetValueEventArgs e)
      Raises the GetListOfHyperlinks event.

    • getGetListOfHyperlinksEvent

      public final StiGetListOfHyperlinksEvent getGetListOfHyperlinksEvent()
      Occurs when getting the list of Hyperlinks.

    • setGetListOfHyperlinksEvent

      public final void setGetListOfHyperlinksEvent(StiGetListOfHyperlinksEvent value)

    • getValuesStart

      public Double[] getValuesStart()
      Specified by:
      getValuesStart in interface IStiSeries

    • setValuesStart

      public void setValuesStart(Double[] valuesStart)

    • getValue

      public StiExpression getValue()
      Gets or sets point value expression. Example: {Order.Value}

    • setValue

      public void setValue(StiExpression value)

    • getListOfValues

      public StiListOfValuesExpression getListOfValues()
      Gets or sets the expression to fill a list of values. Example: 1;2;3

    • setListOfValues

      public void setListOfValues(StiListOfValuesExpression value)

    • getArgument

      public StiArgumentExpression getArgument()

    • setArgument

      public void setArgument(StiArgumentExpression value)

    • getListOfArguments

      public StiListOfArgumentsExpression getListOfArguments()
      Gets or sets the expression to fill a list of arguments. Example: 1;2;3

    • setListOfArguments

      public void setListOfArguments(StiListOfArgumentsExpression value)

    • getTitleValue

      public String getTitleValue()
      Gets or sets title of series.
      Specified by:
      getTitleValue in interface IStiSeries

    • setTitleValue

      public void setTitleValue(String value)
      Specified by:
      setTitleValue in interface IStiSeries

    • getTitle

      public StiTitleExpression getTitle()
      Gets or sets title of series.

    • setTitle

      public void setTitle(StiTitleExpression value)

    • getToolTip

      public StiToolTipExpression getToolTip()
      Gets or sets the expression to fill a series tooltip.

    • setToolTip

      public void setToolTip(StiToolTipExpression value)

    • getListOfToolTips

      public StiListOfToolTipsExpression getListOfToolTips()
      Gets or sets the expression to fill a list of tool tips. Example: 1;2;3

    • setListOfToolTips

      public void setListOfToolTips(StiListOfToolTipsExpression value)

    • getTag

      public StiTagExpression getTag()
      Gets or sets the expression to fill a series tag.

    • setTag

      public void setTag(StiTagExpression value)

    • getListOfTags

      public StiListOfTagsExpression getListOfTags()
      Gets or sets the expression to fill a list of tags. Example: 1;2;3

    • setListOfTags

      public void setListOfTags(StiListOfTagsExpression value)

    • getHyperlink

      public StiHyperlinkExpression getHyperlink()
      Gets or sets the expression to fill a series hyperlink.

    • setHyperlink

      public void setHyperlink(StiHyperlinkExpression value)

    • getListOfHyperlinks

      public StiListOfHyperlinksExpression getListOfHyperlinks()
      Gets or sets the expression to fill a list of hyperlinks. Example: 1;2;3

    • setListOfHyperlinks

      public void setListOfHyperlinks(StiListOfHyperlinksExpression value)

    • SaveToJsonObject

      public JSONObject SaveToJsonObject(StiJsonSaveMode mode) throws JSONException
      Specified by:
      SaveToJsonObject in interface IStiJsonReportObject
      Throws:
      JSONException

    • LoadFromJsonObject

      public void LoadFromJsonObject(JSONObject jObject) throws JSONException
      Specified by:
      LoadFromJsonObject in interface IStiJsonReportObject
      Throws:
      JSONException

    • ProcessSeriesColors

      public StiColor ProcessSeriesColors(int pointIndex, StiColor seriesColor)

    • ProcessSeriesMarkerType

      public StiMarkerType ProcessSeriesMarkerType(int pointIndex, StiMarkerType markerType)
      Specified by:
      ProcessSeriesMarkerType in interface IStiSeries

    • ProcessSeriesMarkerAngle

      public double ProcessSeriesMarkerAngle(int pointIndex, double markerAngle)
      Specified by:
      ProcessSeriesMarkerAngle in interface IStiSeries

    • ProcessSeriesMarkerVisible

      public boolean ProcessSeriesMarkerVisible(int pointIndex)
      Specified by:
      ProcessSeriesMarkerVisible in interface IStiSeries

    • ProcessSeriesBrushes

      public StiBrush ProcessSeriesBrushes(int pointIndex, StiBrush seriesBrush)
      Specified by:
      ProcessSeriesBrushes in interface IStiSeries

    • GetApproximationValuesStart

      public Double[] GetApproximationValuesStart()