Package org.pepstock.charba.client.commons

Class ArrayGradient

  • @JsType(isNative=true,
        name="Array",
        namespace="<global>")
public final class ArrayGradient
extends Array
    Array object which maps the java script object.
    A simple wrapper around a homogeneous native array of object (CanvasGradientItem) values.
    Author:
    Andrea "Stock" Stocchero

    • Method Detail

      • fromOrNull

        @JsOverlay
public static ArrayGradient fromOrNull​(CanvasGradientItem... items)
        This method creates new array instance with a variable number of CanvasGradientItem arguments.
        Parameters:
        items - canvasPattern items to create new array
        Returns:
        new array instance of gradients or null if argument is null or length to 0

      • fromOrEmpty

        @JsOverlay
public static ArrayGradient fromOrEmpty​(CanvasGradientItem... items)
        This method creates new array instance with a variable number of CanvasGradientItem arguments.
        Parameters:
        items - canvasPattern items to create new array
        Returns:
        new array instance of gradients or an empty array if argument is null or length to 0

      • fromOrNull

        @JsOverlay
public static ArrayGradient fromOrNull​(List<CanvasGradientItem> items)
        Creates a java script array of gradients starting from list of gradients.
        Parameters:
        items - list of gradients to load in the new java script array.
        Returns:
        new array instance of gradients or null if argument is null or empty

      • fromOrEmpty

        @JsOverlay
public static ArrayGradient fromOrEmpty​(List<CanvasGradientItem> items)
        Creates a java script array of gradients starting from list of gradients.
        Parameters:
        items - list of gradients to load in the new java script array.
        Returns:
        new array instance of gradients or an empty array if argument is null or empty

      • get

        @JsOverlay
public CanvasGradientItem get​(int index)
        Gets the value at a given index. If no value exists at the given index, a type-conversion error will occur in Development Mode and unpredictable behavior may occur in Production Mode. If the numeric value returned is non-integral, it will cause a warning in Development Mode, and may affect the results of mathematical expressions.
        Parameters:
        index - the index to be retrieved
        Returns:
        the value at the given index