TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.core.internal
Class DGraphic

java.lang.Object
  extended by org.eclipse.tptp.platform.report.core.internal.DItem
      extended by org.eclipse.tptp.platform.report.core.internal.DItemContainer
          extended by org.eclipse.tptp.platform.report.core.internal.DGraphic
All Implemented Interfaces:
IDItem, IDObject, IDParagraphItem, IDRenderable, IDSizeableItem, org.eclipse.tptp.platform.report.core.provisional.IChart

Deprecated. As of TPTP 4.5.0, use the TPTP Business Intelligence and Reporting Tools (BIRT) reporting infrastructure (org.eclipse.tptp.platform.report.birt).

public class DGraphic
extends DItemContainer
implements IDRenderable, IDSizeableItem, IDParagraphItem, org.eclipse.tptp.platform.report.core.provisional.IChart

Graphics purpose is to display chart in documents. Graphics are parent of axis and curve, curve must contains at least one points (or more, depending on curve type), and points define one or more coordinates (associated to an axis), that's the data structure of a graphic. Graphics have a type (see T_xxxx constants), used by drivers (ie graphic render) to display data in differents way. In addition display property (see D_xxxx constants) can be used to configure graphic rendering (for instance including legend...) Graphic may have a title. In addition graphic can hold any property. A property is an object associated with a key (String). By default DGraphic define any property key (se P_xxx constants) but user can add it own property (very usefull for graphic render). Few graphics type can have textuals labels, see DPoint class to know how to set labels and which graphic type can have labels.


Field Summary
static double DEF_3D_HEIGHT
          Deprecated. default value for P_3D_HEIGHT property
static float DEF_3D_LIGHT
          Deprecated. default value for P_3D_LIGHT property
static float DEF_3D_SHADOW
          Deprecated. default value for P_3D_SHADOW property
static java.lang.String P_3D
          Deprecated. boolean property to set "3D" effect on graphics (ie 3D bar in histograms).
static java.lang.String P_3D_HEIGHT
          Deprecated. property key for a positive number to change height (DEF_3D_HEIGHT by default).
static java.lang.String P_3D_LIGHT
          Deprecated. property key for a float(double) number to change 3D graphic's light strength (close to specular light effect) 0 means no light, 1 means light is White, default value is DEF_3D_LIGHT.
static java.lang.String P_3D_SHADOW
          Deprecated. property key for a float(double) number to change 3D graphic's shadow strength. 0 means no shadow, 1 means shadow is Black, default value is DEF_3D_SHADOW.
static java.lang.String P_BACK_AREA
          Deprecated. If property is set (true), the filled area of T_STACKED_AREA and T_AREA curves are drawn below the axis lines, otherwise filled area are drawn above axis lines (and can hidde them).
static java.lang.String P_BACKCOLOR
          Deprecated. string property to set a color for the background.
static java.lang.String P_HEIGHT_SCALE
          Deprecated. property to set a scale on the height of the graphic, scale is in 0..1, default is 1
static java.lang.String P_ID
          Deprecated. property key for a string value which defines the chart id.
static java.lang.String P_LEGEND_ACC_DESC
          Deprecated. property key for a string object which defines the legend description required by the screen reader.
static java.lang.String P_LEGEND_ACC_TITLE
          Deprecated. property key for a string object which defines the legend title required by the screen reader.
static java.lang.String P_LEGEND_BACKCOLOR
          Deprecated. property key for an IDColor which defines the background color for the legend.
static java.lang.String P_LEGEND_EVENT_LIST
          Deprecated. property key for a List of DEvent object which defines the interactions on the chart legend.
static java.lang.String P_LEGEND_HEIGHT
          Deprecated. property key for a integer defining the height of the legend can graphically take.
static java.lang.String P_LEGEND_ID
          Deprecated. property key for a string object which defines the legend id.
static java.lang.String P_LEGEND_LABEL
          Deprecated. property key for a string which defines the label for the legend.
static java.lang.String P_LEGEND_LAYOUT
          Deprecated. property key for a DAlignmentPair object controlling the layout and alignment of graphic legend.
static java.lang.String P_LEGEND_LIMIT
          Deprecated. property key for a integer defining the maximum space the legend can graphically take.
static java.lang.String P_LEGEND_LOCATION
          Deprecated. property key for a string object which defines the legend location.
static java.lang.String P_LEGEND_TOOLTIP
          Deprecated. property key for a string which defines the tooltip for the legend.
static java.lang.String P_LEGEND_WIDTH
          Deprecated. property key for a integer defining the width of the legend can graphically take.
static java.lang.String P_MARGIN
          Deprecated. property key for a positive integer to change margin used by default chart render.
static java.lang.String P_MAX_HEIGHT
          Deprecated. property to constraint the maximum height of graphic in pixel...
static java.lang.String P_MAX_WIDTH
          Deprecated. property to constraint the maximum width of graphic in pixel...
static java.lang.String P_MIN_HEIGHT
          Deprecated. property to constraint the minimum height of graphic in pixel...
