Interface ComponentProperty

All Known Subinterfaces:
AbstractDataProvider<T>, CategoryDataProvider, Component, ComponentPart, DataProvider, DateDataProvider, InternalData<T>, SankeyDataProvider, TimeDataProvider, TreeDataProvider
All Known Implementing Classes:
AbstractChart, AbstractColor, AbstractData, AbstractDataStream, AbstractDataZoom, AbstractLabel, AbstractPart, AbstractProperty, AbstractStyle, Alignment, AngleAxis, Animation, Arc, ArcPart, Area, AreaStyle, Axis, Axis.AbstractTicks, Axis.GridAreas, Axis.GridLines, Axis.Label, Axis.Line, Axis.MinorGridLines, Axis.MinorTicks, Axis.Pointer, Axis.PointerHandle, Axis.PointerLabel, Axis.Ticks, BarChart, BasicDataProvider, BasicInternalDataProvider, BezierCurve, Border, BubbleChart, CandlestickChart, CandlestickData, CategoryData, Chart, Chart.Emphasis, Chart.Label, ChartImage, Circle, CirclePart, Color, ColorGradient, ComposedPart, CoordinateSystem, CoordinateSystemZoom, Data, DataStream, DataZoom, DataZoom.DataShadowStyle, DataZoom.HandleStyle, DateData, DateStream, DonutChart, Edge, EffectScatterChart, Emphasis, FunctionData, FunnelChart, GaugeChart, GaugeChart.AxisLine, GaugeChart.Needle, GraphChart, HeatmapChart, Image, InternalData.WrappedDataProvider, ItemStyle, Label, Legend, Line, LineChart, LineStyle, MarkArea, MarkArea.Block, MarkArea.Block.Side, NightingaleRoseChart, Node, Node.Symbol, Node.Type, Orientation, Padding, PieChart, PointSymbol, PolarCoordinate, PolarProperty, Polygon, Polyline, Position, RadarAxis, RadarChart, RadarCoordinate, RadiusAxis, Rectangle, RectangularCoordinate, Ring, SankeyChart, SankeyChart.Edge, SankeyChart.Node, SankeyData, ScatterChart, Sector, SelfPositioningChart, SelfPositioningSpecialChart, SerialData, SerialDate, SerialTime, Shadow, Shape, Shape.Style, ShapeGroup, Square, SunburstChart, Text, TextBorder, TextStyle, TimeData, TimeStream, Title, Toolbox, Toolbox.DataView, Toolbox.Download, Toolbox.Restore, Toolbox.Zoom, ToolboxButton, Tooltip, TreeChart, TreeData, TreeDataProvider.Label, TreemapChart, VisiblePart, VisualMap, XAxis, XYAxis, XYChart, YAxis

public interface ComponentProperty

Represents some combined attributes/properties owned by a Component or ComponentPart.

An example of an implementation of this interface is Position that is used by Components like RectangularCoordinate to position them within the chart display area defined by the SOChart. The typical use-case of ComponentProperty is as follows:

     RectangularCoordinate rc = new RectangularCoordinate();
     rc.getPosition(true).setTop(Size.percentage(50));
 

Please notice that the getPosition(create = true) call uses "true" as the parameter to create a position if it doesn't already exist. This is because, in most cases, default values will be automatically applied if no property values are present and it will save on the client communication.

Author:
Syam