net.windward.tags
Class ChartTag

net.windward.tags.BaseTag
  |
  +--net.windward.tags.ChartTag

public class ChartTag

extends BaseTag

Place a chart in the final report. The term "z axis" connotates the y axis on the right side of the chart. A chart is composed of 1..N graphs where each graph is a given type of chart with a set of data. The graph[0] is special as it sets chart-wide values. Each graph has 1..N series of data and each series (row) has 1..5 columns (the number based on the type of chart for that graph) of data.

The full list of attributes is:

• select - required - the data used to populate the chart.
• style - optional - the formatting of the chart. Standard values are "bright", "default", "iceberg", "neon", "pastel", "steel", "xp"
• layout - optional - the formatting of the chart. Standard values are "1", "2", ... with the max depending on the graph0-type value.
• width - optional - the width of the chart in twips. Twips are 1/20 of a point so there are 1440 twips in an inch. If this is not set or is 0, the the width will be the width of the paragraph the chart is in.
• height - optional - the height of the chart in twips. If the height is not set or is 0, then if the chart is in a cell it will be the height of the cell. If it is not in a cell, it will be 3/4 of the width.
• title - optional - the title of the chart.
• x-label - optional - The label for the x axis.
• y-label - optional - The label for the y axis.
• z-label - optional - The label for the z axis.
• format-* (title, label, legend, x-axis, y-axis, z-axis, background, wall, floor, plot, format-column{0}) - optional - The formatting overrides for that part of the chart.
  • bold:on|off - make text bold/regular
  • italic:on|off - make text italic/regular
  • align:left|center|right - set the text alignment
  • font:name - set the name of the font
  • font-size:12 - set the point size of the font.
  • font-color:0x123456 - set the color of the font in hex.
  • number-format:currency|integer|number|percentage|date-short|date-medium|date-long|time-short|time-medium|time-long| datetime-short|datetime-medium|datetime-long|
  • graph-gradient:solid|horizontal|vertical|centered-horizontal|centered-vertical
  • graph-color-star:0x123456 - set the start/only color of the graph in hex.
  • graph-color-end:0x123456 - set the end (if a gradient) color of the graph in hex.
  • line-width:twips - width of line in twips.
  • line-color:0x123456 - set the color of the line in hex.
  • bar-width:100 - set the width in percent (100 is default) of a bar chart column.
  • bar-spacing:100 - set the spacing in percent (100 is default) between bars in a bar chart.
  • graph{0}-type - The chart type for this graph. Values are "column", "line", "pie", "bar", "area", "scatter", "stock", "doughnut", "bubble", "radar"
  • graph{0}-series-select - The data value for each series.
  • graph{0}-rows-select - optional - The select for each row of data in the series.
  • graph{0}-data{1}-select - The data value for this column of this row.
  • graph{0}-data{1}-type - The data value for each series. Values are "category", "number", "date".
  • graph{0}-data{1}-format - optional - How to display the row-title values - NUMBER, CURRENCY, PERCENT, DATE, TIME, BOTH. For the values DATE/TIME/BOTH it can optionally be (using DATE) - DATE-SHORT, DATE-LONG, DATE-FULL. There is no DATE-MEDIUM because that is what DATE displays.
  • graph{0}-data{1}-date - required for DATE - Date graph categories - MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.

  It is an error to enter <wr:chart select='./name' spec='format.rtf'> ... </wr:chart>
  

  Version:

  4.0 May 25, 2005

  Field Summary

  static java.lang.String	DATE_RANGE_DAY
  static java.lang.String	DATE_RANGE_HOUR
  static java.lang.String	DATE_RANGE_MILLISECOND
  static java.lang.String	DATE_RANGE_MINUTE
  static java.lang.String	DATE_RANGE_MONTH
  static java.lang.String	DATE_RANGE_QUARTER
  static java.lang.String	DATE_RANGE_SECOND
  static java.lang.String	DATE_RANGE_WEEK
  static java.lang.String	DATE_RANGE_YEAR
  static java.lang.String	PROP_CHART_TITLE
  static java.lang.String	PROP_FORMAT_BACKGROUND
  static java.lang.String	PROP_FORMAT_COLUMN
  static java.lang.String	PROP_FORMAT_FLOOR
  static java.lang.String	PROP_FORMAT_GRAPH
  static java.lang.String	PROP_FORMAT_LABEL
  static java.lang.String	PROP_FORMAT_LEGEND
  static java.lang.String	PROP_FORMAT_PLOT
  static java.lang.String	PROP_FORMAT_TITLE
  static java.lang.String	PROP_FORMAT_WALL
  static java.lang.String	PROP_GRAPH_AXIS
  static java.lang.String	PROP_GRAPH_DATA_DATE
  static java.lang.String	PROP_GRAPH_DATA_FORMAT
  static java.lang.String	PROP_GRAPH_DATA_SELECT
  static java.lang.String	PROP_GRAPH_DATA_TYPE
  static java.lang.String	PROP_GRAPH_ROWS_SELECT
  static java.lang.String	PROP_GRAPH_SERIES_FORMAT
  static java.lang.String	PROP_GRAPH_SERIES_SELECT
  static java.lang.String	PROP_GRAPH_TYPE
  static java.lang.String	PROP_HEIGHT
  static java.lang.String	PROP_LAYOUT
  static java.lang.String	PROP_LAYOUT_OVERRIDE
  static java.lang.String	PROP_STYLE
  static java.lang.String	PROP_WIDTH
  static java.lang.String	PROP_X_FORMAT
  static java.lang.String	PROP_X_LABEL
  static java.lang.String	PROP_Y_FORMAT
  static java.lang.String	PROP_Y_LABEL
  static java.lang.String	PROP_Z_FORMAT
  static java.lang.String	PROP_Z_LABEL
  static java.lang.String	TYPE_CHART_AREA
  static java.lang.String	TYPE_CHART_BAR
  static java.lang.String	TYPE_CHART_BUBBLE
  static java.lang.String	TYPE_CHART_COLUMN
  static java.lang.String	TYPE_CHART_DOUGHNUT
  static java.lang.String	TYPE_CHART_LINE
  static java.lang.String	TYPE_CHART_PIE
  static java.lang.String	TYPE_CHART_RADAR
  static java.lang.String	TYPE_CHART_STOCK
  static java.lang.String	TYPE_CHART_SURFACE
  static java.lang.String	TYPE_CHART_XY
  static java.lang.String	TYPE_DATA_CATEGORY
  static java.lang.String	TYPE_DATA_DATE
  static java.lang.String	TYPE_DATA_NUMBER

  Fields inherited from class net.windward.tags.BaseTag

  CHART, COLUMN, DISPLAY_ALWAYS, DISPLAY_NOT_EMPTY, DISPLAY_NOT_NULL, ELSE, END_FOREACH, END_IF, END_LINK, END_MATRIX, ESCAPE, FOREACH, FUNCTION, HTML, IF, IMPORT, LINK, MATRIX, OUT, PROP_COMMENT, PROP_DATASOURCE, PROP_DEFAULT, PROP_DISPLAY, PROP_ENABLED, PROP_INPUT, PROP_PATTERN, PROP_TITLE, PROP_TYPE, PROP_VAR, PROP_WRAP, QUERY, ROW, SET, TAG_DISPLAY_DEFAULT, TAG_DISPLAY_SELECT, TAG_DISPLAY_TAG, TYPE_BITMAP, TYPE_BOTH, TYPE_CURRENCY, TYPE_DATE, TYPE_NUMBER, TYPE_PERCENT, TYPE_TIME, WRAP_BEHIND, WRAP_FRONT, WRAP_INLINE, WRAP_SQUARE

  Constructor Summary

  ChartTag(java.util.Map map, boolean selfContained, boolean ignoreError)
  Create a chart element using the passed in map values.

  Method Summary

  net.windward.document.Element	dup(boolean sameRefId) Makes a duplicate of this object.
  int	getXmlType() Returns which type of xml element this is.
  static java.lang.String	indexProperty(java.lang.String prop, int graph)
  static java.lang.String	indexProperty(java.lang.String prop, int graph, int data)
  java.lang.String	toDisplay(int type) How this node is displayed on the page when in a field.
  java.lang.String	toString() Returns this object as a string in the format "chart:...".
  java.lang.String	toText() Converts this node back in to it's string representation in the document

  Methods inherited from class net.windward.tags.BaseTag

  containsAttribute, factory, factory, getAttribute, getAttributes, getBean, getDatasource, getIntAttribute, getLevel, getMode, getNode, getType, setLevel, setNode, toTagText

  Field Detail

  PROP_WIDTH

  public static final java.lang.String PROP_WIDTH

  PROP_HEIGHT

  public static final java.lang.String PROP_HEIGHT

  PROP_LAYOUT

  public static final java.lang.String PROP_LAYOUT

  PROP_STYLE

  public static final java.lang.String PROP_STYLE

  PROP_LAYOUT_OVERRIDE

  public static final java.lang.String PROP_LAYOUT_OVERRIDE

  PROP_FORMAT_TITLE

  public static final java.lang.String PROP_FORMAT_TITLE

  PROP_FORMAT_LABEL

  public static final java.lang.String PROP_FORMAT_LABEL

  PROP_FORMAT_LEGEND

  public static final java.lang.String PROP_FORMAT_LEGEND

  PROP_FORMAT_BACKGROUND

  public static final java.lang.String PROP_FORMAT_BACKGROUND

  PROP_FORMAT_WALL

  public static final java.lang.String PROP_FORMAT_WALL

  PROP_FORMAT_FLOOR

  public static final java.lang.String PROP_FORMAT_FLOOR

  PROP_FORMAT_PLOT

  public static final java.lang.String PROP_FORMAT_PLOT

  PROP_FORMAT_COLUMN

  public static final java.lang.String PROP_FORMAT_COLUMN

  PROP_FORMAT_GRAPH

  public static final java.lang.String PROP_FORMAT_GRAPH

  PROP_CHART_TITLE

  public static final java.lang.String PROP_CHART_TITLE

  PROP_X_LABEL

  public static final java.lang.String PROP_X_LABEL

  PROP_Y_LABEL

  public static final java.lang.String PROP_Y_LABEL

  PROP_Z_LABEL

  public static final java.lang.String PROP_Z_LABEL

  PROP_X_FORMAT

  public static final java.lang.String PROP_X_FORMAT

  PROP_Y_FORMAT

  public static final java.lang.String PROP_Y_FORMAT

  PROP_Z_FORMAT

  public static final java.lang.String PROP_Z_FORMAT

  PROP_GRAPH_TYPE

  public static final java.lang.String PROP_GRAPH_TYPE

  PROP_GRAPH_AXIS

  public static final java.lang.String PROP_GRAPH_AXIS

  PROP_GRAPH_SERIES_SELECT

  public static final java.lang.String PROP_GRAPH_SERIES_SELECT

  PROP_GRAPH_SERIES_FORMAT

  public static final java.lang.String PROP_GRAPH_SERIES_FORMAT

  PROP_GRAPH_ROWS_SELECT

  public static final java.lang.String PROP_GRAPH_ROWS_SELECT

  PROP_GRAPH_DATA_SELECT

  public static final java.lang.String PROP_GRAPH_DATA_SELECT

  PROP_GRAPH_DATA_TYPE

  public static final java.lang.String PROP_GRAPH_DATA_TYPE

  PROP_GRAPH_DATA_FORMAT

  public static final java.lang.String PROP_GRAPH_DATA_FORMAT

  PROP_GRAPH_DATA_DATE

  public static final java.lang.String PROP_GRAPH_DATA_DATE

  TYPE_CHART_COLUMN

  public static final java.lang.String TYPE_CHART_COLUMN

  TYPE_CHART_LINE

  public static final java.lang.String TYPE_CHART_LINE

  TYPE_CHART_PIE

  public static final java.lang.String TYPE_CHART_PIE

  TYPE_CHART_BAR

  public static final java.lang.String TYPE_CHART_BAR

  TYPE_CHART_AREA

  public static final java.lang.String TYPE_CHART_AREA

  TYPE_CHART_XY

  public static final java.lang.String TYPE_CHART_XY

  TYPE_CHART_STOCK

  public static final java.lang.String TYPE_CHART_STOCK

  TYPE_CHART_SURFACE

  public static final java.lang.String TYPE_CHART_SURFACE

  TYPE_CHART_DOUGHNUT

  public static final java.lang.String TYPE_CHART_DOUGHNUT

  TYPE_CHART_BUBBLE

  public static final java.lang.String TYPE_CHART_BUBBLE

  TYPE_CHART_RADAR

  public static final java.lang.String TYPE_CHART_RADAR

  TYPE_DATA_CATEGORY

  public static final java.lang.String TYPE_DATA_CATEGORY

  TYPE_DATA_NUMBER

  public static final java.lang.String TYPE_DATA_NUMBER

  TYPE_DATA_DATE

  public static final java.lang.String TYPE_DATA_DATE

  DATE_RANGE_MILLISECOND

  public static final java.lang.String DATE_RANGE_MILLISECOND

  DATE_RANGE_SECOND

  public static final java.lang.String DATE_RANGE_SECOND

  DATE_RANGE_MINUTE

  public static final java.lang.String DATE_RANGE_MINUTE

  DATE_RANGE_HOUR

  public static final java.lang.String DATE_RANGE_HOUR

  DATE_RANGE_DAY

  public static final java.lang.String DATE_RANGE_DAY

  DATE_RANGE_WEEK

  public static final java.lang.String DATE_RANGE_WEEK

  DATE_RANGE_MONTH

  public static final java.lang.String DATE_RANGE_MONTH

  DATE_RANGE_QUARTER

  public static final java.lang.String DATE_RANGE_QUARTER

  DATE_RANGE_YEAR

  public static final java.lang.String DATE_RANGE_YEAR

  Constructor Detail

  ChartTag

  public ChartTag(java.util.Map map,
                  boolean selfContained,
                  boolean ignoreError)
           throws TagException

  Create a chart element using the passed in map values.

  Parameters:

  map - Must have a select and spec entry.

  selfContained - Must be true.

  Throws:

  TagException - thrown if illegal parameters passed in.

  Method Detail

  indexProperty

  public static java.lang.String indexProperty(java.lang.String prop,
                                               int graph)

  indexProperty

  public static java.lang.String indexProperty(java.lang.String prop,
                                               int graph,
                                               int data)

  toText

  public java.lang.String toText()
                          throws TagException

  Converts this node back in to it's string representation in the document

  Overrides:

  toText in class BaseTag

  Returns:

  <wr:escape ... /> type string.

  toDisplay

  public java.lang.String toDisplay(int type)

  How this node is displayed on the page when in a field.

  Overrides:

  toDisplay in class BaseTag

  Parameters:

  type - One of the DISPLAY_* constants

  Returns:

  title, end of select, or <cmd> type string.

  dup

  public net.windward.document.Element dup(boolean sameRefId)

  Makes a duplicate of this object. A deep clone is done so the new object shares nothing with the original object.

  Parameters:

  sameRefId -

  Returns:

  The new duplicate of this object

  getXmlType

  public int getXmlType()

  Returns which type of xml element this is.

  Overrides:

  getXmlType in class BaseTag

  Returns:

  CHART

  toString

  public java.lang.String toString()

  Returns this object as a string in the format "chart:...".

  Returns:

  A String listing this element.