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
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject
ChartObservableObject.ObjectChangeEvent
-
Field Summary
Modifier and TypeFieldDescriptionprotected Color
protected Color
protected Integer
protected String
protected Boolean
protected String
protected String
protected String
protected String
protected Integer
protected Color
protected Integer
protected Integer
protected Boolean
protected InnerTooltip
protected String
protected String
protected Integer
protected Integer
Fields inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject
children, dirty, listener
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetId()
getLeft()
getRight()
getShow()
getTop()
getWidth()
getZ()
void
setBackgroundColor
(Color backgroundColor) void
setBorderColor
(Color borderColor) void
setBorderWidth
(Integer borderWidth) void
Sets a distance between component and the bottom side of the container.
Possible values are: A pixel value like"20"
.void
setContainLabel
(Boolean containLabel) void
void
void
Sets a distance between component and the left side of the container.
Possible values are: A pixel value like"20"
.void
Sets a distance between component and the right side of the container.
Possible values are: A pixel value like"20"
.void
setShadowBlur
(Integer shadowBlur) Sets depth of shadow blur or replaces an existing one.void
setShadowColor
(Color shadowColor) Sets a color for shadow or replaces an existing one.void
setShadowOffsetX
(Integer shadowOffsetX) Sets horizontal offset for shadow or replaces an existing one.void
setShadowOffsetY
(Integer shadowOffsetY) Sets vertical offset for shadow or replaces an existing one.void
void
setTooltip
(InnerTooltip tooltip) void
Sets a distance between component and the top side of the container.
Possible values are: A pixel value like"20"
.void
void
void
withBackgroundColor
(Color backgroundColor) withBorderColor
(Color borderColor) withBorderWidth
(Integer borderWidth) withContainLabel
(Boolean containLabel) withHeight
(String height) withTooltip
(InnerTooltip tooltip) withZLevel
(Integer zLevel) Methods inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject
addChild, fireChangeEvent, getChildren, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setChartObjectChangeListener, unmarkDirtyInDepth
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.jmix.chartsflowui.kit.component.model.HasPosition
withBottom, withLeft, withRight, withTop
Methods inherited from interface io.jmix.chartsflowui.kit.component.model.HasShadow
withShadowBlur, withShadowColor, withShadowOffsetX, withShadowOffsetY
-
Field Details
-
id
-
show
-
zLevel
-
z
-
left
-
top
-
right
-
bottom
-
width
-
height
-
containLabel
-
backgroundColor
-
borderColor
-
borderWidth
-
shadowBlur
-
shadowColor
-
shadowOffsetX
-
shadowOffsetY
-
tooltip
-
-
Constructor Details
-
Grid
public Grid()
-
-
Method Details
-
getId
-
setId
-
getShow
-
setShow
-
getZLevel
-
setZLevel
-
getZ
-
setZ
-
getLeft
- Specified by:
getLeft
in interfaceHasPosition<Grid>
- Returns:
- distance between component and the left side of the container
-
setLeft
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 interfaceHasPosition<Grid>
- Parameters:
left
- distance to set
-
A pixel value like
-
getTop
- Specified by:
getTop
in interfaceHasPosition<Grid>
- Returns:
- distance between component and the top side of the container
-
setTop
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 interfaceHasPosition<Grid>
- Parameters:
top
- distance to set
-
A pixel value like
-
getRight
- Specified by:
getRight
in interfaceHasPosition<Grid>
- Returns:
- distance between component and the right side of the container
-
setRight
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 interfaceHasPosition<Grid>
- Parameters:
right
- distance to set
-
A pixel value like
-
getBottom
- Specified by:
getBottom
in interfaceHasPosition<Grid>
- Returns:
- distance between component and the bottom side of the container
-
setBottom
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 interfaceHasPosition<Grid>
- Parameters:
bottom
- distance to set
-
A pixel value like
-
getWidth
-
setWidth
-
getHeight
-
setHeight
-
getContainLabel
-
setContainLabel
-
getBackgroundColor
-
getBorderColor
-
getBorderWidth
-
setBorderWidth
-
getShadowBlur
- Specified by:
getShadowBlur
in interfaceHasShadow<Grid>
- Returns:
- depth of shadow blur
-
setShadowBlur
Description copied from interface:HasShadow
Sets depth of shadow blur or replaces an existing one.- Specified by:
setShadowBlur
in interfaceHasShadow<Grid>
- Parameters:
shadowBlur
- depth of shadow blur
-
getShadowColor
- Specified by:
getShadowColor
in interfaceHasShadow<Grid>
- Returns:
- shadow color
-
getShadowOffsetX
- Specified by:
getShadowOffsetX
in interfaceHasShadow<Grid>
- Returns:
- horizontal offset for shadow in pixels
-
setShadowOffsetX
Description copied from interface:HasShadow
Sets horizontal offset for shadow or replaces an existing one.- Specified by:
setShadowOffsetX
in interfaceHasShadow<Grid>
- Parameters:
shadowOffsetX
- offset to set in pixels
-
getShadowOffsetY
- Specified by:
getShadowOffsetY
in interfaceHasShadow<Grid>
- Returns:
- vertical offset for shadow in pixels
-
setShadowOffsetY
Description copied from interface:HasShadow
Sets vertical offset for shadow or replaces an existing one.- Specified by:
setShadowOffsetY
in interfaceHasShadow<Grid>
- Parameters:
shadowOffsetY
- offset to set in pixels
-
getTooltip
-
withId
-
withShow
-
withZLevel
-
withZ
-
withWidth
-
withHeight
-
withContainLabel
-
withBorderWidth
-