Package org.pepstock.charba.client.data

Class LineDataset

    • Constructor Detail

      • LineDataset

        public LineDataset()
        Creates a dataset.
        It uses the global options has default.

      • LineDataset

        public LineDataset​(boolean hidden)
        Creates a dataset.
        It uses the global options has default.
        Parameters:
        hidden - if true, it will be initially hidden.

      • LineDataset

        public LineDataset​(IsDefaultOptions defaultValues)
        Creates the dataset using a default.
        Parameters:
        defaultValues - default options

      • LineDataset

        public LineDataset​(IsDefaultOptions defaultValues,
                   boolean hidden)
        Creates the dataset using a default.
        Parameters:
        defaultValues - default options
        hidden - if true, it will be initially hidden.

      • LineDataset

        protected LineDataset​(Type type,
                      boolean hidden)
        Creates the dataset using chart type related to the dataset.
        Parameters:
        type - chart type related to the dataset
        hidden - if true, it will be initially hidden.

      • LineDataset

        protected LineDataset​(Type type,
                      IsDefaultOptions defaultValues,
                      boolean hidden)
        Creates the dataset using a default and chart type related to the dataset.
        Parameters:
        type - chart type related to the dataset
        defaultValues - default options
        hidden - if true, it will be initially hidden.

    • Method Detail

      • setXAxisID

        public void setXAxisID​(String xAxisID)
        Sets the ID of the x axis to plot this dataset on.
        Parameters:
        xAxisID - the ID of the x axis to plot this dataset on.

      • setXAxisID

        public void setXAxisID​(ScaleId xAxisID)
        Sets the ID of the x axis to plot this data set on.
        Parameters:
        xAxisID - the ID of the x axis to plot this data set on.

      • getXAxisID

        public ScaleId getXAxisID()
        Returns the ID of the x axis to plot this data set on.
        If not specified, this defaults to the ID of DefaultScaleId.X.
        Returns:
        the ID of the x axis to plot this data set on.
        If not specified, this defaults to the ID of DefaultScaleId.X

      • setYAxisID

        public void setYAxisID​(String yAxisID)
        Sets the ID of the y axis to plot this data set on.
        Parameters:
        yAxisID - the ID of the y axis to plot this data set on.

      • setYAxisID

        public void setYAxisID​(ScaleId yAxisID)
        Sets the ID of the y axis to plot this data set on.
        Parameters:
        yAxisID - the ID of the y axis to plot this data set on.

      • getYAxisID

        public ScaleId getYAxisID()
        Returns the ID of the y axis to plot this data set on.
        If not specified, this defaults to the ID of DefaultScaleId.Y.
        Returns:
        the ID of the y axis to plot this data set on.
        If not specified, this defaults to the ID of DefaultScaleId.Y

      • setIndexAxis

        public void setIndexAxis​(IndexAxis indexAxis)
        Sets the base axis for the data set. Use IndexAxis.Y for vertical line.
        Parameters:
        indexAxis - the base axis for the data set

      • getIndexAxis

        public IndexAxis getIndexAxis()
        Returns the base axis for the data set.
        Returns:
        the base axis for the data set

      • setCubicInterpolationMode

        public void setCubicInterpolationMode​(CubicInterpolationMode mode)
        Sets algorithm used to interpolate a smooth curve from the discrete data points.
        The following interpolation modes are supported:

         'default'
 'monotone'

        The 'default' algorithm uses a custom weighted cubic interpolation, which produces pleasant curves for all types of datasets.
        The 'monotone' algorithm is more suited to y = f(x) datasets : it preserves monotonicity (or piecewise monotonicity) of the dataset being interpolated, and ensures local extremums (if any) stay at input data points.
        Parameters:
        mode - algorithm used to interpolate a smooth curve from the discrete data points

      • getCubicInterpolationMode

        public CubicInterpolationMode getCubicInterpolationMode()
        Returns algorithm used to interpolate a smooth curve from the discrete data points.
        Returns:
        algorithm used to interpolate a smooth curve from the discrete data points.

      • setShowLine

        public void setShowLine​(boolean showLine)
        Sets if the line is not drawn for this dataset.
        Parameters:
        showLine - false if the line is not drawn for this dataset.

      • isShowLine

        public boolean isShowLine()
        Returns if the line is not drawn for this dataset.
        Returns:
        false if the line is not drawn for this dataset.

      • setStepped

        public void setStepped​(boolean line)
        Sets if the line is shown as a stepped line.
        If the stepped value is set to anything other than false, tension will be ignored.
        Parameters:
        line - if the line is shown as a stepped line. false is no step interpolation

      • setStepped

        public void setStepped​(Stepped line)
        Sets if the line is shown as a stepped line.
        If the stepped value is set to anything other than false, tension will be ignored.
        Parameters:
        line - if the line is shown as a stepped line.

      • getStepped

        public Stepped getStepped()
        Returns if the line is shown as a stepped line.
        Returns:
        If the line is shown as a stepped line.

      • setDataString

        public void setDataString​(String... data)
        Sets the data property of a dataset for a chart is specified as an array of strings. Each point in the data array corresponds to the label at the same index on the x axis.
        Parameters:
        data - an array of strings

      • setDataString

        public void setDataString​(List<String> data)
        Sets the data property of a dataset for a chart is specified as an array of strings. Each point in the data array corresponds to the label at the same index on the x axis.
        Parameters:
        data - a list of strings

      • getDataString

        public List<String> getDataString()
        Returns the data property of a dataset for a chart is specified as an array of strings. Each point in the data array corresponds to the label at the same index on the x axis.
        Returns:
        a list of strings or an empty list of strings if the data type is not DataType.STRINGS.

      • getDataString

        public List<String> getDataString​(boolean binding)
        Returns the data property of a dataset for a chart is specified as an array of strings. Each point in the data array corresponds to the label at the same index on the x axis.
        Parameters:
        binding - if true binds the new array list in the container
        Returns:
        a list of strings or an empty list of strings if the data type is not DataType.STRINGS.

      • getCubicInterpolationModeCallback

        public CubicInterpolationModeCallback getCubicInterpolationModeCallback()
        Returns the border join style callback, if set, otherwise null.
        Returns:
        the border join style callback, if set, otherwise null.

      • setCubicInterpolationMode

        public void setCubicInterpolationMode​(CubicInterpolationModeCallback cubicInterpolationModeCallback)
        Sets the border join style callback.
        Parameters:
        cubicInterpolationModeCallback - the border join style callback.

      • setCubicInterpolationMode

        public void setCubicInterpolationMode​(NativeCallback cubicInterpolationModeCallback)
        Sets the border join style callback.
        Parameters:
        cubicInterpolationModeCallback - the border join style callback.

      • getSteppedCallback

        public SteppedCallback getSteppedCallback()
        Returns the stepped callback, if set, otherwise null.
        Returns:
        the stepped callback, if set, otherwise null.

      • setStepped

        public void setStepped​(SteppedCallback steppedCallback)
        Sets the stepped callback.
        Parameters:
        steppedCallback - the stepped callback.

      • setStepped

        public void setStepped​(NativeCallback steppedCallback)
        Sets the stepped callback.
        Parameters:
        steppedCallback - the stepped callback.

      • setOrder

        public default void setOrder​(int order)
        Sets the drawing order of dataset.
        Also affects order for stacking, tooltip, and legend.
        Parameters:
        order - the drawing order of dataset.

      • getOrder

        public default int getOrder()
        Returns the drawing order of dataset.
        Also affects order for stacking, tooltip, and legend.
        Returns:
        the drawing order of dataset

      • setPointStyle

        public default void setPointStyle​(PointStyle... pointStyle)
        Sets the style of the point.
        Parameters:
        pointStyle - array of the style of the point.

      • getPointStyle

        public default List<PointStyle> getPointStyle()
        Returns the style of the point.
        Returns:
        the style of the point or null if point style is set as image

      • setPointStyle

        public default void setPointStyle​(Img... pointStyle)
        Sets the style of the point as image.
        Parameters:
        pointStyle - image element of the style of the point as image.

      • getPointStyleType

        public default PointStyleType getPointStyleType()
        Returns the type of point style.
        Returns:
        the type of point style

      • getPointStyleAsImages

        public default List<Img> getPointStyleAsImages()
        Returns the style of the point as image.
        If property is missing or not an image, returns null.
        Returns:
        image of the style of the point as image.
        If property is missing or not a image, returns null.

      • setPointStyle

        public default void setPointStyle​(Canvas... pointStyle)
        Sets the style of the point as canvas.
        Parameters:
        pointStyle - canvas element of the style of the point as canvas.

      • getPointStyleAsCanvas

        public default List<Canvas> getPointStyleAsCanvas()
        Returns the style of the point as canvas.
        If property is missing or not an canvas, returns null.
        Returns:
        image of the style of the point as canvas.
        If property is missing or not a canvas, returns null.

      • getPointStyleCallback

        public default PointStyleCallback getPointStyleCallback()
        Returns the point style callback, if set, otherwise null.
        Returns:
        the point style callback, if set, otherwise null.

      • setPointStyle

        public default void setPointStyle​(PointStyleCallback pointStyleCallback)
        Sets the point style callback.
        Parameters:
        pointStyleCallback - the point style callback.