static java.lang.String P_MIN_WIDTH
          Deprecated. property to constraint the minimum width of graphic in pixel...
static java.lang.String P_PLOTAREA_BACKCOLOR
          Deprecated. property key for an IDColor which is the background color of the plot area.
static java.lang.String P_SHOW_BORDER
          Deprecated. property key for the a boolean which the chart displays or not the border.
static java.lang.String P_SHOW_LEGEND
          Deprecated. property key, hold a Boolean value false to not display legend (otherwise the legend is displayed)
static java.lang.String P_SHOW_PERCENTAGE
          Deprecated. property key for string value which defines if the value is displayed as a percentage.
static java.lang.String P_SHOW_PLOTAREA_BORDER
          Deprecated. property key for the a boolean which the chart displays or not the border.
static java.lang.String P_SHOW_TITLE
          Deprecated. property key, hold a Boolean value false to not display graphic title (otherwise the title is displayed)
static java.lang.String P_SHOW_VALUES
          Deprecated. property key for T_SECTORS(3D) graphic for a boolean driving the display or not of values (and labels).
static java.lang.String P_THIN_BAR
          Deprecated. boolean property to set thin bar, or connected bar.
static java.lang.String P_TITLE_ACC_DESC
          Deprecated. property key for a string which defines title description required by the screen reader.
static java.lang.String P_TITLE_ACC_TITLE
          Deprecated. property key for a string which defines accessibility title required by the screen reader.
static java.lang.String P_TITLE_BACKCOLOR
          Deprecated. property key for an IDColor which defines the background color of the title Only activated for the SVG generation.
static java.lang.String P_TITLE_EVENT_LIST
          Deprecated. property key for a List of DEvent object which defines the interaction on the chart title.
static java.lang.String P_TITLE_LAYOUT
          Deprecated. property key for a DAlignmentPair object controlling the layout and alignment of graphic title.
static java.lang.String P_TITLE_TOOLTIP
          Deprecated. property key for a string which defines the tooltip of the title Only activated for the SVG generation.
static java.lang.String P_TITLE_WITH_SEPARATOR
          Deprecated. property key for a string which defines the separator Only activated for the SVG generation.
static java.lang.String P_VALUE_FORMAT
          Deprecated. property key for a string value which defines the value format displayed in the chart.
static java.lang.String P_VERSION
          Deprecated. property key for a string which represents the format version.
static java.lang.String P_WIDTH_SCALE
          Deprecated. property to set a scale on the width of the graphic, scale is in 0..1, default is 1
static java.lang.String P_XYS_COLORIZER
          Deprecated. property key for an instance of IXYSurfaceColorizer class, used by T_XY_SURFACE graphic type to get surface colors.
static java.lang.String P_XYS_CONTOUR_LINE
          Deprecated. property key to draw contour line on T_XY_SURFACE graphic type.
static java.lang.String P_XYS_CONTOUR_LINE_COLOR
          Deprecated. property key to define color of contour line drawn by T_XY_SURFACE graphic type.
static java.lang.String P_XYS_LINE_X
          Deprecated. property key for an integer (N) used by T_XY_SURFACE graphic type to render line every N face of surfaces along X axis, 0 for none.
static java.lang.String P_XYS_LINE_Y
          Deprecated. property key for an integer (N) used by T_XY_SURFACE graphic type to render line every N face of surfaces along Y axis, 0 for none.
static java.lang.String P_XYS_NO_POLYGON
          Deprecated. property key to avoid filling of polygon in a T_XY_SURFACE.
static java.lang.String P_XYZ_PHI
          Deprecated. property key for 'phi' (angle view for XYZ graphs), Float class if exists
static java.lang.String P_XYZ_THETA
          Deprecated. property key for 'theta' (angle view for XYZ graphs), Float class if exists
static java.lang.String P_XYZ_XPROJ
          Deprecated. property to force projection status on X axis, Boolean (default: true)
static java.lang.String P_XYZ_YPROJ
          Deprecated. property to force projection status on Y axis, Boolean (default: true)
static java.lang.String P_XYZ_ZPROJ
          Deprecated. property to force projection status on Z axis, Boolean (default: true)
protected  DPropertyStore properties_
          Deprecated. Property store
static java.lang.String T_H_HISTOGRAM_IM
          Deprecated. graphic is a flat histogram using mixed values, means each point having same index from curves are rendered together.
static java.lang.String T_H_STACKBARS
          Deprecated. Graphic made of vertical stacked bars.
static java.lang.String T_HBARS
          Deprecated. graphic made of horizontal bars, this graphic type contains four kind of graphics: simple histogram bars: use une DAxis, several DCurve and DPoint with one DCoord by point one chart begin-end bars: use one DAxis, several DCurve/DPoint, by set two DCoord by points two horizontal bars: same as simple horizontal bars, but use two DAxis (one by chart).
static java.lang.String T_HISTOGRAM
          Deprecated. graphic made of vertical bar, require one axis, several DCurve and DPoint.
