Package io.jmix.chartsflowui.kit.component.model

Class Grid

java.lang.Object
io.jmix.chartsflowui.kit.component.model.ChartObservableObject
io.jmix.chartsflowui.kit.component.model.Grid
All Implemented Interfaces:
HasPosition<Grid>, HasShadow<Grid>, Serializable
public class Grid extends ChartObservableObject implements HasPosition<Grid>, HasShadow<Grid>
Grid component is used to drawing grid in rectangular coordinate. In a single grid, at most two X and Y axes each is allowed. LineSeries, BarSeries, and ScatterSeries(EffectScatterSeries) can be drawn in the grid. More detailed information is provided in the documentation.
See Also:

  • Field Details

    • id

      protected String id

    • show

      protected Boolean show

    • zLevel

      protected Integer zLevel

    • z

      protected Integer z

    • left

      protected String left

    • top

      protected String top

    • bottom

      protected String bottom

    • width

      protected String width

    • height

      protected String height

    • containLabel

      protected Boolean containLabel

    • backgroundColor

      protected Color backgroundColor

    • borderColor

      protected Color borderColor

    • borderWidth

      protected Integer borderWidth

    • shadowBlur

      protected Integer shadowBlur

    • shadowColor

      protected Color shadowColor

    • shadowOffsetX

      protected Integer shadowOffsetX

    • shadowOffsetY

      protected Integer shadowOffsetY

    • tooltip

      protected InnerTooltip tooltip

  • Constructor Details

    • Grid

      public Grid()

  • Method Details

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • getShow

      public Boolean getShow()

    • setShow

      public void setShow(Boolean show)

    • getZLevel

      public Integer getZLevel()

    • setZLevel

      public void setZLevel(Integer zLevel)

    • getZ

      public Integer getZ()

    • setZ

      public void setZ(Integer z)

    • getLeft

      public String getLeft()
      Specified by:
      getLeft in interface HasPosition<Grid>
      Returns:
      distance between component and the left side of the container

    • setLeft

      public void setLeft(String left)
      Description copied from interface: HasPosition
      Sets a distance between component and the left side of the container.
      Possible values are:
      • A pixel value like "20".
      • Percentage value relative to container width like "20%".
      • Predefined values like "left", "center", "right".
      Specified by:
      setLeft in interface HasPosition<Grid>
      Parameters:
      left - distance to set

    • getTop

      public String getTop()
      Specified by:
      getTop in interface HasPosition<Grid>
      Returns:
      distance between component and the top side of the container

    • setTop

      public void setTop(String top)
      Description copied from interface: HasPosition
      Sets a distance between component and the top side of the container.
      Possible values are:
      • A pixel value like "20".
      • Percentage value relative to container width like "20%".
      • Predefined values like "top", "middle", "bottom".
      Specified by:
      setTop in interface HasPosition<Grid>
      Parameters:
      top - distance to set

    • getRight

      public String getRight()
      Specified by:
      getRight in interface HasPosition<Grid>
      Returns:
      distance between component and the right side of the container

    • setRight

      public void setRight(String right)
      Description copied from interface: HasPosition
      Sets a distance between component and the right side of the container.
      Possible values are:
      • A pixel value like "20".
      • Percentage value relative to container width like "20%".
      Specified by:
      setRight in interface HasPosition<Grid>
      Parameters:
      right - distance to set

    • getBottom

      public String getBottom()
      Specified by:
      getBottom in interface HasPosition<Grid>
      Returns:
      distance between component and the bottom side of the container

    • setBottom

      public void setBottom(String bottom)
      Description copied from interface: HasPosition
      Sets a distance between component and the bottom side of the container.
      Possible values are:
      • A pixel value like "20".
      • Percentage value relative to container width like "20%".
      Specified by:
      setBottom in interface HasPosition<Grid>
      Parameters:
      bottom - distance to set

    • getWidth

      public String getWidth()

    • setWidth

      public void setWidth(String width)

    • getHeight

      public String getHeight()

    • setHeight

      public void setHeight(String height)

    • getContainLabel

      public Boolean getContainLabel()

    • setContainLabel

      public void setContainLabel(Boolean containLabel)

    • getBackgroundColor

      public Color getBackgroundColor()

    • setBackgroundColor

      public void setBackgroundColor(Color backgroundColor)

    • getBorderColor

      public Color getBorderColor()

    • setBorderColor

      public void setBorderColor(Color borderColor)

    • getBorderWidth

      public Integer getBorderWidth()

    • setBorderWidth

      public void setBorderWidth(Integer borderWidth)

    • getShadowBlur

      public Integer getShadowBlur()
      Specified by:
      getShadowBlur in interface HasShadow<Grid>
      Returns:
      depth of shadow blur

    • setShadowBlur

      public void setShadowBlur(Integer shadowBlur)
      Description copied from interface: HasShadow
      Sets depth of shadow blur or replaces an existing one.
      Specified by:
      setShadowBlur in interface HasShadow<Grid>
      Parameters:
      shadowBlur - depth of shadow blur

    • getShadowColor

      public Color getShadowColor()
      Specified by:
      getShadowColor in interface HasShadow<Grid>
      Returns:
      shadow color

    • setShadowColor

      public void setShadowColor(Color shadowColor)
      Description copied from interface: HasShadow
      Sets a color for shadow or replaces an existing one.
      Specified by:
      setShadowColor in interface HasShadow<Grid>
      Parameters:
      shadowColor - color to set

    • getShadowOffsetX

      public Integer getShadowOffsetX()
      Specified by:
      getShadowOffsetX in interface HasShadow<Grid>
      Returns:
      horizontal offset for shadow in pixels

    • setShadowOffsetX

      public void setShadowOffsetX(Integer shadowOffsetX)
      Description copied from interface: HasShadow
      Sets horizontal offset for shadow or replaces an existing one.
      Specified by:
      setShadowOffsetX in interface HasShadow<Grid>
      Parameters:
      shadowOffsetX - offset to set in pixels

    • getShadowOffsetY

      public Integer getShadowOffsetY()
      Specified by:
      getShadowOffsetY in interface HasShadow<Grid>
      Returns:
      vertical offset for shadow in pixels

    • setShadowOffsetY

      public void setShadowOffsetY(Integer shadowOffsetY)
      Description copied from interface: HasShadow
      Sets vertical offset for shadow or replaces an existing one.
      Specified by:
      setShadowOffsetY in interface HasShadow<Grid>
      Parameters:
      shadowOffsetY - offset to set in pixels

    • getTooltip

      public InnerTooltip getTooltip()

    • setTooltip

      public void setTooltip(InnerTooltip tooltip)

    • withId

      public Grid withId(String id)

    • withShow

      public Grid withShow(Boolean show)

    • withZLevel

      public Grid withZLevel(Integer zLevel)

    • withZ

      public Grid withZ(Integer z)

    • withWidth

      public Grid withWidth(String width)

    • withHeight

      public Grid withHeight(String height)

    • withContainLabel

      public Grid withContainLabel(Boolean containLabel)

    • withBackgroundColor

      public Grid withBackgroundColor(Color backgroundColor)

    • withBorderColor

      public Grid withBorderColor(Color borderColor)

    • withBorderWidth

      public Grid withBorderWidth(Integer borderWidth)

    • withTooltip

      public Grid withTooltip(InnerTooltip tooltip)