ChartDirector 7.0 (PHP Edition)

JsChartViewer.showTextBox


Usage

showTextBox(id, x, y, align, text [, boxStyle ])

Description

Draws a textbox on the chart.

The textbox will be drawn as an HTML element overlaid on top of the chart. The id argument is an identifier to reference the element in other methods, such as in JsChartViewer.hideObj to hide the element. The identifier should begin with an english alphabet, and consists only of characters A-Z, a-z, 0-9, '-' and '_'.

Arguments

ArgumentDefaultDescription
id(Mandatory)The identifier of the textbox.
x(Mandatory)The x pixel coordinate of the reference point of the textbox, relative to the chart.
y(Mandatory)The y pixel coordinate of the reference point of the textbox, relative to the chart.
align(Mandatory)The alignment of the textbox relative to the reference point. It must be one of JsChartViewer.TopLeft, JsChartViewer.TopCenter, JsChartViewer.TopRight, JsChartViewer.Left, JsChartViewer.Center, JsChartViewer.Right, JsChartViewer.BottomLeft, JsChartViewer.BottomCenter or JsChartViewer.BottomRight. It specifies the point of the textbox that should be the reference point. For example, if TopLeft is used, it means the textbox should be positioned such that the top-left of the text box is at the reference point.
text(Mandatory)The text to be displayed.
boxStyle""The box style in the same format used in the HTML "style" attribute. An example is "border:solid 1px black;background:#ffffcc;padding:3px;font:bold 11px Arial;".

Return Value

A DOM element representing the textbox.