static java.lang.String T_HISTOGRAM_IM
          Deprecated. graphic is a flat histogram using mixed values, means each point having same index from curves are rendered together.
static java.lang.String T_HISTORS
          Deprecated. graphic is made of fixed angle sectors but ray depends on points values
static java.lang.String T_METER
          Deprecated. Graphic showing a Meter.
static java.lang.String T_PIE3D
          Deprecated. Graphic is a Pie chart using 3D projection, with free rotation.
static java.lang.String T_SECTORS
          Deprecated. graphic is made of flat sectors, require one axis, 1+ curve with 1+ points
static java.lang.String T_SECTORS3D
          Deprecated. graphic is made of sectors displayed as simulated 3D elevation (see T_SECTORS)
static java.lang.String T_SERIES3D
          Deprecated. Graphic made of real 3D bars, 3D lines (ribbon), others.
static java.lang.String T_STACKBARS
          Deprecated. Graphic made of vertical stacked bars.
static java.lang.String T_TORUS3D
          Deprecated. Graphic is a 3D Torus, with free rotation (similar to T_PIE3D but using a torus as volume).
static java.lang.String T_WIREFRAME
          Deprecated. 3D graphic displaying a surface, require 3 axis, 2+ curves with same number of points .
static java.lang.String T_XY
          Deprecated. default values for graphic_type_ 2D plan, required two axis support curve type LINE,BAR,POINTS.
static java.lang.String T_XY_SURFACE
          Deprecated. Graphic is a XY Surface with Z raising, rendered using 3D projection with free rotation.
static java.lang.String T_XYZ
          Deprecated. 3D graphic displaying curves, require 3 axis.
 
Constructor Summary
DGraphic()
          Deprecated. Creates an empty graphic.
 
Method Summary
 boolean canMoves()
          Deprecated.  
static boolean CanMoves(DGraphic graphic)
          Deprecated.  
 java.lang.String getGraphicType()
          Deprecated. Alias of getRenderableId.
 float getHeightScale()
          Deprecated. Access method for the heightScale property.
 java.util.Locale getLocale()
          Deprecated. Return the locale set to the chart.
 DPropertyStore getProperties()
          Deprecated.  
 java.lang.String getRenderableId()
          Deprecated. Return graphic type identifier.
 java.lang.String getTitle()
          Deprecated. Access method for the title_ property.
 float getWidthScale()
          Deprecated. Access method for the widthScale property.
 boolean isGraphicType(java.lang.String _gt)
          Deprecated. Alias of isRenderableId
 boolean isRenderableId(java.lang.String _gt)
          Deprecated.  
 void setGraphicType(java.lang.String _gt)
          Deprecated. Alias of setRenderableId Changes graphic type.
 void setHeightScale(float aHeightScale)
          Deprecated. Sets the value of the heightScale property.
 void setProperties(DPropertyStore store)
          Deprecated. Change current property store of graphic.
 void setRenderableId(java.lang.String _gt)
          Deprecated. Changes renderable id, ie: graphic type.
 void setTitle(java.lang.String aTitle_)
          Deprecated. Sets the value of the title_ property.
 void setWidthScale(float aWidthScale)
          Deprecated. Sets the value of the widthScale property.
 
Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItemContainer
clear, getChildCount, getChildOfClass, getChildPosition, getChildrenOfClass, getFirstChild, getLastChild, insertChild, isContainer, removeChild
 
Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItem
addChild, getAppliedStyle, getIterator, getNext, getParent, getRoot, getStyle, setNext, setParent, setStyle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.tptp.platform.report.core.internal.IDItem
addChild, clear, getAppliedStyle, getChildCount, getChildPosition, getFirstChild, getIterator, getLastChild, getNext, getParent, getRoot, getStyle, insertChild, isContainer, removeChild, setNext, setParent, setStyle
 

Field Detail

properties_

protected DPropertyStore properties_
Deprecated. 
Property store


T_SECTORS

public static final java.lang.String T_SECTORS
Deprecated. 
graphic is made of flat sectors, require one axis, 1+ curve with 1+ points

See Also:
Constant Field Values

T_HISTOGRAM

public static final java.lang.String T_HISTOGRAM
Deprecated. 
graphic made of vertical bar, require one axis, several DCurve and DPoint. Each bar are rendered left to right. You can apply P_THIN_BAR or/and P_3D property on this graphic type.

See Also:
Constant Field Values

T_HISTOGRAM_IM

public static final java.lang.String T_HISTOGRAM_IM
Deprecated. 
graphic is a flat histogram using mixed values, means each point having same index from curves are rendered together. You can apply P_THIN_BAR or/and P_3D property on this graphic type.

See Also:
Constant Field Values

T_H_HISTOGRAM_IM

public static final java.lang.String T_H_HISTOGRAM_IM
Deprecated. 
graphic is a flat histogram using mixed values, means each point having same index from curves are rendered together. The Y axis is horizontal You can apply P_THIN_BAR or/and P_3D property on this graphic type.

