Package overit.geocall.basic.ui.control

Class ChartSerie

java.lang.Object
overit.geocall.platform.ui.UINode
overit.geocall.ui.Component
overit.geocall.ui.Control
overit.geocall.basic.ui.control.ChartBase
overit.geocall.basic.ui.control.ChartSerie
All Implemented Interfaces:
Serializable, overit.geocall.marks.MethodExposer, overit.geocall.marks.NameExposer, Arrangeable, Badgeable, Identified, Tool, overit.geocall.ux.configurability.UIConfigurable, overit.geocall.ux.edm.ModelConfigurable
@Component public class ChartSerie extends ChartBase
This class extends ChartBase and implements a serie chart.
See Also:
GCApi:
component

  • Constructor Details

    • ChartSerie

      public ChartSerie()
      Creates a new instance of ChartSerie

    • ChartSerie

      protected ChartSerie(Holder<ChartScriptBuilder> chartScriptBuilderHolder, Holder<ChartSerieConfigurationBuilder> chartSerieConfigurationBuilderHolder)
      Creates a new instance of ChartSerie
      Parameters:
      chartScriptBuilderHolder - The holder for the chart script builder, it must create a new instance each time it is called.
      chartSerieConfigurationBuilderHolder - The holder for the chart serie configuration builder, it must create a new instance each time it is called.

  • Method Details

    • getDomainLabels

      public ListAttribute getDomainLabels()
      Returns the labels of the elements of the domain (x) axis for each serie
      Returns:
      The labels of the elements of the domain (x) axis for each serie

    • setDomainLabels

      public void setDomainLabels(ListAttribute domainLabels)
      Sets the labels of the elements of the domain (x) axis for each serie
      Parameters:
      domainLabels - The labels of the elements of the domain (x) axis for each serie

    • setDOMAINLABELS

      public void setDOMAINLABELS(String labels)
      Sets the labels of the elements of the domain (x) axis for each serie
      Parameters:
      labels - A ListAttribute in which every element, separated from the others by the | character, represents the label of an element of the domain (x) axis for each serie

    • getValuesMin

      public Double getValuesMin()
      Returns the minimum value for the value (y) axis.
      Returns:
      The minimum value for the value (y) axis

    • setValuesMin

      public void setValuesMin(Double valuesMin)
      Sets the minimum value for the value (y) axis.
      Parameters:
      valuesMin - The minimum value for the value (y) axis

    • setVALUESMIN

      public void setVALUESMIN(String s)
      Sets the minimum value for the value (y) axis.
      Parameters:
      s - The minimum value for the value (y) axis

    • getValuesMax

      public Double getValuesMax()
      Returns the maximum value for the value (y) axis.
      Returns:
      The maximum value for the value (y) axis

    • setValuesMax

      public void setValuesMax(Double valuesMax)
      Sets the maximum value for the value (y) axis.
      Parameters:
      valuesMax - The maximum value for the value (y) axis

    • setVALUESMAX

      public void setVALUESMAX(String s)
      Sets the maximum value for the value (y) axis.
      Parameters:
      s - The maximum value for the value (y) axis

    • isDomainGridLine

      public boolean isDomainGridLine()
      Returns whether the domain grid line should be shown.
      Returns:
      Whether the domain grid line should be shown.

    • setDomainGridLine

      public void setDomainGridLine(boolean domainGridLine)
      Sets whether the domain grid line should be shown.
      Parameters:
      domainGridLine - Whether the domain grid line should be shown.

    • setDOMAINGRIDLINE

      public void setDOMAINGRIDLINE(String s)
      Sets whether the domain grid line should be shown.
      Parameters:
      s - Whether the domain grid line should be shown.

    • isValuesGridLine

      public boolean isValuesGridLine()
      Returns whether the values grid line should be shown.
      Returns:
      Whether the values grid line should be shown.

    • setValuesGridLine

      public void setValuesGridLine(boolean valuesGridLine)
      Sets whether the values grid line should be shown.
      Parameters:
      valuesGridLine - Whether the values grid line should be shown.

    • setVALUESGRIDLINE

      public void setVALUESGRIDLINE(String s)
      Sets whether the values grid line should be shown.
      Parameters:
      s - Whether the values grid line should be shown.

    • getEvent

      public ListAttribute getEvent()
      Returns the names of the events triggered when the user clicks on an element of the legend box.
      Returns:
      The names of the events triggered when the user clicks on an element of the legend box

    • setEvent

      public void setEvent(ListAttribute event)
      Sets the names of the events triggered when the user clicks on an element of the legend box.
      Parameters:
      event - The names of the events triggered when the user clicks on an element of the legend box

    • setEVENT

      public void setEVENT(String s)
      Sets the names of the events triggered when the user clicks on an element of the legend box.
      Parameters:
      s - A ListAttribute in which every element, separated from the others by the | character, represents the name of an event triggered when the user clicks on an element of the legend box

    • getParam

      public ListAttribute getParam()
      Returns the parameters for the events triggered when the user clicks on an element of the legend box.
      Returns:
      The parameters for the events triggered when the user clicks on an element of the legend box

    • setParam

      public void setParam(ListAttribute param)
      Sets the parameters for the events triggered when the user clicks on an element of the legend box.
      Parameters:
      param - The parameters for the events triggered when the user clicks on an element of the legend box

    • setPARAM

      public void setPARAM(String s)
      Sets the parameters for the events triggered when the user clicks on an element of the legend box.
      Parameters:
      s - A ListAttribute in which every element, separated from the others by the | character, represents the parameter for the event triggered when the user clicks on an element of the legend box

    • getItemEvent

      public ListAttribute getItemEvent()
      Returns the names of the events triggered when the user clicks on an element of the chart.
      Returns:
      The names of the events triggered when the user clicks on an element of the chart

    • setItemEvent

      public void setItemEvent(ListAttribute itemEvent)
      Sets the names of the events triggered when the user clicks on an element of the chart.
      Parameters:
      itemEvent - The names of the events triggered when the user clicks on an element of the chart

    • setITEMEVENT

      public void setITEMEVENT(String s)
      Sets the names of the events triggered when the user clicks on an element of the chart.
      Parameters:
      s - A ListAttribute in which every element, separated from the others by the | character, represents the name of an event triggered when the user clicks on an element of the chart

    • getItemParam

      public ListAttribute getItemParam()
      Returns the parameters for the events triggered when the user clicks on an element of the chart.
      Returns:
      The parameters for the events triggered when the user clicks on an element of the chart

    • setItemParam

      public void setItemParam(ListAttribute itemParam)
      Sets the parameters for the events triggered when the user clicks on an element of the chart.
      Parameters:
      itemParam - The parameters for the events triggered when the user clicks on an element of the chart

    • setITEMPARAM

      public void setITEMPARAM(String s)
      Sets the parameters for the events triggered when the user clicks on an element of the chart.
      Parameters:
      s - A ListAttribute in which every element, separated from the others by the | character, represents the parameter for the event triggered when the user clicks on an element of the chart

    • getValuesStep

      public Double getValuesStep()
      Returns the step for the values (y) axis.
      Returns:
      The step for the values (y) axis

    • setValuesStep

      public void setValuesStep(Double valuesStep)
      Sets the step for the values (y) axis.
      Parameters:
      valuesStep - The step for the values (y) axis

    • setVALUESSTEP

      public void setVALUESSTEP(String s)
      Sets the step for the values (y) axis.
      Parameters:
      s - The step for the values (y) axis

    • getValuesTitle

      public String getValuesTitle()
      Returns the title for the values (y) axis.
      Returns:
      The title for the values (y) axis

    • setValuesTitle

      public void setValuesTitle(String valuesTitle)
      Sets the title for the values (y) axis.
      Parameters:
      valuesTitle - The title for the values (y) axis

    • setVALUESTITLE

      public void setVALUESTITLE(String s)
      Sets the title for the values (y) axis.
      Parameters:
      s - The title for the values (y) axis

    • getValuesTitleFont

      public overit.geocall.charts.ChartFont getValuesTitleFont()
      Returns the font for the title of the values (y) axis.
      Returns:
      The font for the title of the values (y) axis

    • setValuesTitleFont

      public void setValuesTitleFont(overit.geocall.charts.ChartFont valuesTitleFont)
      Sets the font for the title of the values (y) axis.
      Parameters:
      valuesTitleFont - The font for the title of the values (y) axis

    • setVALUESTITLEFONT

      public void setVALUESTITLEFONT(String s)
      Sets the font for the title of the values (y) axis.
      Parameters:
      s - A string that defines the font, with the format: name,variant,dimension,color.

    • getDomainTitleFont

      public overit.geocall.charts.ChartFont getDomainTitleFont()
      Returns the font for the values on the values (y) axis.
      Returns:
      The font for the values on the values (y) axis

    • setDomainTitleFont

      public void setDomainTitleFont(overit.geocall.charts.ChartFont domainTitleFont)
      Sets the font for the title of the domain (x) axis.
      Parameters:
      domainTitleFont - The font for the title of the domain (x) axis

    • setDOMAINTITLEFONT

      public void setDOMAINTITLEFONT(String s)
      Sets the font for the title of the domain (x) axis.
      Parameters:
      s - A string that defines the font, with the format: name,variant,dimension,color.

    • getDomainTitle

      public String getDomainTitle()
      Returns the title for the domain (x) axis.
      Returns:
      The title for the domain (x) axis

    • setDomainTitle

      public void setDomainTitle(String domainTitle)
      Sets the title for the domain (x) axis.
      Parameters:
      domainTitle - The title for the domain (x) axis

    • setDOMAINTITLE

      public void setDOMAINTITLE(String s)
      Sets the title for the domain (x) axis.
      Parameters:
      s - The title for the domain (x) axis

    • getValuesFont

      public overit.geocall.charts.ChartFont getValuesFont()
      Returns the font for the values on the domain (x) axis.
      Returns:
      The font for the values on the domain (x) axis

    • setValuesFont

      public void setValuesFont(overit.geocall.charts.ChartFont valuesFont)
      Sets the font for the values on the values (y) axis.
      Parameters:
      valuesFont - The font for the values on the values (y) axis

    • setVALUESFONT

      public void setVALUESFONT(String s)
      Sets the font for the values on the values (y) axis.
      Parameters:
      s - A string that defines the font, with the format: name,variant,dimension,color.

    • getDomainFont

      public overit.geocall.charts.ChartFont getDomainFont()
      Returns the font for the values on the domain (x) axis.
      Returns:
      The font for the values on the domain (x) axis

    • setDomainFont

      public void setDomainFont(overit.geocall.charts.ChartFont domainFont)
      Sets the font for the values on the domain (x) axis.
      Parameters:
      domainFont - The font for the values on the domain (x) axis

    • setDOMAINFONT

      public void setDOMAINFONT(String s)
      Sets the font for the values on the domain (x) axis.
      Parameters:
      s - A string that defines the font, with the format: name,variant,dimension,color.

    • getDomainRotation

      public int getDomainRotation()
      Returns the rotation for the values on the domain (x) axis.
      Returns:
      The rotation for the values on the domain (x) axis

    • setDomainRotation

      public void setDomainRotation(int domainRotation)
      Sets the rotation for the values on the domain (x) axis.
      Parameters:
      domainRotation - The rotation for the values on the domain (x) axis

    • setDOMAINROTATION

      public void setDOMAINROTATION(String s)
      Sets the rotation for the values on the domain (x) axis.
      Parameters:
      s - The rotation for the values on the domain (x) axis

    • isStacked

      public boolean isStacked()
      Returns whether the series should be stacked.
      Returns:
      Whether the series should be stacked

    • setStacked

      public void setStacked(boolean stacked)
      Sets whether the series should be stacked.
      Parameters:
      stacked - Whether the series should be stacked

    • setSTACKED

      public void setSTACKED(String s)
      Sets whether the series should be stacked.
      Parameters:
      s - A string that represents a boolean value ("true" or "1", "false" or "0").
      If the string is not recognized as a boolean value, it will be used the default one, that is false

    • getItemTooltipFormat

      public ListAttribute getItemTooltipFormat()
      Returns the format used for the tooltip messages.
      Returns:
      The format used for the tooltip messages

    • setItemTooltipFormat

      public void setItemTooltipFormat(ListAttribute itemTooltipFormat)
      Sets the format used for the tooltip messages.
      Parameters:
      itemTooltipFormat - The format used for the tooltip messages

    • setITEMTOOLTIPFORMAT

      public void setITEMTOOLTIPFORMAT(String s)
      Sets the format used for the tooltip messages.
      Parameters:
      s - A ListAttribute in which every element, separated from the others by the | character, represents the format used for the tooltip messages of the elements of the corresponding serie

    • getLabels

      public ListAttribute getLabels()
      Returns the labels of the elements of each serie.
      Returns:
      The labels of the elements of each serie

    • setLabels

      public void setLabels(ListAttribute labels)
      Sets the labels of the elements of each serie.
      Parameters:
      labels - The labels of the elements of each serie

    • setLABELS

      public void setLABELS(String s)
      Sets the labels of the elements of each serie.
      Parameters:
      s - A ListAttribute in which every element, separated from the others by the | character, represents one label of the elements of each serie

    • isVertical

      public boolean isVertical()
      Returns whether the chart should be vertical or not.
      Returns:
      Whether the chart should be vertical or not

    • setVertical

      public void setVertical(boolean vertical)
      Sets whether the chart should be vertical or not.
      Parameters:
      vertical - Whether the chart should be vertical or not

    • setVERTICAL

      public void setVERTICAL(String s)
      Sets whether the chart should be vertical or not.
      Parameters:
      s - A string that represents a boolean value ("true" or "1", "false" or "0").
      If the string is not recognized as a boolean value, it will be used the default one, that is true

    • isZoom

      public boolean isZoom()
      Returns whether the chart should be zoomable or not.
      Returns:
      Whether the chart should be zoomable or not

    • setZoom

      public void setZoom(boolean zoom)
      Sets whether the chart should be zoomable or not.
      Parameters:
      zoom - Whether the chart should be zoomable or not

    • setZOOM

      public void setZOOM(String s)
      Sets whether the chart should be zoomable or not.
      Parameters:
      s - A string that represents a boolean value ("true" or "1", "false" or "0").
      If the string is not recognized as a boolean value, it will be used the default one, that is true

    • getItemLabelFormat

      public ListAttribute getItemLabelFormat()
      Returns the format used for the labels of the elements of each serie.
      Returns:
      The format used for the labels of the elements of each serie

    • setItemLabelFormat

      public void setItemLabelFormat(ListAttribute itemLabelFormat)
      Sets the format used for the labels of the elements of each serie.
      Parameters:
      itemLabelFormat - The format used for the labels of the elements of each serie

    • setITEMLABELFORMAT

      public void setITEMLABELFORMAT(String s)
      Sets the format used for the labels of the elements of each serie.
      Parameters:
      s - A ListAttribute in which every element, separated from the others by the | character, represents the format used for the labels of the elements of the corresponding serie

    • getItemLabelFont

      public overit.geocall.charts.ChartFont getItemLabelFont()

    • setItemLabelFont

      public void setItemLabelFont(overit.geocall.charts.ChartFont itemLabelFont)

    • setITEMLABELFONT

      public void setITEMLABELFONT(String s)
      Sets the font used for the labels of the elements of each serie.
      Parameters:
      s - A string that defines the font, with the format: name,variant,dimension,color.

    • getSeries

      public List<ChartSerie.SerieEntry> getSeries()
      Returns the series of the chart.
      Returns:
      The series of the chart

    • getSerie

      public overit.geocall.charts.Serie getSerie(int pos)
      Returns the serie in the desired position.
      Parameters:
      pos - The index of the desired serie
      Returns:
      The serie in the desired position

    • addSerie

      public void addSerie(ChartSerieType type, overit.geocall.charts.Serie serie)
      Adds a serie to the chart.
      Parameters:
      type - The type of the serie
      serie - The serie to add

    • clearSeries

      public void clearSeries()
      Clears all the series of the chart.

    • getPaints

      protected ListAttribute getPaints()

    • getStrokes

      protected ListAttribute getStrokes()

    • getShapes

      protected ListAttribute getShapes()

    • setup

      protected void setup()
      Description copied from class: Component
      Setup the Component
      Overrides:
      setup in class ChartBase

    • getChartSerieConfigurationBuilderHolder

      protected Holder<ChartSerieConfigurationBuilder> getChartSerieConfigurationBuilderHolder()

    • getContentHtml

      public org.apache.ecs.Element getContentHtml(Object generationHandle, EntitySet es)
      Description copied from interface: Arrangeable
      Returns the html code that represents the active part of the component, i.e. the field and the validation scripts
      Specified by:
      getContentHtml in interface Arrangeable
      Overrides:
      getContentHtml in class ChartBase
      Parameters:
      generationHandle - the unique generatin handle
      es - the page entity set
      Returns:
      The html code of the component

    • buildJsonChartConfig

      protected String buildJsonChartConfig()
      Specified by:
      buildJsonChartConfig in class ChartBase

    • addEventHandlers

      protected void addEventHandlers(ChartScriptBuilder scriptBuilder)
      Overrides:
      addEventHandlers in class ChartBase