|
The NetCharts Server Cold Fusion Tag library includes the following tags.
CF_NCCACHEID
Creates a unique string suitable for use as a cacheID key. CF_NCCACHEID is
primarily intended to create cache ID strings that can by CF_NCDATACACHE
to put data into a NetCharts Server data cache.
<CF_NCCACHEID OUTPUT = "cacheID_variable_name"
>
OUTPUT
Required. The name of a variable to store the cacheID.
CF_NCCHART
Adds a chart to a page. CF_NCCHART tags may contain CF_NCCHARTDATA and CF_NCVARIABLE tags as necessary.
<CF_NCCHART SERVER = "server_host_name"
PORT = "server_port"
USER = "server_userID"
PASSWORD = "server_password"
PROJECT = "server_project"
FULLPAGE = "true/false"
CHART = "chart_template_name"
TYPE = "return type"
DRILLDOWN = "true/false"
QUERY = "query_name"
DEFAULTHREF = "default_href_url"
ACCESSIBILITYMODE = "true/false"
AMACTIVELABELTEXTTEMPLATE = "template_name"
AMCHARTDESCRIPTION = "chart_description_string">
>
SERVER
Required if not within a CF_NCSESSION. Server host name, overrides value
set in enclosing CF_NCSESSION.
PORT
Required if not within a CF_NCSESSION. Server port, overrides value set
in enclosing CF_NCSESSION.
USER
Optional. Server user ID, overrides value set in enclosing CF_NCSESSION.
PASSWORD
Optional. Server password, overrides value set in enclosing CF_NCSESSION.
PROJECT
Required if not within a CF_NCSESSION. Server project, overrides value set in enclosing CF_NCSESSION.
FULLPAGE
Optional. Inserts javascript that implements roll-over labels. This code
needs to be inserted only once per HTML page. Default value is true.
CHART
Required. Name of chart template to use.
TYPE
Optional. Type of output, PNG, JPG, TIFF, BMP, SVG, SWF and PDF. Default
value is PNG.
DRILLDOWN
Optional. Generates and includes HTML MAP tag for chart. Default value
is true.
QUERY
Optional. CFQUERY object with which to populate chart.
DEFAULTHREF
Optional. URL to use for drilldown for drillable elements in a chart that do not
have an explicit URL defined.
ACCESSIBILITYMODE
Optional. Used to control creation of US Government Section 508 compliant
chart images. If true, NetCharts Server creates images and image maps with
ALT and TITLE tags that make them accessible in non-graphical environments. Default is false.
AMACTIVELABELTEXTTEMPLATE
Optional. Used when ACCESSIBILITYMODE=true. The ActiveLabelTextTemplate
String defines the text to be used in html image map AREA tags for
ALT and TITLE attributes. The template can optionally contain the
following variables that NetChartsServer will replace at creation
time.
| @label@ | The value of the data point represented by this area tag |
| @index@ | The index of the data point represented by this area tag |
| @param@ | The name of the chart element represented by this area tag |
| @href@ | The URL that will be visited when mouse is clicked on this area tag |
| @target@ |
The window that will receive the URL that is visited when
the mouse is clicked on this area tag |
AMCHARTDESCRIPTION
Optional. Used when ACCESSIBILITYMODE=true. The chart description text
is used as the value for the ALT and TITLE attributes on the chart
image tag. If unspecified, the ALT and TITLE attributes will be generated
from data in the Chart Templates MetaData attribute named ChartDescription.
If there is no MetaData attribute named ChartDescription defined,
simple text for the ALT and TITLE attributes will be autogenerated
by NetCharts Server.
CF_NCCHARTDATA
Maps rows and columns from a CFQUERY result set into a chart template. This
tag can only appear inside a CF_NCCHART tag.
<CF_NCCHARTDATA TYPE = "chart_attribute_type"
ROWS = "rows"
COLUMNS = "columns"
ROWMAJOR = "true/false"
>
TYPE
Required. The type of chart parameter to which this instance of CF_NCCHARTDATA refers. The legal values
for TYPE depend on the type of chart specified by CHART in the enclosing CF_NCCHART tag.
| Chart Style |
Legal values for TYPE |
| Bar Chart |
legend,bars,bar labels |
| Box Chart |
legend,popup labels,data |
| Bubble Chart |
legend,popup labels,bubbles,bubble scale |
| Combo Chart |
legend,bars,lines,labels |
| Line Chart |
legend,lines, line labels |
| Pie Chart |
legend,slices, slice labels |
| Radar Chart |
legend, data sets, axes config |
| Stock Chart |
legend,bars,lines,labels, stock data |
| Time Chart |
legend,tasks, task labels |
| XY Chart |
legend,popup labels, x-y data |
ROWS
The rows from the result set from which to extract data. Examples of legal
syntax include 3* (rows three and greater) 0,1,3 (rows 0,1 and 3), and
1-4,7,9* (rows 1-4, 7 and all rows 9 and greater). rows=COLUMNNAMES allows
the column names from a result set to be used as a row of data.
COLUMNS
The columns from the result set from which to extract data. Examples of
legal syntax include 0* (all columns) 0,1,3 (columns 0,1 and 3),
and 1-4,7,9* (columns 1-4, 7 and all columns 9 and greater).
ROWMAJOR
Optional. Specifies the order from which to extract data from the result set.
Default is true.
CF_NCDATACACHE
Adds, retrieves or removes data from a NetCharts Server data cache. Data added to the NetCharts Server data
cache can be used to populate charts and tables via the CF_NCCHART and CF_NCTABLE tags. Data retrieved from
the NetCharts Server data cache can be used to populate other elements of a page with the same data that appears
in a chart. Any data put in the cache by a call to NCDATACACHE should be explicitly removed by another call to
NCDATACACHE when no longer needed.
<CF_NCDATACACHE SERVER = "server_host_name"
PORT = "server_port"
USER = "server_userID"
PASSWORD = "server_password"
ACTION = "get|getncxml|put|remove"
CACHEID = "cache_id"
CACHELIFESPAN = "cache_life_span"
INCLUDEHEADERS = "true|false"
NCXML = "ncxml_variable_name"
QUERY = "query_name"
OUTPUT = "output_variable_name"
>
SERVER
Required if not within a CF_NCSESSION. Server host name, overrides value
set in enclosing CF_NCSESSION.
PORT
Required if not within a CF_NCSESSION. Server port, overrides value set
in enclosing CF_NCSESSION.
USER
Optional. Server user ID, overrides value set in enclosing CF_NCSESSION.
PASSWORD
Optional. Server password, overrides value set in enclosing CF_NCSESSION.
ACTION
Optional. Specifies the operation to be performed on the NetCharts Server data cache. Legal values
are GET, GETNCXML, PUT and REMOVE. PUT places
data in the cache, GET retrieves data from the cache as a QUERY object, GETNCXML
retrieves data from the cache as an XML document, REMOVE removes data from the cache.
CACHEID
Required. A String used as an ID tag by the NetCharts Server to reference a particular set of data. The NC_CACHEID
tag can be used to produce unique values for this attribute.
CACHELIFESPAN
Optional. The time in milliseconds that the server should consider the cached data to be valid.
The default value is 3600.
INCLUDEHEADERS
Optional. When ACTION=PUT, specifies that the column headers in the QUERY should be used as the first
row of data put into the data cache. When ACTION=GET, specifies that the first row of data in the data cache
will be used to create the column headers in the QUERY or NCXML data returned. The default value is false.
QUERY
Required when ACTION=GET. Specifies the name of the QUERY object to be populated with data from the data cache.
When ACTION=PUT, QUERY, if set, will be used as the source of the data to be placed in the cache.
NCXML
Optional. If specified, and QUERY is unspecified and ACTION=PUT, specifies an NCXML document containing the
data to be added to the data cache.
OUTPUT
Required when ACTION=GET,GETNCXML. Specifies the variable to store data
retrieved from the cache.
CF_NCNDSDATA
Instructs NetCharts Server to execute the specified Named Data Set and return the results
as either a QUERY object, an NCXML document or a character delimited string.
<CF_NCNDSDATA SERVER = "server_host_name"
PORT = "server_port"
USER = "server_userID"
PASSWORD = "server_password"
PROJECT = "server_project"
ACTION = "get|getncxml|getcsv"
NDS = "nds_name"
INCLUDEHEADERS = "true|false"
DELIMITER = "delimiter_character"
OUTPUT = "output_variable_name"
>
SERVER
Required if not within a CF_NCSESSION. Server host name, overrides value
set in enclosing CF_NCSESSION.
PORT
Required if not within a CF_NCSESSION. Server port, overrides value set
in enclosing CF_NCSESSION.
USER
Optional. Server user ID, overrides value set in enclosing CF_NCSESSION.
PASSWORD
Optional. Server password, overrides value set in enclosing CF_NCSESSION.
PROJECT
Required if not within a CF_NCSESSION. Server project, overrides value set in enclosing CF_NCSESSION.
ACTION
Optional. Specifies the format for the data to be returned as a result
of executing the NDS file. Legal values are GET, GETNCXML, and GETCSV.
NDS
Required. The name of the NDS file on the NetCharts Server to execute.
INCLUDEHEADERS
Optional. Specifies that the first row of data in the data cache
will be used to create the column headers in the data returned. The default value is false.
DELIMITER
Optional. Specifies the character to use as the delimiter between fields when ACTION=GETCSV.
The default value is ",".
OUTPUT
Required. Specifies the variable to store data retrieved as a result of
executing the NDS file.
CF_NCTABLE
Adds a table to a page. CF_NCCHART tags may contain CF_NCTABLEDATA and CF_NCVARIABLE tags as necessary.
<CF_NCTABLE SERVER = "server_host_name"
PORT = "server_port"
USER = "server_userID"
PASSWORD = "server_password"
PROJECT = "server_project"
TABLE = "table_template_name"
QUERY = "query_name"
>
SERVER
Required if not within a CF_NCSESSION. Server host name, overrides value
set in enclosing CF_NCSESSION.
PORT
Required if not within a CF_NCSESSION. Server port, overrides value set
in enclosing CF_NCSESSION.
USER
Optional. Server user ID, overrides value set in enclosing CF_NCSESSION.
PASSWORD
Optional. Server password, overrides value set in enclosing CF_NCSESSION.
PROJECT
Required if not within a CF_NCSESSION. Server project, overrides value
set in enclosing CF_NCSESSION.
TABLE
Required. Name of table template to use.
QUERY
Optional. CFQUERY object with which to populate table.
CF_NCTABLEDATA
Maps rows and columns from a CFQUERY result set into a table template. This
tag must can only appear inside a CF_NCTABLE tag.
<CF_NCTABLEDATA ROWS = "rows"
COLUMNS = "columns"
>
ROWS
The rows from the result set from which to extract data. Examples of legal
syntax include 3* (rows three and greater) 0,1,3 (rows 0,1 and 3), and
1-4,7,9* (rows 1-4, 7 and all rows 9 and greater). rows=COLUMNNAMES allows
the column names from a result set to be used as a row of data.
COLUMNS
The columns from the result set from which to extract data. Examples of
legal syntax include 0* (all columns) 0,1,3 (columns 0,1 and 3),
and 1-4,7,9* (columns 1-4, 7 and all columns 9 and greater).
CF_NCSESSION
Defines a session with a NetCharts Server. All CF_NCCHART and
CF_NCTABLE tags contained in a CF_NCSESSION tag inherit the server,
project and user ID defined by the session.
<CF_NCSESSION SERVER = "server_host_name"
PORT = "server_port"
USER = "server_userID"
PASSWORD = "server_password"
PROJECT = "server_project"
QUERY = "query_name"
>
SERVER
Required. Server host name.
PORT
Required. Server port.
USER
Optional. Server user ID.
PASSWORD
Optional. Server password.
PROJECT
Required. Server project.
QUERY
Optional. CFQUERY object with which to populate enclosed charts and tables.
CF_NCCHARTSCRIPT
Inserts into the page javascript code that implements
the pop-up labels on chart images. This script will support all
CF_NCCHART tags that occur in a single page. If this tag is present
in a page, then all CF_NCCHART tags in that page should set fullpage=false.
<CF_NCCHARTSCRIPT>
CF_NCVARIABLE
Defines a variable and its value. CF_NCVARIABLE tags are
used inside CF_NCCHART and CF_NCTABLE tags to provide values
for variables that may appear in chart and table templates.
<CF_NCVARIABLE NAME = "variable_name"
VALUE = "variable_value"
>
NAME
Required. The name of a variable in the related chart or table template.
VALUE
Required. The value for the variable.
|