See Also:
Constant Field Values

T_HISTORS

public static final java.lang.String T_HISTORS
Deprecated. 
graphic is made of fixed angle sectors but ray depends on points values

See Also:
Constant Field Values

T_XY

public static final java.lang.String T_XY
Deprecated. 
default values for graphic_type_ 2D plan, required two axis support curve type LINE,BAR,POINTS. Note on T_BAR curve type: as it's a XY graphic, x coordinate is used as a width of the bar, and y as the height. first bar of curve start on the left of graphic, and other take place left to right. This graphic type requier two axis named "x" and "y", a third one named "y2" can be used for a secondary Y axis rendered on the right side of the graphic.

See Also:
Constant Field Values

T_XYZ

public static final java.lang.String T_XYZ
Deprecated. 
3D graphic displaying curves, require 3 axis. Those graphics can use number, dates, ... and scales. If your graphics contains several data, this is a good idea to set P_MIN and P_MAX property for each axis, this will save time.

See Also:
Constant Field Values

T_WIREFRAME

public static final java.lang.String T_WIREFRAME
Deprecated. 
3D graphic displaying a surface, require 3 axis, 2+ curves with same number of points .

See Also:
T_XYZ, Constant Field Values

T_SECTORS3D

public static final java.lang.String T_SECTORS3D
Deprecated. 
graphic is made of sectors displayed as simulated 3D elevation (see T_SECTORS)

See Also:
Constant Field Values

T_HBARS

public static final java.lang.String T_HBARS
Deprecated. 
graphic made of horizontal bars, this graphic type contains four kind of graphics:
  • simple histogram bars: use une DAxis, several DCurve and DPoint with one DCoord by point
  • one chart begin-end bars: use one DAxis, several DCurve/DPoint, by set two DCoord by points
  • two horizontal bars: same as simple horizontal bars, but use two DAxis (one by chart).
  • two chart begin-end: same as one chart begin-end but use two DAxis (one by chart). Property P_THIN_BAR can be applied to this graphic type.

    See Also:
    Constant Field Values

  • T_STACKBARS

    public static final java.lang.String T_STACKBARS
    Deprecated. 
    Graphic made of vertical stacked bars. Each DPoint found at same index of DCurve are rendered on above other. You can apply P_THIN_BAR and/or P_3D property to this graphic type. Because render have to summarize values of point, this graphic type must have a DAxis that useNumbers() return true.

    See Also:
    Constant Field Values

    T_H_STACKBARS

    public static final java.lang.String T_H_STACKBARS
    Deprecated. 
    Graphic made of vertical stacked bars. Each DPoint found at same index of DCurve are rendered on above other. Y axis is horizontal You can apply P_THIN_BAR and/or P_3D property to this graphic type. Because render have to summarize values of point, this graphic type must have a DAxis that useNumbers() return true.

    See Also:
    Constant Field Values

    T_METER

    public static final java.lang.String T_METER
    Deprecated. 
    Graphic showing a Meter. One axis is required, if min/max not set, defaults are 0..100 for axis using numbers. The first curve defined needles, first point of this curve is the main needle which value is displayed in the Meter, others point define extra-needle (you can set different foreground color of those point's style to visually differenciate them). First point of other curves are used to configure filled region under the needle (ie if you want to display green,yellow,red color for examples, ...). Remember: by default legend is displayed, personnaly I prefer to not display legend for Meter graphics, if you too, set P_SHOW_LEGEND property to false.

    See Also:
    Constant Field Values

    T_SERIES3D

    public static final java.lang.String T_SERIES3D
    Deprecated. 
    Graphic made of real 3D bars, 3D lines (ribbon), others. Choose point of view using P_PHI and P_THETA properties. See DCurve.T_xxx curve type for supported curves types (ir T_BAR, T_LINE,T_POINTS,...) You can use P_THIN_BAR property to display thin bar or thin curve instead of side-by-side bars.

    See Also:
    Constant Field Values

    T_PIE3D

    public static final java.lang.String T_PIE3D
    Deprecated. 
    Graphic is a Pie chart using 3D projection, with free rotation. Follow the definition of T_SECTORS for DCurve and DPoint definition.

    See Also:
    Constant Field Values

    T_TORUS3D

    public static final java.lang.String T_TORUS3D
    Deprecated. 
    Graphic is a 3D Torus, with free rotation (similar to T_PIE3D but using a torus as volume). Follow the definition of T_SECTORS for DCurve and DPoint definition.

    See Also:
    Constant Field Values

    T_XY_SURFACE

    public static final java.lang.String T_XY_SURFACE
    Deprecated. 
    Graphic is a XY Surface with Z raising, rendered using 3D projection with free rotation. This graphic need at least one IXYSurface object as children of DGraphic, and not the usual DCurve/DPoint/IDCoord trio. Pleas note this graphic doesn't use any accelerated video card or smart mode, that why Surface should have reasonnable size to be rendered correctly (depending on platform used). (you can use DXYSurface implementation or define your own one). A Z axis (DAxis with "z" name) can be set as child of DGraphic to render Z values, but this is optional. The following properties are supported: P_3D_HEIGHT, P_XYS_COLORIZER, P_XYS_LINE_X, P_XYS_LINE_Y, P_XYZ_PHI, P_YZ_THETA, P_3D_SHADOW, P_3D_LIGHT, P_XYS_COUNTOUR_LINE, P_XYS_CONTOUR_LINE_COLOR

    See Also:
    Constant Field Values

    P_SHOW_LEGEND

    public static final java.lang.String P_SHOW_LEGEND
    Deprecated. 
    property key, hold a Boolean value false to not display legend (otherwise the legend is displayed)

    See Also:
    Constant Field Values

    P_SHOW_TITLE

    public static final java.lang.String P_SHOW_TITLE
    Deprecated. 
    property key, hold a Boolean value false to not display graphic title (otherwise the title is displayed)

    See Also:
    Constant Field Values

    P_XYZ_PHI

    public static final java.lang.String P_XYZ_PHI
    Deprecated. 
    property key for 'phi' (angle view for XYZ graphs), Float class if exists

    See Also:
    Constant Field Values

    P_XYZ_THETA

    public static final java.lang.String P_XYZ_THETA
    Deprecated. 
    property key for 'theta' (angle view for XYZ graphs), Float class if exists

    See Also:
    Constant Field Values

    P_XYZ_XPROJ

    public static final java.lang.String P_XYZ_XPROJ
    Deprecated. 
    property to force projection status on X axis, Boolean (default: true)

    See Also:
    Constant Field Values

    P_XYZ_YPROJ

    public static final java.lang.String P_XYZ_YPROJ
    Deprecated. 
    property to force projection status on Y axis, Boolean (default: true)

    See Also:
    Constant Field Values

    P_XYZ_ZPROJ

    public static final java.lang.String P_XYZ_ZPROJ
    Deprecated. 
    property to force projection status on Z axis, Boolean (default: true)

    See Also:
    Constant Field Values

    P_MAX_HEIGHT

    public static final java.lang.String P_MAX_HEIGHT
    Deprecated. 
    property to constraint the maximum height of graphic in pixel... (default none)

    See Also:
    Constant Field Values

    P_MIN_HEIGHT

    public static final java.lang.String P_MIN_HEIGHT
    Deprecated. 
    property to constraint the minimum height of graphic in pixel... (default none)

    See Also:
    Constant Field Values

    P_MAX_WIDTH

    public static final java.lang.String P_MAX_WIDTH
    Deprecated. 
    property to constraint the maximum width of graphic in pixel... (default none)

    See Also:
    Constant Field Values

    P_MIN_WIDTH

    public static final java.lang.String P_MIN_WIDTH
    Deprecated. 
    property to constraint the minimum width of graphic in pixel... (default none)

    See Also:
    Constant Field Values

    P_WIDTH_SCALE

    public static final java.lang.String P_WIDTH_SCALE
    Deprecated. 
    property to set a scale on the width of the graphic, scale is in 0..1, default is 1

    See Also:
    Constant Field Values

    P_BACKCOLOR

    public static final java.lang.String P_BACKCOLOR
    Deprecated. 
    string property to set a color for the background. null by default.

    See Also:
    Constant Field Values

    P_HEIGHT_SCALE

    public static final java.lang.String P_HEIGHT_SCALE
    Deprecated. 
    property to set a scale on the height of the graphic, scale is in 0..1, default is 1

    See Also:
    Constant Field Values

    P_THIN_BAR

    public static final java.lang.String P_THIN_BAR
    Deprecated. 
    boolean property to set thin bar, or connected bar. Currently this property can be applyed to T_HISTOGRAM, T_HBARS and T_STACKBARS.

    See Also:
    Constant Field Values

    P_3D

    public static final java.lang.String P_3D
    Deprecated. 
    boolean property to set "3D" effect on graphics (ie 3D bar in histograms). Currently this property can be applyed to T_HISTOGRAM, and T_STACKBARS.

    See Also:
    Constant Field Values

    P_ID

    public static final java.lang.String P_ID
    Deprecated. 
    property key for a string value which defines the chart id. Only activated for the SVG generation.

    See Also:
    Constant Field Values

    P_TITLE_LAYOUT

    public static final java.lang.String P_TITLE_LAYOUT
    Deprecated. 
    property key for a DAlignmentPair object controlling the layout and alignment of graphic title. Primary alignment is the title layout and rotation or vertical style, secondary is the alignment of the text. Default Alignement is (TOP,HCENTER) Example: DAlignmentPair(IDAlignment.LEFT|IDAlignment.ROTCCW90,IDAlignment.BOTTOM) for a title on left, rotated to 90 counter clockwise, and at the bottom.

    See Also:
    Constant Field Values

    P_TITLE_TOOLTIP

    public static final java.lang.String P_TITLE_TOOLTIP
    Deprecated. 
    property key for a string which defines the tooltip of the title Only activated for the SVG generation.

    See Also:
    Constant Field Values

    P_TITLE_BACKCOLOR

    public static final java.lang.String P_TITLE_BACKCOLOR
    Deprecated. 
    property key for an IDColor which defines the background color of the title Only activated for the SVG generation.

    See Also:
    Constant Field Values

    P_TITLE_WITH_SEPARATOR

    public static final java.lang.String P_TITLE_WITH_SEPARATOR
    Deprecated. 
    property key for a string which defines the separator Only activated for the SVG generation.

    See Also:
    Constant Field Values

    P_TITLE_EVENT_LIST

    public static final java.lang.String P_TITLE_EVENT_LIST
    Deprecated. 
    property key for a List of DEvent object which defines the interaction on the chart title. Only activated for the SVG generation.

    See Also:
    DEvent, Constant Field Values

    P_TITLE_ACC_TITLE

    public static final java.lang.String P_TITLE_ACC_TITLE
    Deprecated. 
    property key for a string which defines accessibility title required by the screen reader. Only activated for the SVG generation.

    See Also:
    Constant Field Values

    P_TITLE_ACC_DESC

    public static final java.lang.String P_TITLE_ACC_DESC
    Deprecated. 
    property key for a string which defines title description required by the screen reader. Only activated for the SVG generation.

    See Also:
    Constant Field Values

    P_LEGEND_LAYOUT

    public static final java.lang.String P_LEGEND_LAYOUT
    Deprecated. 
    property key for a DAlignmentPair object controlling the layout and alignment of graphic legend. Vertical, or rotated alignment are not used. Default alignement if (RIGHT,VCENTER)

    See Also:
    P_SHOW_LEGEND, Constant Field Values

    P_LEGEND_LIMIT

    public static final java.lang.String P_LEGEND_LIMIT
    Deprecated. 
    property key for a integer defining the maximum space the legend can graphically take. If legend has a LEFT/RIGHT layout, the limit is the width of graphic divided by P_LEGEND_LIMIT (default is 4). If legend has a TOP/BOTTOM layout, the limit is the height of graphic divided by P_LEGEND_LIMIT (default is 8). P_LEGEND_LIMIT must be an integer grater than 1.

    See Also:
    Constant Field Values

    P_LEGEND_WIDTH

    public static final java.lang.String P_LEGEND_WIDTH
    Deprecated. 
    property key for a integer defining the width of the legend can graphically take. The size is defined in pixel. By default the value is 100. Only activated on SVG generation.

    See Also:
    Constant Field Values

    P_LEGEND_LOCATION

    public static final java.lang.String P_LEGEND_LOCATION
    Deprecated. 
    property key for a string object which defines the legend location. Only activated for the SVG generation.

    See Also:
    Constant Field Values

    P_LEGEND_HEIGHT

    public static final java.lang.String P_LEGEND_HEIGHT
    Deprecated. 
    property key for a integer defining the height of the legend can graphically take. The size is defined in pixel. By default the value is 100. Only activated on SVG generation.

    See Also:
    Constant Field Values

    P_LEGEND_LABEL

    public static final java.lang.String P_LEGEND_LABEL
    Deprecated. 
    property key for a string which defines the label for the legend. Only activated on SVG generation.

    See Also:
    Constant Field Values

    P_LEGEND_TOOLTIP

    public static final java.lang.String P_LEGEND_TOOLTIP
    Deprecated. 
    property key for a string which defines the tooltip for the legend. Only activated on SVG generation.

    See Also:
    Constant Field Values

    P_LEGEND_BACKCOLOR

    public static final java.lang.String P_LEGEND_BACKCOLOR
    Deprecated. 
    property key for an IDColor which defines the background color for the legend. Only activated on SVG generation.

    See Also:
    Constant Field Values

    P_LEGEND_EVENT_LIST

    public static final java.lang.String P_LEGEND_EVENT_LIST
    Deprecated. 
    property key for a List of DEvent object which defines the interactions on the chart legend. Only activated for the SVG generation.

    See Also:
    DEvent, Constant Field Values

    P_LEGEND_ACC_TITLE

    public static final java.lang.String P_LEGEND_ACC_TITLE
    Deprecated. 
    property key for a string object which defines the legend title required by the screen reader. Only activated for the SVG generation.

    See Also:
    Constant Field Values

    P_LEGEND_ACC_DESC

    public static final java.lang.String P_LEGEND_ACC_DESC
    Deprecated. 
    property key for a string object which defines the legend description required by the screen reader. Only activated for the SVG generation.

    See Also:
    Constant Field Values

    P_LEGEND_ID

    public static final java.lang.String P_LEGEND_ID
    Deprecated. 
    property key for a string object which defines the legend id. Only activated for the SVG generation.

    See Also:
    Constant Field Values

    P_BACK_AREA

    public static final java.lang.String P_BACK_AREA
    Deprecated. 
    If property is set (true), the filled area of T_STACKED_AREA and T_AREA curves are drawn below the axis lines, otherwise filled area are drawn above axis lines (and can hidde them).

    See Also:
    Constant Field Values

    P_SHOW_VALUES

    public static final java.lang.String P_SHOW_VALUES
    Deprecated. 
    property key for T_SECTORS(3D) graphic for a boolean driving the display or not of values (and labels). Default value is true.

    See Also:
    Constant Field Values

    P_SHOW_PERCENTAGE

    public static final java.lang.String P_SHOW_PERCENTAGE
    Deprecated. 
    property key for string value which defines if the value is displayed as a percentage. Default value is true. Only activated for the SVG generation

    See Also:
    Constant Field Values

    P_VALUE_FORMAT

    public static final java.lang.String P_VALUE_FORMAT
    Deprecated. 
    property key for a string value which defines the value format displayed in the chart. Only activated for the SVG Generation

    See Also:
    Constant Field Values

    P_SHOW_BORDER

    public static final java.lang.String P_SHOW_BORDER
    Deprecated. 
    property key for the a boolean which the chart displays or not the border. Default value is true. Only activated for SVG generatin

    See Also:
    Constant Field Values

    P_SHOW_PLOTAREA_BORDER

    public static final java.lang.String P_SHOW_PLOTAREA_BORDER
    Deprecated. 
    property key for the a boolean which the chart displays or not the border. Default value is true. Only activated for SVG generatin

    See Also:
    Constant Field Values

    P_PLOTAREA_BACKCOLOR

    public static final java.lang.String P_PLOTAREA_BACKCOLOR
    Deprecated. 
    property key for an IDColor which is the background color of the plot area. Default value is null. Only activated for SVG generatin

    See Also:
    Constant Field Values

    P_MARGIN

    public static final java.lang.String P_MARGIN
    Deprecated. 
    property key for a positive integer to change margin used by default chart render. By default 10 pixels is used (converted to used device if not a Display).

    See Also:
    Constant Field Values

    P_3D_HEIGHT

    public static final java.lang.String P_3D_HEIGHT
    Deprecated. 
    property key for a positive number to change height (DEF_3D_HEIGHT by default). This property apply on T_PIE3D graphic type.
    Note: default value is 1.0 is this property is used in a T_XY_SURFACE graphic type.

    See Also:
    Constant Field Values

    DEF_3D_HEIGHT

    public static final double DEF_3D_HEIGHT
    Deprecated. 
    default value for P_3D_HEIGHT property

    See Also:
    Constant Field Values

    P_3D_SHADOW

    public static final java.lang.String P_3D_SHADOW
    Deprecated. 
    property key for a float(double) number to change 3D graphic's shadow strength. 0 means no shadow, 1 means shadow is Black, default value is DEF_3D_SHADOW. This property apply on T_PIE3D, T_TORUS3D, T_SERIES3D graphic type.

    See Also:
    Constant Field Values

    DEF_3D_SHADOW

    public static final float DEF_3D_SHADOW
    Deprecated. 
    default value for P_3D_SHADOW property

    See Also:
    Constant Field Values

    P_3D_LIGHT

    public static final java.lang.String P_3D_LIGHT
    Deprecated. 
    property key for a float(double) number to change 3D graphic's light strength (close to specular light effect) 0 means no light, 1 means light is White, default value is DEF_3D_LIGHT. This property apply on T_PIE3D, T_TORUS3D, T_SERIES3D graphic type.

    See Also:
    Constant Field Values

    DEF_3D_LIGHT

    public static final float DEF_3D_LIGHT
    Deprecated. 
    default value for P_3D_LIGHT property

    See Also:
    Constant Field Values

    P_XYS_COLORIZER

    public static final java.lang.String P_XYS_COLORIZER
    Deprecated. 
    property key for an instance of IXYSurfaceColorizer class, used by T_XY_SURFACE graphic type to get surface colors. A colorizer is provider by default.

    See Also:
    IXYSurfaceColorizer, Constant Field Values

    P_XYS_LINE_X

    public static final java.lang.String P_XYS_LINE_X
    Deprecated. 
    property key for an integer (N) used by T_XY_SURFACE graphic type to render line every N face of surfaces along X axis, 0 for none. Default is 0. This property apply to T_XY_SURFACE graphic type.

    See Also:
    Constant Field Values

    P_XYS_LINE_Y

    public static final java.lang.String P_XYS_LINE_Y
    Deprecated. 
    property key for an integer (N) used by T_XY_SURFACE graphic type to render line every N face of surfaces along Y axis, 0 for none. Default is 0. This property apply to T_XY_SURFACE graphic type.

    See Also:
    Constant Field Values

    P_XYS_CONTOUR_LINE

    public static final java.lang.String P_XYS_CONTOUR_LINE
    Deprecated. 
    property key to draw contour line on T_XY_SURFACE graphic type. This property can have several values:
    - String defined by DAxis.P_STEP_LINE to use same value of this property set in "z" axis of graphic. If no "z" axis is defined,no contour line are drawn.
    - float/double value defining delta between two consecutive contour line. This delta comes from "z" axis if this axis exists, otherwise delta must have value between 0 a 1.
    - otherwise no contour line are drawn.
    Property P_XYZ_ZPROJ can be set to true in addition to this one to draw contour line on top/bottom of 3D box (depending on point of view). In this case default value of P_XYZ_ZPROJ is false.
    This property applies to T_XY_SURFACE graphic type.

    See Also:
    Constant Field Values

    P_XYS_CONTOUR_LINE_COLOR

    public static final java.lang.String P_XYS_CONTOUR_LINE_COLOR
    Deprecated. 
    property key to define color of contour line drawn by T_XY_SURFACE graphic type. The object stored can be:
    - an integer to defining RGBA color for all lines.
    - an instance of IXYSurfaceColorizer to colorize lines with different colors (gradient)
    . - an instance of IDColor.
    - otherwise default color is RGBA.BLACK.
    This property applies to T_XY_SURFACE graphic type.

    See Also:
    Constant Field Values

    P_XYS_NO_POLYGON

    public static final java.lang.String P_XYS_NO_POLYGON
    Deprecated. 
    property key to avoid filling of polygon in a T_XY_SURFACE. This property is a boolean, with default value is "false" (polygon are filled). This property should be used when P_XYS_CONTOUR_LINE engaged.
    This property applies to T_XY_SURFACE graphic type.

    See Also:
    Constant Field Values

    P_VERSION

    public static final java.lang.String P_VERSION
    Deprecated. 
    property key for a string which represents the format version. Only activated for the SVG generation.

    See Also:
    Constant Field Values
    Constructor Detail

    DGraphic

    public DGraphic()
    Deprecated. 
    Creates an empty graphic.

    Method Detail

    getWidthScale

    public float getWidthScale()
    Deprecated. 
    Access method for the widthScale property.

    Specified by:
    getWidthScale in interface IDSizeableItem
    Returns:
    the current value of the widthScale property

    setWidthScale

    public void setWidthScale(float aWidthScale)
    Deprecated. 
    Sets the value of the widthScale property.

    Specified by:
    setWidthScale in interface IDSizeableItem
    Parameters:
    aWidthScale - the new value of the widthScale property

    getHeightScale

    public float getHeightScale()
    Deprecated. 
    Access method for the heightScale property.

    Specified by:
    getHeightScale in interface IDSizeableItem
    Returns:
    the current value of the heightScale property

    setHeightScale

    public void setHeightScale(float aHeightScale)
    Deprecated. 
    Sets the value of the heightScale property.

    Specified by:
    setHeightScale in interface IDSizeableItem
    Parameters:
    aHeightScale - the new value of the heightScale property

    getTitle

    public java.lang.String getTitle()
    Deprecated. 
    Access method for the title_ property.

    Returns:
    the current value of the title_ property

    setTitle

    public void setTitle(java.lang.String aTitle_)
    Deprecated. 
    Sets the value of the title_ property.

    Parameters:
    aTitle_ - the new value of the title_ property

    getGraphicType

    public final java.lang.String getGraphicType()
    Deprecated. 
    Alias of getRenderableId. Return graphic type identifier.

    Returns:
    graphic type.

    setGraphicType

    public final void setGraphicType(java.lang.String _gt)
    Deprecated. 
    Alias of setRenderableId Changes graphic type.


    getRenderableId

    public java.lang.String getRenderableId()
    Deprecated. 
    Return graphic type identifier.

    Specified by:
    getRenderableId in interface IDRenderable
    Returns:
    graphic type.

    setRenderableId

    public void setRenderableId(java.lang.String _gt)
    Deprecated. 
    Changes renderable id, ie: graphic type.


    isGraphicType

    public final boolean isGraphicType(java.lang.String _gt)
    Deprecated. 
    Alias of isRenderableId

    Returns:
    true is graphic type is equals to given one.

    isRenderableId

    public boolean isRenderableId(java.lang.String _gt)
    Deprecated. 
    Returns:
    true is graphic type is equals to given one.

    getProperties

    public DPropertyStore getProperties()
    Deprecated. 
    Returns:
    property store associated with the graphic

    setProperties

    public void setProperties(DPropertyStore store)
    Deprecated. 
    Change current property store of graphic.

    Parameters:
    store - the new property store.

    canMoves

    public boolean canMoves()
    Deprecated. 
    Returns:
    true if current graphic type can be moved using P_XYZ_PHI and P_XYZ_THETA properties.

    CanMoves

    public static boolean CanMoves(DGraphic graphic)
    Deprecated. 
    Returns:
    true if given graphic type can be moved using P_XYZ_PHI and P_XYZ_THETA properties.

    getLocale

    public java.util.Locale getLocale()
    Deprecated. 
    Return the locale set to the chart. Searches the DI18N child node and return the locale. Return the default locale if no DI18N child is found

    Returns:
    Locale

    TPTP 4.5.0 Platform Project
    Internal API Specification